From b122914b1276eed3f866fa273d8fd17afb508997 Mon Sep 17 00:00:00 2001 From: Alexandre Villeneuve Date: Tue, 4 Feb 2025 06:14:01 -0500 Subject: [PATCH 001/148] chore: convert logs.all endpoints to new fetchers (#33097) * fix(logs): fix logs api request * chore: convert logs.all endpoints to new fetchers --------- Co-authored-by: Alaister Young --- .../Settings/Logs/Logs.constants.ts | 11 --- .../studio/hooks/analytics/useLogsPreview.tsx | 95 ++++++++++++------- apps/studio/hooks/analytics/useLogsQuery.tsx | 29 +++--- apps/studio/hooks/analytics/useSingleLog.tsx | 24 +++-- 4 files changed, 93 insertions(+), 66 deletions(-) diff --git a/apps/studio/components/interfaces/Settings/Logs/Logs.constants.ts b/apps/studio/components/interfaces/Settings/Logs/Logs.constants.ts index 4a79934d899..606d3c59950 100644 --- a/apps/studio/components/interfaces/Settings/Logs/Logs.constants.ts +++ b/apps/studio/components/interfaces/Settings/Logs/Logs.constants.ts @@ -397,17 +397,6 @@ export const LOGS_SOURCE_DESCRIPTION = { [LogsTableName.PG_CRON]: 'Postgres logs from pg_cron cron jobs', } -export const genQueryParams = (params: { [k: string]: string }) => { - // remove keys which are empty strings, null, or undefined - for (const k in params) { - const v = params[k] - if (v === null || v === '' || v === undefined) { - delete params[k] - } - } - const qs = new URLSearchParams(params).toString() - return qs -} export const FILTER_OPTIONS: FilterTableSet = { // Postgres logs postgres_logs: { diff --git a/apps/studio/hooks/analytics/useLogsPreview.tsx b/apps/studio/hooks/analytics/useLogsPreview.tsx index babc968e005..97d97f94aca 100644 --- a/apps/studio/hooks/analytics/useLogsPreview.tsx +++ b/apps/studio/hooks/analytics/useLogsPreview.tsx @@ -5,7 +5,6 @@ import { Dispatch, SetStateAction, useEffect, useMemo, useRef, useState } from ' import { LogsTableName, PREVIEWER_DATEPICKER_HELPERS, - genQueryParams, getDefaultHelper, } from 'components/interfaces/Settings/Logs/Logs.constants' import type { @@ -22,11 +21,10 @@ import { genCountQuery, genDefaultQuery, } from 'components/interfaces/Settings/Logs/Logs.utils' -import { get, isResponseOk } from 'lib/common/fetch' -import { API_URL } from 'lib/constants' +import { get } from 'data/fetchers' +import { parseAsString, useQueryStates } from 'nuqs' import { useFillTimeseriesSorted } from './useFillTimeseriesSorted' import useTimeseriesUnixToIso from './useTimeseriesUnixToIso' -import { parseAsString, useQueryStates } from 'nuqs' interface LogsPreviewHook { logData: LogData[] @@ -82,18 +80,28 @@ function useLogsPreview({ refetch, } = useInfiniteQuery( ['projects', projectRef, 'logs', params], - ({ signal, pageParam }) => { - const uri = `${API_URL}/projects/${projectRef}/analytics/endpoints/logs.all?${genQueryParams({ - ...params, - // don't overwrite unless user has already clicked on load older - iso_timestamp_end: pageParam || params.iso_timestamp_end, - } as any)}` - return get(uri, { signal }) + async ({ signal, pageParam }) => { + const { data, error } = await get(`/platform/projects/{ref}/analytics/endpoints/logs.all`, { + params: { + path: { ref: projectRef }, + query: { + ...params, + // don't overwrite unless user has already clicked on load older + iso_timestamp_end: pageParam || params.iso_timestamp_end, + }, + }, + signal, + }) + if (error) { + throw error + } + + return data as unknown as Logs }, { refetchOnWindowFocus: false, getNextPageParam(lastPage) { - if (!isResponseOk(lastPage) || (lastPage.result?.length ?? 0) === 0) { + if ((lastPage.result?.length ?? 0) === 0) { return undefined } const len = lastPage.result.length @@ -120,7 +128,7 @@ function useLogsPreview({ let error: null | string | object = rqError ? (rqError as any).message : null data?.pages.forEach((response) => { - if (isResponseOk(response) && response.result) { + if (response.result) { logData = [...logData, ...response.result] } if (!error && response && response.error) { @@ -133,14 +141,6 @@ function useLogsPreview({ return { logData, error, oldestTimestamp } }, [data?.pages]) - const countUrl = () => { - return `${API_URL}/projects/${projectRef}/analytics/endpoints/logs.all?${genQueryParams({ - ...params, - sql: genCountQuery(table, filters), - iso_timestamp_start: latestRefresh, - } as any)}` - } - const { data: countData } = useQuery( [ 'projects', @@ -148,7 +148,24 @@ function useLogsPreview({ 'logs-count', { ...params, sql: genCountQuery(table, filters), iso_timestamp_start: latestRefresh }, ], - ({ signal }) => get(countUrl(), { signal }), + async ({ signal }) => { + const { data, error } = await get(`/platform/projects/{ref}/analytics/endpoints/logs.all`, { + params: { + path: { ref: projectRef }, + query: { + ...params, + sql: genCountQuery(table, filters), + iso_timestamp_start: latestRefresh, + }, + }, + signal, + }) + if (error) { + throw error + } + + return data as unknown as Count + }, { refetchOnWindowFocus: false, // refresh each minute only @@ -158,23 +175,13 @@ function useLogsPreview({ } ) - const newCount = isResponseOk(countData) ? countData.result?.[0]?.count ?? 0 : 0 + const newCount = countData?.result?.[0]?.count ?? 0 // chart data const chartQuery = useMemo( () => genChartQuery(table, params, filters), [table, params.iso_timestamp_end, params.project, filters] ) - - const chartUrl = useMemo(() => { - return `${API_URL}/projects/${projectRef}/analytics/endpoints/logs.all?${genQueryParams({ - iso_timestamp_start: params.iso_timestamp_start ?? '', - iso_timestamp_end: params.iso_timestamp_end ?? '', - project: params.project ?? '', - sql: chartQuery, - })}` - }, [projectRef, params.iso_timestamp_start, params.iso_timestamp_end, params.project, chartQuery]) - const { data: eventChartResponse, refetch: refreshEventChart } = useQuery( [ 'projects', @@ -182,7 +189,25 @@ function useLogsPreview({ 'logs-chart', { iso_timestamp_end: params.iso_timestamp_end, project: params.project, sql: chartQuery }, ], - ({ signal }) => get(chartUrl, { signal }), + async ({ signal }) => { + const { data, error } = await get(`/platform/projects/{ref}/analytics/endpoints/logs.all`, { + params: { + path: { ref: projectRef }, + query: { + iso_timestamp_start: params.iso_timestamp_start ?? '', + iso_timestamp_end: params.iso_timestamp_end ?? '', + project: params.project ?? '', + sql: chartQuery, + }, + }, + signal, + }) + if (error) { + throw error + } + + return data as unknown as EventChart + }, { refetchOnWindowFocus: false } ) @@ -207,7 +232,7 @@ function useLogsPreview({ } const normalizedEventChartData = useTimeseriesUnixToIso( - (isResponseOk(eventChartResponse) && eventChartResponse.result) || [], + eventChartResponse?.result ?? [], 'timestamp' ) diff --git a/apps/studio/hooks/analytics/useLogsQuery.tsx b/apps/studio/hooks/analytics/useLogsQuery.tsx index 0452722bb38..29ac83f2e99 100644 --- a/apps/studio/hooks/analytics/useLogsQuery.tsx +++ b/apps/studio/hooks/analytics/useLogsQuery.tsx @@ -1,9 +1,9 @@ import { useQuery } from '@tanstack/react-query' import { Dispatch, SetStateAction, useState } from 'react' +import { IS_PLATFORM } from 'common' import { EXPLORER_DATEPICKER_HELPERS, - genQueryParams, getDefaultHelper, } from 'components/interfaces/Settings/Logs/Logs.constants' import type { @@ -11,14 +11,11 @@ import type { Logs, LogsEndpointParams, } from 'components/interfaces/Settings/Logs/Logs.types' -import { get, isResponseOk } from 'lib/common/fetch' -import { API_URL } from 'lib/constants' import { checkForILIKEClause, - checkForWildcard, checkForWithClause, } from 'components/interfaces/Settings/Logs/Logs.utils' -import { IS_PLATFORM } from 'common' +import { get } from 'data/fetchers' export interface LogsQueryHook { params: LogsEndpointParams @@ -51,8 +48,6 @@ const useLogsQuery = ( const _enabled = enabled && typeof projectRef !== 'undefined' && Boolean(params.sql) - const queryParams = genQueryParams(params as any) - const usesWith = checkForWithClause(params.sql || '') const usesILIKE = checkForILIKEClause(params.sql || '') @@ -63,11 +58,21 @@ const useLogsQuery = ( isRefetching, refetch, } = useQuery( - ['projects', projectRef, 'logs', queryParams], - ({ signal }) => - get(`${API_URL}/projects/${projectRef}/analytics/endpoints/logs.all?${queryParams}`, { + ['projects', projectRef, 'logs', params], + async ({ signal }) => { + const { data, error } = await get(`/platform/projects/{ref}/analytics/endpoints/logs.all`, { + params: { + path: { ref: projectRef }, + query: params, + }, signal, - }), + }) + if (error) { + throw error + } + + return data as unknown as Logs + }, { enabled: _enabled, refetchOnWindowFocus: false, @@ -101,7 +106,7 @@ const useLogsQuery = ( return { params, isLoading: (_enabled && isLoading) || isRefetching, - logData: isResponseOk(data) && data.result ? data.result : [], + logData: data?.result ?? [], error, changeQuery, runQuery: () => refetch(), diff --git a/apps/studio/hooks/analytics/useSingleLog.tsx b/apps/studio/hooks/analytics/useSingleLog.tsx index e4e293a93c7..291c17ecb47 100644 --- a/apps/studio/hooks/analytics/useSingleLog.tsx +++ b/apps/studio/hooks/analytics/useSingleLog.tsx @@ -1,5 +1,5 @@ import { useQuery } from '@tanstack/react-query' -import { LOGS_TABLES, genQueryParams } from 'components/interfaces/Settings/Logs/Logs.constants' +import { LOGS_TABLES } from 'components/interfaces/Settings/Logs/Logs.constants' import type { LogData, Logs, @@ -7,8 +7,7 @@ import type { QueryType, } from 'components/interfaces/Settings/Logs/Logs.types' import { genSingleLogQuery } from 'components/interfaces/Settings/Logs/Logs.utils' -import { get } from 'lib/common/fetch' -import { API_URL } from 'lib/constants' +import { get } from 'data/fetchers' interface SingleLogHook { data: LogData | undefined @@ -34,10 +33,6 @@ function useSingleLog({ const params: LogsEndpointParams = { ...paramsToMerge, project: projectRef, sql } - const endpointUrl = `${API_URL}/projects/${projectRef}/analytics/endpoints/logs.all?${genQueryParams( - params as any - )}` - const isWarehouseQuery = queryType === 'warehouse' // Warehouse queries are handled differently const enabled = Boolean(id && table && !isWarehouseQuery) @@ -50,7 +45,20 @@ function useSingleLog({ refetch, } = useQuery( ['projects', projectRef, 'single-log', id, queryType], - ({ signal }) => get(endpointUrl, { signal }) as Promise, + async ({ signal }) => { + const { data, error } = await get(`/platform/projects/{ref}/analytics/endpoints/logs.all`, { + params: { + path: { ref: projectRef }, + query: params, + }, + signal, + }) + if (error) { + throw error + } + + return data as unknown as Logs + }, { enabled, refetchOnWindowFocus: false, From a7f872dd4ec529c014c34df3915eef8e8f31284b Mon Sep 17 00:00:00 2001 From: Joshen Lim Date: Tue, 4 Feb 2025 19:53:35 +0800 Subject: [PATCH 002/148] Set stale time for users infinite query on auth/users to infinite (#33308) --- .../grid/components/formatter/ForeignKeyFormatter.tsx | 5 +---- apps/studio/components/interfaces/Auth/Users/UsersV2.tsx | 3 +++ 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/apps/studio/components/grid/components/formatter/ForeignKeyFormatter.tsx b/apps/studio/components/grid/components/formatter/ForeignKeyFormatter.tsx index f53f8d675b7..0c1699cfa10 100644 --- a/apps/studio/components/grid/components/formatter/ForeignKeyFormatter.tsx +++ b/apps/studio/components/grid/components/formatter/ForeignKeyFormatter.tsx @@ -7,22 +7,19 @@ import { ButtonTooltip } from 'components/ui/ButtonTooltip' import { useTableEditorQuery } from 'data/table-editor/table-editor-query' import { isTableLike } from 'data/table-editor/table-editor-types' import { useTablesQuery } from 'data/tables/tables-query' -import { useQuerySchemaState } from 'hooks/misc/useSchemaQueryState' import { Popover_Shadcn_, PopoverContent_Shadcn_, PopoverTrigger_Shadcn_ } from 'ui' import type { SupaRow } from '../../types' import { NullValue } from '../common/NullValue' import { ReferenceRecordPeek } from './ReferenceRecordPeek' interface Props extends PropsWithChildren> { - projectRef?: string tableId?: string } export const ForeignKeyFormatter = (props: Props) => { const { project } = useProjectContext() - const { selectedSchema } = useQuerySchemaState() - const { projectRef, tableId, row, column } = props + const { tableId, row, column } = props const id = tableId ? Number(tableId) : undefined const { data } = useTableEditorQuery({ diff --git a/apps/studio/components/interfaces/Auth/Users/UsersV2.tsx b/apps/studio/components/interfaces/Auth/Users/UsersV2.tsx index 91d1c3fda33..f8dfb7a3afd 100644 --- a/apps/studio/components/interfaces/Auth/Users/UsersV2.tsx +++ b/apps/studio/components/interfaces/Auth/Users/UsersV2.tsx @@ -124,6 +124,9 @@ export const UsersV2 = () => { }, { keepPreviousData: Boolean(filterKeywords), + // [Joshen] This is to prevent the dashboard from invalidating when refocusing as it may create + // a barrage of requests to invalidate each page esp when the project has many many users. + staleTime: Infinity, } ) From 216df9b1ebbe2ff05a9bd076b9044d8b761faacd Mon Sep 17 00:00:00 2001 From: Jordi Enric <37541088+jordienr@users.noreply.github.com> Date: Tue, 4 Feb 2025 13:03:47 +0100 Subject: [PATCH 003/148] fix: rename "No issues" to Healthy (#33311) rename no issues to healthy --- apps/studio/components/interfaces/Home/ServiceStatus.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/studio/components/interfaces/Home/ServiceStatus.tsx b/apps/studio/components/interfaces/Home/ServiceStatus.tsx index cf8bcd01695..7f610fabb2d 100644 --- a/apps/studio/components/interfaces/Home/ServiceStatus.tsx +++ b/apps/studio/components/interfaces/Home/ServiceStatus.tsx @@ -39,7 +39,7 @@ const StatusMessage = ({ if (status === 'COMING_UP') return 'Coming up...' if (status === 'ACTIVE_HEALTHY') return 'Healthy' if (isProjectNew) return 'Coming up...' - if (isSuccess) return 'No issues' + if (isSuccess) return 'Healthy' return 'Unable to connect' } From a67fcb18095167da2d32ff79d85a25aba652d9f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kamil=20Og=C3=B3rek?= Date: Tue, 4 Feb 2025 14:57:17 +0100 Subject: [PATCH 004/148] docs: Regenerate specs for all API docs references (#33265) * docs: Regenerate specs for all API docs references * Fix the reference docs parsing. * Update snapshots of docs tests. * fix(ui): hide details panel for file params * fix(ui): fix array display when inner type is not given --------- Co-authored-by: Ivan Vasilov Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com> --- .../docs/features/docs/Reference.api.utils.ts | 10 + apps/docs/features/docs/Reference.ui.tsx | 21 +- .../Reference.typeSpec.test.ts.snap | 2863 +- apps/docs/spec/api_v1_openapi.json | 111 +- apps/docs/spec/common-api-sections.json | 6 + .../spec/enrichments/tsdoc_v2/combined.json | 43993 ++++++++++------ .../spec/enrichments/tsdoc_v2/functions.json | 348 +- .../tsdoc_v2/functions_dereferenced.json | 504 +- .../spec/enrichments/tsdoc_v2/gotrue.json | 12168 +++-- .../tsdoc_v2/gotrue_dereferenced.json | 18658 ++++--- .../spec/enrichments/tsdoc_v2/postgrest.json | 6308 ++- .../tsdoc_v2/postgrest_dereferenced.json | 8023 +-- .../spec/enrichments/tsdoc_v2/realtime.json | 2403 +- .../tsdoc_v2/realtime_dereferenced.json | 11651 ++-- .../spec/enrichments/tsdoc_v2/storage.json | 2810 +- .../tsdoc_v2/storage_dereferenced.json | 3444 +- .../spec/enrichments/tsdoc_v2/supabase.json | 1419 +- .../tsdoc_v2/supabase_dereferenced.json | 1693 +- apps/docs/spec/storage_v0_openapi.json | 202 +- .../transforms/api_v1_openapi_deparsed.json | 292 +- .../transforms/auth_v1_openapi_deparsed.json | 4 +- .../storage_v0_openapi_deparsed.json | 526 +- packages/generator/package.json | 1 + pnpm-lock.yaml | 3 + 24 files changed, 71114 insertions(+), 46347 deletions(-) diff --git a/apps/docs/features/docs/Reference.api.utils.ts b/apps/docs/features/docs/Reference.api.utils.ts index 4d425c467cf..06c0791b1f9 100644 --- a/apps/docs/features/docs/Reference.api.utils.ts +++ b/apps/docs/features/docs/Reference.api.utils.ts @@ -32,6 +32,7 @@ export type ISchema = | ISchemaEnum | ISchemaBoolean | ISchemaNumber + | ISchemaFile | ISchemaArray | ISchemaAllOf | ISchemaAnyOf @@ -67,6 +68,11 @@ interface ISchemaString extends ISchemaBase { pattern?: string } +interface ISchemaFile extends ISchemaBase { + type: 'file' + format?: 'binary' +} + interface ISchemaObject extends ISchemaBase { type: 'object' properties?: { [key: string]: ISchema } @@ -165,6 +171,10 @@ export function getTypeDisplayFromSchema(schema: ISchema) { return { displayName: 'string', } + } else if (schema.type === 'file') { + return { + displayName: 'file', + } } else if (schema.type === 'array') { return { displayName: `Array<${getTypeDisplayFromSchema(schema.items).displayName}>`, diff --git a/apps/docs/features/docs/Reference.ui.tsx b/apps/docs/features/docs/Reference.ui.tsx index 93d4c18f588..2b0c29817cc 100644 --- a/apps/docs/features/docs/Reference.ui.tsx +++ b/apps/docs/features/docs/Reference.ui.tsx @@ -1,15 +1,11 @@ import { isEqual } from 'lodash' import { ChevronRight, XCircle } from 'lucide-react' import type { HTMLAttributes, PropsWithChildren } from 'react' +import ReactMarkdown from 'react-markdown' -import { - Collapsible_Shadcn_, - CollapsibleContent_Shadcn_, - CollapsibleTrigger_Shadcn_, - cn, - CodeBlock, -} from 'ui' +import { cn, Collapsible_Shadcn_, CollapsibleContent_Shadcn_, CollapsibleTrigger_Shadcn_ } from 'ui' +import ApiSchema from '~/components/ApiSchema' import { MDXRemoteBase } from '~/features/docs/MdxBase' import { MDXRemoteRefs } from '~/features/docs/Reference.mdx' import type { @@ -23,8 +19,6 @@ import { ReferenceSectionWrapper } from '~/features/docs/Reference.ui.client' import { normalizeMarkdown } from '~/features/docs/Reference.utils' import { getTypeDisplayFromSchema, IApiEndPoint, type ISchema } from './Reference.api.utils' import { API_REFERENCE_REQUEST_BODY_SCHEMA_DATA_ATTRIBUTES } from './Reference.ui.shared' -import ReactMarkdown from 'react-markdown' -import ApiSchema from '~/components/ApiSchema' interface SectionProps extends PropsWithChildren { link: string @@ -479,7 +473,7 @@ export function ApiSchemaParamSubdetails({ !('minLength' in schema || 'maxLength' in schema || 'pattern' in schema)) || (schema.type === 'array' && 'type' in schema.items && - ['boolean', 'number', 'integer', 'string'].includes(schema.items.type))) + ['boolean', 'number', 'integer', 'string', 'file'].includes(schema.items.type))) ) { return null } @@ -630,7 +624,8 @@ function getTypeName(parameter: object): string { case 'array': // Needs an extra level of wrapping to fake the wrapping parameter // @ts-ignore - return `Array<${getTypeName({ type: type.elemType })}>` + const innerType = getTypeName({ type: type.elemType }) + return innerType ? `Array<${innerType}>` : 'Array' } return '' @@ -696,14 +691,14 @@ function getSubDetails(parentType: MethodTypes['params'][number] | MethodTypes[' } break case 'array': - if (parentType.type.elemType.type === 'union') { + if (parentType.type.elemType?.type === 'union') { subDetails = parentType.type.elemType.subTypes.map((subType, index) => ({ name: `union option ${index + 1}`, type: { ...subType }, isOptional: 'NA', })) } - if (parentType.type.elemType.type === 'object') { + if (parentType.type.elemType?.type === 'object') { subDetails = parentType.type.elemType.properties } break diff --git a/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap b/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap index 8daa7a2c106..bbd43282922 100644 --- a/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap +++ b/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap @@ -202,6 +202,34 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "comment": { "shortText": "Options passed to the realtime-js instance" } + }, + { + "type": "function", + "name": "accessToken", + "params": [], + "ret": { + "type": { + "type": "promise", + "name": "Promise", + "awaited": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + }, + "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 client library. Note that this\\nfunction may be called concurrently and many times. Use memoization and\\nlocking techniques if this is not supported by the client libraries.", + "text": "When 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.\\n" + } } ] }, @@ -692,6 +720,22 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": "intrinsic", "name": "number" } + }, + { + "name": "code", + "type": { + "type": "union", + "subTypes": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } } ], "ret": { @@ -701,38 +745,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } }, - "@supabase/auth-js.AuthApiError.toJSON": { - "name": "@supabase/auth-js.AuthApiError.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": "intrinsic", - "name": "number" - } - } - ] - } - } - }, "@supabase/auth-js.AuthError.constructor": { "name": "@supabase/auth-js.AuthError.constructor", "params": [ @@ -750,6 +762,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "number" }, "isOptional": true + }, + { + "name": "code", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true } ], "ret": { @@ -889,38 +909,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } }, - "@supabase/auth-js.AuthInvalidCredentialsError.toJSON": { - "name": "@supabase/auth-js.AuthInvalidCredentialsError.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": "intrinsic", - "name": "number" - } - } - ] - } - } - }, "@supabase/auth-js.AuthInvalidTokenResponseError.constructor": { "name": "@supabase/auth-js.AuthInvalidTokenResponseError.constructor", "params": [], @@ -931,38 +919,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } }, - "@supabase/auth-js.AuthInvalidTokenResponseError.toJSON": { - "name": "@supabase/auth-js.AuthInvalidTokenResponseError.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": "intrinsic", - "name": "number" - } - } - ] - } - } - }, "@supabase/auth-js.AuthPKCEGrantCodeExchangeError.constructor": { "name": "@supabase/auth-js.AuthPKCEGrantCodeExchangeError.constructor", "params": [ @@ -1100,38 +1056,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } }, - "@supabase/auth-js.AuthRetryableFetchError.toJSON": { - "name": "@supabase/auth-js.AuthRetryableFetchError.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": "intrinsic", - "name": "number" - } - } - ] - } - } - }, "@supabase/auth-js.AuthSessionMissingError.constructor": { "name": "@supabase/auth-js.AuthSessionMissingError.constructor", "params": [], @@ -1142,38 +1066,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } }, - "@supabase/auth-js.AuthSessionMissingError.toJSON": { - "name": "@supabase/auth-js.AuthSessionMissingError.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": "intrinsic", - "name": "number" - } - } - ] - } - } - }, "@supabase/auth-js.AuthUnknownError.constructor": { "name": "@supabase/auth-js.AuthUnknownError.constructor", "params": [ @@ -1234,38 +1126,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } }, - "@supabase/auth-js.AuthWeakPasswordError.toJSON": { - "name": "@supabase/auth-js.AuthWeakPasswordError.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": "intrinsic", - "name": "number" - } - } - ] - } - } - }, "@supabase/auth-js.CustomAuthError.constructor": { "name": "@supabase/auth-js.CustomAuthError.constructor", "params": [ @@ -1289,6 +1149,22 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": "intrinsic", "name": "number" } + }, + { + "name": "code", + "type": { + "type": "union", + "subTypes": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } } ], "ret": { @@ -1298,38 +1174,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } }, - "@supabase/auth-js.CustomAuthError.toJSON": { - "name": "@supabase/auth-js.CustomAuthError.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": "intrinsic", - "name": "number" - } - } - ] - } - } - }, "@supabase/auth-js.GoTrueAdminApi.constructor": { "name": "@supabase/auth-js.GoTrueAdminApi.constructor", "params": [ @@ -1463,6 +1307,18 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "text": "Only a service role can modify.\\n" } }, + { + "name": "id", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true, + "comment": { + "shortText": "The \`id\` for the user.", + "text": "Allows you to overwrite the default \`id\` set for the user.\\n" + } + }, { "name": "nonce", "type": { @@ -1486,6 +1342,18 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "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.", + "text": "Allows 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.\\n" + } + }, { "name": "phone", "type": { @@ -1656,11 +1524,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -1810,6 +1688,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -1952,7 +1838,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "boolean" }, "comment": { - "shortText": "If true, then the user will be soft-deleted (setting \`deleted_at\` to the current timestamp and disabling their account while preserving their data) from the auth schema.\\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.\\n" + "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.\\n" } } ], @@ -2075,11 +1961,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -2229,6 +2125,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -2782,11 +2686,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -2936,6 +2850,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -3198,11 +3120,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -3352,6 +3284,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -3640,11 +3580,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -3794,6 +3744,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -4147,6 +4105,18 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "text": "Only a service role can modify.\\n" } }, + { + "name": "id", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true, + "comment": { + "shortText": "The \`id\` for the user.", + "text": "Allows you to overwrite the default \`id\` set for the user.\\n" + } + }, { "name": "nonce", "type": { @@ -4170,6 +4140,18 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "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.", + "text": "Allows 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.\\n" + } + }, { "name": "phone", "type": { @@ -4343,11 +4325,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -4497,6 +4489,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -4711,6 +4711,23 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "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": "\\n" + } + ] + } + }, { "name": "headers", "type": { @@ -5064,11 +5081,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -5218,6 +5245,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -5399,11 +5434,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -5553,6 +5598,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -5897,11 +5950,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -6051,6 +6114,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -6338,11 +6409,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -6492,6 +6573,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -6920,6 +7009,10 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -7036,6 +7129,10 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -7156,6 +7253,10 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -7459,11 +7560,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -7613,6 +7724,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -7989,11 +8108,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -8143,6 +8272,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -8480,11 +8617,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -8634,6 +8781,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -8824,11 +8979,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -8978,6 +9143,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -9352,11 +9525,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -9506,6 +9689,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -9696,11 +9887,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -9850,6 +10051,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -10561,11 +10770,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -10715,6 +10934,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -10905,11 +11132,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -11059,6 +11296,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -11456,11 +11701,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -11610,6 +11865,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -11800,11 +12063,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -11954,6 +12227,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -12163,13 +12444,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "value": "facebook" }, { - "type": "intrinsic", - "name": "string" - } + "type": "literal", + "value": "kakao" + }, + 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\`, \`keycloak\` (deprecated)." + "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\`, \`keycloak\` (deprecated)." } }, { @@ -12399,11 +12681,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -12553,6 +12845,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -12734,11 +13034,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -12888,6 +13198,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -13152,6 +13470,10 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -13268,6 +13590,10 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -13388,6 +13714,10 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -14037,11 +14367,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -14191,6 +14531,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -14372,11 +14720,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -14526,6 +14884,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -14634,10 +15000,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "type": "literal", "value": "pwned" }, - { - "type": "intrinsic", - "name": "string" - } + null ] } } @@ -15324,11 +15687,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -15478,6 +15851,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -15668,11 +16049,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -15822,6 +16213,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -16329,11 +16728,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -16483,6 +16892,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -17068,11 +17485,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -17222,6 +17649,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -17412,11 +17847,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -17566,6 +18011,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -17884,11 +18337,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -17993,6 +18456,26 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "MFAChallengeParams", "type": "object", "properties": [ + { + "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). Only relevant for phone factors" + } + }, { "name": "factorId", "type": { @@ -18042,6 +18525,25 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "comment": { "shortText": "ID of the newly created challenge." } + }, + { + "name": "type", + "type": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] + }, + "comment": { + "shortText": "Factor Type which generated the challenge" + } } ] } @@ -18274,11 +18776,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -18428,6 +18940,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -18551,7 +19071,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "params", "type": { - "name": "MFAEnrollParams", + "name": "MFAEnrollTOTPParams", "type": "object", "properties": [ { @@ -18596,7 +19116,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "Promise", "awaited": { "type": "union", - "name": "AuthMFAEnrollResponse", + "name": "AuthMFAEnrollTOTPResponse", "subTypes": [ { "type": "object", @@ -18675,7 +19195,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "value": "totp" }, "comment": { - "shortText": "Type of MFA factor. Only \`totp\` supported for now." + "shortText": "Type of MFA factor." } } ] @@ -18716,7 +19236,444 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "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.", "text": "Upon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to \`aal2\`.\\n\\n" - } + }, + "altSignatures": [ + { + "params": [ + { + "name": "params", + "type": { + "name": "MFAEnrollPhoneParams", + "type": "object", + "properties": [ + { + "name": "factorType", + "type": { + "type": "literal", + "value": "phone" + }, + "comment": { + "shortText": "The type of factor being enrolled." + } + }, + { + "name": "friendlyName", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true, + "comment": { + "shortText": "Human readable name assigned to the factor." + } + }, + { + "name": "phone", + "type": { + "type": "intrinsic", + "name": "string" + }, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + } + } + ] + } + } + ], + "ret": { + "type": { + "type": "promise", + "name": "Promise", + "awaited": { + "type": "union", + "name": "AuthMFAEnrollPhoneResponse", + "subTypes": [ + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "object", + "properties": [ + { + "name": "friendly_name", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + } + }, + { + "name": "id", + "type": { + "type": "intrinsic", + "name": "string" + }, + "comment": { + "shortText": "ID of the factor that was just enrolled (in an unverified state)." + } + }, + { + "name": "phone", + "type": { + "type": "intrinsic", + "name": "string" + }, + "comment": { + "shortText": "Phone number of the MFA factor in E.164 format. Used to send messages" + } + }, + { + "name": "type", + "type": { + "type": "literal", + "value": "phone" + }, + "comment": { + "shortText": "Type of MFA factor." + } + } + ] + } + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null + } + } + ] + }, + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null + } + }, + { + "name": "error", + "type": { + "type": "nameOnly", + "name": "AuthError" + } + } + ] + } + ] + } + } + } + }, + { + "params": [ + { + "name": "params", + "type": { + "type": "union", + "name": "MFAEnrollParams", + "subTypes": [ + { + "type": "object", + "properties": [ + { + "name": "factorType", + "type": { + "type": "literal", + "value": "totp" + }, + "comment": { + "shortText": "The type of factor being enrolled." + } + }, + { + "name": "friendlyName", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true, + "comment": { + "shortText": "Human readable name assigned to the factor." + } + }, + { + "name": "issuer", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true, + "comment": { + "shortText": "Domain which the user is enrolled with." + } + } + ] + }, + { + "type": "object", + "properties": [ + { + "name": "factorType", + "type": { + "type": "literal", + "value": "phone" + }, + "comment": { + "shortText": "The type of factor being enrolled." + } + }, + { + "name": "friendlyName", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true, + "comment": { + "shortText": "Human readable name assigned to the factor." + } + }, + { + "name": "phone", + "type": { + "type": "intrinsic", + "name": "string" + }, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + } + } + ] + } + ] + } + } + ], + "ret": { + "type": { + "type": "promise", + "name": "Promise", + "awaited": { + "type": "union", + "name": "AuthMFAEnrollResponse", + "subTypes": [ + { + "type": "union", + "subTypes": [ + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "object", + "properties": [ + { + "name": "friendly_name", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + } + }, + { + "name": "id", + "type": { + "type": "intrinsic", + "name": "string" + }, + "comment": { + "shortText": "ID of the factor that was just enrolled (in an unverified state)." + } + }, + { + "name": "totp", + "type": { + "type": "object", + "properties": [ + { + "name": "qr_code", + "type": { + "type": "intrinsic", + "name": "string" + }, + "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." + } + }, + { + "name": "secret", + "type": { + "type": "intrinsic", + "name": "string" + }, + "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." + } + }, + { + "name": "uri", + "type": { + "type": "intrinsic", + "name": "string" + }, + "comment": { + "shortText": "The authenticator URI encoded within the QR code, should you need\\nto use it. Avoid loggin this value to the console." + } + } + ] + }, + "comment": { + "shortText": "TOTP enrollment information." + } + }, + { + "name": "type", + "type": { + "type": "literal", + "value": "totp" + }, + "comment": { + "shortText": "Type of MFA factor." + } + } + ] + } + }, + { + "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": "union", + "subTypes": [ + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "object", + "properties": [ + { + "name": "friendly_name", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + } + }, + { + "name": "id", + "type": { + "type": "intrinsic", + "name": "string" + }, + "comment": { + "shortText": "ID of the factor that was just enrolled (in an unverified state)." + } + }, + { + "name": "phone", + "type": { + "type": "intrinsic", + "name": "string" + }, + "comment": { + "shortText": "Phone number of the MFA factor in E.164 format. Used to send messages" + } + }, + { + "name": "type", + "type": { + "type": "literal", + "value": "phone" + }, + "comment": { + "shortText": "Type of MFA factor." + } + } + ] + } + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null + } + } + ] + }, + { + "type": "object", + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null + } + }, + { + "name": "error", + "type": { + "type": "nameOnly", + "name": "AuthError" + } + } + ] + } + ] + } + ] + } + } + } + } + ] }, "@supabase/auth-js.GoTrueMFAApi.getAuthenticatorAssuranceLevel": { "name": "@supabase/auth-js.GoTrueMFAApi.getAuthenticatorAssuranceLevel", @@ -18748,8 +19705,26 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "method", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": "password" + }, + null, + { + "type": "literal", + "value": "otp" + }, + { + "type": "literal", + "value": "oauth" + }, + { + "type": "literal", + "value": "mfa/totp" + } + ] }, "comment": { "shortText": "Authentication method name." @@ -18913,11 +19888,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -18974,6 +19959,95 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "shortText": "All available factors (verified and unverified)." } }, + { + "name": "phone", + "type": { + "type": "array", + "elemType": { + "type": "object", + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "name": "factor_type", + "type": { + "type": "union", + "subTypes": [ + null, + { + "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": "status", + "type": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": "verified" + }, + { + "type": "literal", + "value": "unverified" + } + ] + }, + "comment": { + "shortText": "Factor's status." + } + }, + { + "name": "updated_at", + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + "comment": { + "shortText": "Only verified Phone factors. (A subset of \`all\`.)" + } + }, { "name": "totp", "type": { @@ -18992,11 +20066,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -19396,11 +20480,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -19550,6 +20644,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -19911,11 +21013,21 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "factor_type", "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "subTypes": [ + null, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] }, "comment": { - "shortText": "Type of factor. Only \`totp\` supported with this version but may change in\\nfuture versions." + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" } }, { @@ -20065,6 +21177,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "isOptional": true }, + { + "name": "is_anonymous", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, { "name": "last_sign_in_at", "type": { @@ -20188,6 +21308,34 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } }, + "@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": "nameOnly", + "name": "Result" + } + }, + "comment": { + "shortText": "Set an HTTP header for the request." + } + }, "@supabase/postgrest-js.PostgrestBuilder.then": { "name": "@supabase/postgrest-js.PostgrestBuilder.then", "params": [ @@ -20204,134 +21352,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "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": "T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "statusText", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "type": "object", - "name": "PostgrestResponseFailure", - "properties": [ - { - "name": "count", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "name": "PostgrestError", - "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": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "statusText", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } + "name": "value" } ], "ret": { @@ -20405,12 +21426,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "@supabase/postgrest-js.PostgrestBuilder.throwOnError": { "name": "@supabase/postgrest-js.PostgrestBuilder.throwOnError", "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "Result" - } - }, "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.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\\n" @@ -20692,6 +21707,47 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "text": "The schema needs to be on the list of exposed schemas inside Supabase.\\n" } }, + "@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" + } + } + ] + } + } + ] + }, "@supabase/postgrest-js.PostgrestFilterBuilder.constructor": { "name": "@supabase/postgrest-js.PostgrestFilterBuilder.constructor", "params": [ @@ -20992,10 +22048,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, { "name": "value", - "type": { - "type": "nameOnly", - "name": "NonNullable" - }, "comment": { "shortText": "The value to filter with\\n" } @@ -21010,43 +22062,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "comment": { "shortText": "Match only rows where \`column\` is equal to \`value\`.", "text": "To check if the value of \`column\` is NULL, you should use \`.is()\` instead.\\n" - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "value", - "type": { - "type": "nameOnly", - "name": "NonNullable" - }, - "comment": { - "shortText": "The value to filter with\\n" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "Schema" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is equal to \`value\`.", - "text": "To check if the value of \`column\` is NULL, you should use \`.is()\` instead.\\n" - } - } - ] + } }, "@supabase/postgrest-js.PostgrestFilterBuilder.explain": { "name": "@supabase/postgrest-js.PostgrestFilterBuilder.explain", @@ -21747,11 +22763,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "values", "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } + "type": "array" }, "comment": { "shortText": "The values array to filter with\\n" @@ -21766,45 +22778,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "comment": { "shortText": "Match only rows where \`column\` is included in the \`values\` array." - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "values", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "comment": { - "shortText": "The values array to filter with\\n" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "Schema" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is included in the \`values\` array." - } - } - ] + } }, "@supabase/postgrest-js.PostgrestFilterBuilder.is": { "name": "@supabase/postgrest-js.PostgrestFilterBuilder.is", @@ -22399,10 +23373,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, { "name": "value", - "type": { - "type": "nameOnly", - "name": "Row['ColumnName']" - }, "comment": { "shortText": "The value to filter with\\n" } @@ -22416,42 +23386,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` }, "comment": { "shortText": "Match only rows where \`column\` is not equal to \`value\`." - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "comment": { - "shortText": "The value to filter with\\n" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "Schema" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is not equal to \`value\`." - } - } - ] + } }, "@supabase/postgrest-js.PostgrestFilterBuilder.not": { "name": "@supabase/postgrest-js.PostgrestFilterBuilder.not", @@ -23032,7 +23967,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Limit the query result by starting at an offset (\`from\`) and ending at the offset (\`from + 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." + "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." } }, "@supabase/postgrest-js.PostgrestFilterBuilder.rangeAdjacent": { @@ -23433,6 +24368,34 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "text": "By default, \`.insert()\`, \`.update()\`, \`.upsert()\`, and \`.delete()\` do not\\nreturn modified rows. By calling this method, modified rows are returned in\\n\`data\`.\\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": "nameOnly", + "name": "Schema" + } + }, + "comment": { + "shortText": "Set an HTTP header for the request." + } + }, "@supabase/postgrest-js.PostgrestFilterBuilder.single": { "name": "@supabase/postgrest-js.PostgrestFilterBuilder.single", "params": [], @@ -23700,41 +24663,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, { - "name": "error", - "type": { - "name": "PostgrestError", - "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": "error" }, { "name": "status", @@ -23827,12 +24756,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "@supabase/postgrest-js.PostgrestFilterBuilder.throwOnError": { "name": "@supabase/postgrest-js.PostgrestFilterBuilder.throwOnError", "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "Schema" - } - }, "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.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\\n" @@ -25039,7 +25962,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, "comment": { - "shortText": "Limit the query result by starting at an offset (\`from\`) and ending at the offset (\`from + 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." + "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." } }, "@supabase/postgrest-js.PostgrestTransformBuilder.returns": { @@ -25095,6 +26018,34 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "text": "By default, \`.insert()\`, \`.update()\`, \`.upsert()\`, and \`.delete()\` do not\\nreturn modified rows. By calling this method, modified rows are returned in\\n\`data\`.\\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": "nameOnly", + "name": "Schema" + } + }, + "comment": { + "shortText": "Set an HTTP header for the request." + } + }, "@supabase/postgrest-js.PostgrestTransformBuilder.single": { "name": "@supabase/postgrest-js.PostgrestTransformBuilder.single", "params": [], @@ -25199,41 +26150,7 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } }, { - "name": "error", - "type": { - "name": "PostgrestError", - "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": "error" }, { "name": "status", @@ -25326,12 +26243,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "@supabase/postgrest-js.PostgrestTransformBuilder.throwOnError": { "name": "@supabase/postgrest-js.PostgrestTransformBuilder.throwOnError", "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "Schema" - } - }, "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.", "text": "{@link https://github.com/supabase/supabase-js/issues/92}\\n" @@ -25410,6 +26321,17 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "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" + } } ] } @@ -25422,49 +26344,6 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } ] }, - "@supabase/realtime-js.RealtimeChannel._fetchWithTimeout": { - "name": "@supabase/realtime-js.RealtimeChannel._fetchWithTimeout", - "params": [ - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - } - }, - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - } - }, "@supabase/realtime-js.RealtimeChannel.on": { "name": "@supabase/realtime-js.RealtimeChannel.on", "params": [ @@ -26145,6 +27024,41 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` } } ] + }, + { + "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" + } + } + } + } + ] } ] }, @@ -26284,25 +27198,8 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` { "name": "status", "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "SUBSCRIBED" - }, - { - "type": "literal", - "value": "TIMED_OUT" - }, - { - "type": "literal", - "value": "CLOSED" - }, - { - "type": "literal", - "value": "CHANNEL_ERROR" - } - ] + "type": "nameOnly", + "name": "REALTIME_SUBSCRIBE_STATES" } }, { @@ -26636,6 +27533,46 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "WebSocketLikeConstructor" }, "isOptional": true + }, + { + "name": "worker", + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "isOptional": true + }, + { + "name": "workerUrl", + "type": { + "type": "intrinsic", + "name": "string" + }, + "isOptional": true + }, + { + "type": "function", + "name": "accessToken", + "params": [], + "ret": { + "type": { + "type": "promise", + "name": "Promise", + "awaited": { + "type": "union", + "subTypes": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + } } ] }, @@ -26646,6 +27583,33 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "shortText": "Initializes the Socket." } }, + "@supabase/realtime-js.RealtimeClient._workerObjectUrl": { + "name": "@supabase/realtime-js.RealtimeClient._workerObjectUrl", + "params": [ + { + "name": "url", + "type": { + "type": "union", + "subTypes": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "ret": { + "type": { + "type": "intrinsic", + "name": "string" + } + } + }, "@supabase/realtime-js.RealtimeClient.channel": { "name": "@supabase/realtime-js.RealtimeClient.channel", "params": [ @@ -26714,6 +27678,17 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "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" + } } ] } @@ -26785,6 +27760,33 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "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.", + "returns": "string The URL of the websocket.\\n" + } + }, + "@supabase/realtime-js.RealtimeClient.flushSendBuffer": { + "name": "@supabase/realtime-js.RealtimeClient.flushSendBuffer", + "params": [], + "ret": { + "type": { + "type": "intrinsic", + "name": "void" + } + }, + "comment": { + "shortText": "Flushes send buffer" + } + }, "@supabase/realtime-js.RealtimeClient.getChannels": { "name": "@supabase/realtime-js.RealtimeClient.getChannels", "params": [], @@ -26979,6 +27981,23 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "shortText": "Unsubscribes and removes 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": [ @@ -26998,18 +28017,23 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` ] }, "comment": { - "shortText": "A JWT string.\\n" + "shortText": "A JWT string to override the token set on the client.\\n" } } ], "ret": { "type": { - "type": "intrinsic", - "name": "void" + "type": "promise", + "name": "Promise", + "awaited": { + "type": "intrinsic", + "name": "void" + } } }, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the \`accessToken\` callback function or the token set on the client.\\n\\nOn callback used, it will set the value of the token internal to the client.\\n" } }, "@supabase/realtime-js.RealtimePresence.constructor": { @@ -28730,7 +29754,28 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The new file path, including the new file name. For example \`folder/image-copy.png\`.\\n" + "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.\\n" } } ], @@ -28805,8 +29850,27 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The file path, including the current file name. For example \`folder/image.png\`.\\n" + "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.\\n" + } + } + ] + }, + "isOptional": true } ], "ret": { @@ -29389,6 +30453,73 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "shortText": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from \`getPublicUrl\` instead." } }, + "@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": "\\n" + } + } + ], + "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." + } + }, "@supabase/storage-js.packages/StorageFileApi.default.getPublicUrl": { "name": "@supabase/storage-js.packages/StorageFileApi.default.getPublicUrl", "params": [ @@ -29540,6 +30671,73 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "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." } }, + "@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": "\\n" + } + } + ], + "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." + } + }, "@supabase/storage-js.packages/StorageFileApi.default.list": { "name": "@supabase/storage-js.packages/StorageFileApi.default.list", "params": [ @@ -29860,7 +31058,28 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "name": "string" }, "comment": { - "shortText": "The new file path, including the new file name. For example \`folder/image-new.png\`.\\n" + "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.\\n" } } ], @@ -30134,6 +31353,24 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "shortText": "Deletes files within the same bucket" } }, + "@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": [ @@ -30237,6 +31474,44 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "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": { @@ -30390,6 +31665,44 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "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": { @@ -30553,6 +31866,44 @@ exports[`TS type spec parsing > matches snapshot 1`] = ` "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": { diff --git a/apps/docs/spec/api_v1_openapi.json b/apps/docs/spec/api_v1_openapi.json index b1de4affd6c..cee17c87cd1 100644 --- a/apps/docs/spec/api_v1_openapi.json +++ b/apps/docs/spec/api_v1_openapi.json @@ -2334,6 +2334,48 @@ "security": [{ "bearer": [] }] } }, + "/v1/projects/{ref}/functions/deploy": { + "post": { + "operationId": "v1-deploy-a-function", + "summary": "Deploy a function", + "description": "A new endpoint to deploy functions. It will create if function does not exist.", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { "minLength": 20, "maxLength": 20, "type": "string" } + }, + { + "name": "slug", + "required": false, + "in": "query", + "schema": { "pattern": "/^[A-Za-z0-9_-]+$/", "type": "string" } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { "$ref": "#/components/schemas/FunctionDeployBody" } + } + } + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/FunctionResponse" } } + } + }, + "403": { "description": "" }, + "500": { "description": "Failed to deploy function" } + }, + "tags": ["Edge Functions"], + "security": [{ "bearer": [] }] + } + }, "/v1/projects/{ref}/functions/{function_slug}": { "get": { "operationId": "v1-get-a-function", @@ -3051,20 +3093,11 @@ "format": "uri", "description": "Template URL used to create the project from the CLI.", "example": "https://github.com/supabase/supabase/tree/master/examples/slack-clone/nextjs-slack-clone" - }, - "release_channel": { - "type": "string", - "enum": ["internal", "alpha", "beta", "ga", "withdrawn", "preview"], - "description": "Release channel. If not provided, GA will be used." - }, - "postgres_engine": { - "type": "string", - "enum": ["15", "17-oriole"], - "description": "Postgres engine version. If not provided, the latest version will be used." } }, "required": ["db_pass", "name", "organization_id", "region"], - "additionalProperties": false + "additionalProperties": false, + "hideDefinitions": ["release_channel", "postgres_engine"] }, "V1ProjectResponse": { "type": "object", @@ -4484,18 +4517,8 @@ }, "RestoreProjectBodyDto": { "type": "object", - "properties": { - "release_channel": { - "type": "string", - "enum": ["internal", "alpha", "beta", "ga", "withdrawn", "preview"], - "description": "Release channel version. If not provided, GeneralAvailability will be used." - }, - "postgres_engine": { - "type": "string", - "enum": ["15", "17-oriole"], - "description": "Postgres engine version. If not provided, the latest version from the given release channel will be used." - } - } + "properties": {}, + "hideDefinitions": ["release_channel", "postgres_engine"] }, "V1AnalyticsResponse": { "type": "object", @@ -4537,7 +4560,23 @@ "properties": { "databases": { "type": "array", - "items": { "type": "object", "properties": {}, "additionalProperties": true } + "items": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "schemas": { + "type": "array", + "items": { + "type": "object", + "properties": { "name": { "type": "string" } }, + "required": ["name"], + "additionalProperties": true + } + } + }, + "required": ["name", "schemas"], + "additionalProperties": true + } } }, "required": ["databases"] @@ -4571,6 +4610,30 @@ }, "required": ["slug", "name", "body"] }, + "FunctionDeployBody": { + "type": "object", + "properties": { + "file": { + "type": "array", + "items": { "type": "file", "items": { "type": "string", "format": "binary" } } + }, + "metadata": { + "type": "object", + "properties": { + "entrypoint_path": { "required": true, "type": "string" }, + "import_map_path": { "required": false, "type": "string" }, + "static_patterns": { + "required": false, + "type": "array", + "items": { "type": "string" } + }, + "verify_jwt": { "required": false, "type": "boolean" }, + "name": { "required": false, "type": "string" } + } + } + }, + "required": ["file", "metadata"] + }, "FunctionSlugResponse": { "type": "object", "properties": { diff --git a/apps/docs/spec/common-api-sections.json b/apps/docs/spec/common-api-sections.json index 5c82c7615df..dd44a2e8b95 100644 --- a/apps/docs/spec/common-api-sections.json +++ b/apps/docs/spec/common-api-sections.json @@ -237,6 +237,12 @@ "slug": "v1-delete-a-function", "type": "operation" }, + { + "id": "v1-deploy-a-function", + "title": "Deploy a function", + "slug": "v1-deploy-a-function", + "type": "operation" + }, { "id": "v1-get-a-function", "title": "Get a function", diff --git a/apps/docs/spec/enrichments/tsdoc_v2/combined.json b/apps/docs/spec/enrichments/tsdoc_v2/combined.json index 62b0ae6c5a1..7b18b0747a5 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/combined.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/combined.json @@ -16,7 +16,7 @@ "flags": {}, "children": [ { - "id": 213, + "id": 227, "name": "QueryData", "kind": 16777216, "kindString": "Reference", @@ -28,10 +28,10 @@ "character": 50 } ], - "target": 112 + "target": 123 }, { - "id": 214, + "id": 228, "name": "QueryError", "kind": 16777216, "kindString": "Reference", @@ -43,10 +43,10 @@ "character": 61 } ], - "target": 116 + "target": 127 }, { - "id": 212, + "id": 226, "name": "QueryResult", "kind": 16777216, "kindString": "Reference", @@ -58,10 +58,10 @@ "character": 37 } ], - "target": 110 + "target": 121 }, { - "id": 211, + "id": 225, "name": "SupabaseClientOptions", "kind": 16777216, "kindString": "Reference", @@ -76,7 +76,7 @@ "target": 70 }, { - "id": 119, + "id": 130, "name": "SupabaseClient", "kind": 128, "kindString": "Class", @@ -87,7 +87,7 @@ }, "children": [ { - "id": 120, + "id": 131, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -95,13 +95,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 69, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 121, + "id": 132, "name": "new SupabaseClient", "kind": 16384, "kindString": "Constructor signature", @@ -111,7 +111,7 @@ }, "typeParameter": [ { - "id": 122, + "id": 133, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -122,7 +122,7 @@ } }, { - "id": 123, + "id": 134, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -142,7 +142,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, @@ -162,7 +162,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } } @@ -171,14 +171,14 @@ } }, { - "id": 124, + "id": 135, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "default": { @@ -187,18 +187,18 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, "extendsType": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "trueType": { @@ -221,7 +221,7 @@ ], "parameters": [ { - "id": 125, + "id": 136, "name": "supabaseUrl", "kind": 32768, "kindString": "Parameter", @@ -235,7 +235,7 @@ } }, { - "id": 126, + "id": 137, "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", @@ -249,7 +249,7 @@ } }, { - "id": 127, + "id": 138, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -262,7 +262,7 @@ "typeArguments": [ { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" } ], @@ -282,7 +282,7 @@ ], "typeParameter": [ { - "id": 90, + "id": 92, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -606,7 +606,7 @@ ], "type": { "type": "reference", - "id": 90, + "id": 92, "name": "SchemaName", "dereferenced": {} } @@ -778,6 +778,56 @@ "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } + }, + { + "id": 90, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "signatures": [ + { + "id": 91, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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 client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", + "text": "When 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.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -785,6 +835,11 @@ "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] + }, + { + "title": "Methods", + "kind": 2048, + "children": [90] } ], "sources": [ @@ -802,21 +857,21 @@ ], "type": { "type": "reference", - "id": 119, + "id": 130, "typeArguments": [ { "type": "reference", - "id": 122, + "id": 133, "name": "Database" }, { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, { "type": "reference", - "id": 124, + "id": 135, "name": "Schema" } ], @@ -826,7 +881,64 @@ ] }, { - "id": 128, + "id": 153, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 54, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 154, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 155, + "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": 139, "name": "auth", "kind": 1024, "kindString": "Property", @@ -847,7 +959,7 @@ } }, { - "id": 131, + "id": 142, "name": "authUrl", "kind": 1024, "kindString": "Property", @@ -867,7 +979,7 @@ } }, { - "id": 141, + "id": 152, "name": "changedAccessToken", "kind": 1024, "kindString": "Property", @@ -888,7 +1000,7 @@ } }, { - "id": 136, + "id": 147, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -906,21 +1018,21 @@ "type": { "type": "reflection", "declaration": { - "id": 137, + "id": 148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 138, + "id": 149, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 139, + "id": 150, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -944,7 +1056,7 @@ } }, { - "id": 140, + "id": 151, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -979,7 +1091,7 @@ } }, { - "id": 133, + "id": 144, "name": "functionsUrl", "kind": 1024, "kindString": "Property", @@ -999,7 +1111,7 @@ } }, { - "id": 142, + "id": 156, "name": "headers", "kind": 1024, "kindString": "Property", @@ -1009,7 +1121,7 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 55, + "line": 56, "character": 12 } ], @@ -1031,7 +1143,7 @@ } }, { - "id": 129, + "id": 140, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -1051,7 +1163,7 @@ } }, { - "id": 130, + "id": 141, "name": "realtimeUrl", "kind": 1024, "kindString": "Property", @@ -1071,7 +1183,7 @@ } }, { - "id": 134, + "id": 145, "name": "rest", "kind": 1024, "kindString": "Property", @@ -1090,50 +1202,18 @@ "typeArguments": [ { "type": "reference", - "id": 122, + "id": 133, "name": "Database" }, { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 123, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 122, - "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" - } + "type": "reference", + "id": 135, + "name": "Schema" } ], "qualifiedName": "PostgrestClient", @@ -1142,7 +1222,7 @@ } }, { - "id": 135, + "id": 146, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -1162,7 +1242,7 @@ } }, { - "id": 132, + "id": 143, "name": "storageUrl", "kind": 1024, "kindString": "Property", @@ -1182,7 +1262,7 @@ } }, { - "id": 144, + "id": 158, "name": "supabaseKey", "kind": 1024, "kindString": "Property", @@ -1195,7 +1275,7 @@ } }, { - "id": 143, + "id": 157, "name": "supabaseUrl", "kind": 1024, "kindString": "Property", @@ -1208,7 +1288,7 @@ } }, { - "id": 145, + "id": 159, "name": "functions", "kind": 262144, "kindString": "Accessor", @@ -1216,13 +1296,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 118, + "line": 139, "character": 6 } ], "getSignature": [ { - "id": 146, + "id": 160, "name": "functions", "kind": 524288, "kindString": "Get signature", @@ -1240,7 +1320,7 @@ ] }, { - "id": 147, + "id": 161, "name": "storage", "kind": 262144, "kindString": "Accessor", @@ -1248,13 +1328,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 128, + "line": 149, "character": 6 } ], "getSignature": [ { - "id": 148, + "id": 162, "name": "storage", "kind": 524288, "kindString": "Get signature", @@ -1272,7 +1352,7 @@ ] }, { - "id": 186, + "id": 200, "name": "_getAccessToken", "kind": 2048, "kindString": "Method", @@ -1282,13 +1362,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 246, + "line": 269, "character": 16 } ], "signatures": [ { - "id": 187, + "id": 201, "name": "_getAccessToken", "kind": 4096, "kindString": "Call signature", @@ -1318,7 +1398,7 @@ ] }, { - "id": 203, + "id": 217, "name": "_handleTokenChanged", "kind": 2048, "kindString": "Method", @@ -1328,20 +1408,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 297, + "line": 329, "character": 10 } ], "signatures": [ { - "id": 204, + "id": 218, "name": "_handleTokenChanged", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 205, + "id": 219, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -1354,7 +1434,7 @@ } }, { - "id": 206, + "id": 220, "name": "source", "kind": 32768, "kindString": "Parameter", @@ -1374,7 +1454,7 @@ } }, { - "id": 207, + "id": 221, "name": "token", "kind": 32768, "kindString": "Parameter", @@ -1395,7 +1475,7 @@ ] }, { - "id": 197, + "id": 211, "name": "_initRealtimeClient", "kind": 2048, "kindString": "Method", @@ -1405,20 +1485,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 283, + "line": 315, "character": 10 } ], "signatures": [ { - "id": 198, + "id": 212, "name": "_initRealtimeClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 199, + "id": 213, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -1441,7 +1521,7 @@ ] }, { - "id": 188, + "id": 202, "name": "_initSupabaseAuthClient", "kind": 2048, "kindString": "Method", @@ -1451,20 +1531,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 252, + "line": 279, "character": 10 } ], "signatures": [ { - "id": 189, + "id": 203, "name": "_initSupabaseAuthClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 190, + "id": 204, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -1496,7 +1576,7 @@ } }, { - "id": 191, + "id": 205, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -1521,7 +1601,7 @@ } }, { - "id": 192, + "id": 206, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -1531,21 +1611,21 @@ "type": { "type": "reflection", "declaration": { - "id": 193, + "id": 207, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 194, + "id": 208, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 209, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1569,7 +1649,7 @@ } }, { - "id": 196, + "id": 210, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1612,7 +1692,7 @@ ] }, { - "id": 200, + "id": 214, "name": "_listenForAuthEvents", "kind": 2048, "kindString": "Method", @@ -1622,13 +1702,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 290, + "line": 322, "character": 10 } ], "signatures": [ { - "id": 201, + "id": 215, "name": "_listenForAuthEvents", "kind": 4096, "kindString": "Call signature", @@ -1636,7 +1716,7 @@ "type": { "type": "reflection", "declaration": { - "id": 202, + "id": 216, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1647,7 +1727,7 @@ ] }, { - "id": 175, + "id": 189, "name": "channel", "kind": 2048, "kindString": "Method", @@ -1655,13 +1735,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 218, + "line": 241, "character": 2 } ], "signatures": [ { - "id": 176, + "id": 190, "name": "channel", "kind": 4096, "kindString": "Call signature", @@ -1671,7 +1751,7 @@ }, "parameters": [ { - "id": 177, + "id": 191, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -1685,7 +1765,7 @@ } }, { - "id": 178, + "id": 192, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -1712,7 +1792,7 @@ ] }, { - "id": 149, + "id": 163, "name": "from", "kind": 2048, "kindString": "Method", @@ -1720,13 +1800,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 133, + "line": 154, "character": 2 } ], "signatures": [ { - "id": 150, + "id": 164, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1736,7 +1816,7 @@ }, "typeParameter": [ { - "id": 151, + "id": 165, "name": "TableName", "kind": 131072, "kindString": "Type parameter", @@ -1747,21 +1827,21 @@ } }, { - "id": 152, + "id": 166, "name": "Table", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 91, + "id": 100, "name": "GenericTable" } } ], "parameters": [ { - "id": 153, + "id": 167, "name": "relation", "kind": 32768, "kindString": "Parameter", @@ -1771,7 +1851,7 @@ }, "type": { "type": "reference", - "id": 151, + "id": 165, "name": "TableName", "dereferenced": {} } @@ -1782,30 +1862,30 @@ "typeArguments": [ { "type": "reference", - "id": 124, + "id": 135, "name": "Schema" }, { "type": "reference", - "id": 152, + "id": 166, "name": "Table" }, { "type": "reference", - "id": 151, + "id": 165, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 152, + "id": 166, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { - "id": 154, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1830,7 +1910,7 @@ } }, { - "id": 155, + "id": 169, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1840,7 +1920,7 @@ }, "typeParameter": [ { - "id": 156, + "id": 170, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", @@ -1851,21 +1931,21 @@ } }, { - "id": 157, + "id": 171, "name": "View", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 100, + "id": 111, "name": "GenericView" } } ], "parameters": [ { - "id": 158, + "id": 172, "name": "relation", "kind": 32768, "kindString": "Parameter", @@ -1875,7 +1955,7 @@ }, "type": { "type": "reference", - "id": 156, + "id": 170, "name": "ViewName", "dereferenced": {} } @@ -1886,30 +1966,30 @@ "typeArguments": [ { "type": "reference", - "id": 124, + "id": 135, "name": "Schema" }, { "type": "reference", - "id": 157, + "id": 171, "name": "View" }, { "type": "reference", - "id": 156, + "id": 170, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 157, + "id": 171, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { - "id": 159, + "id": 173, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1936,7 +2016,7 @@ ] }, { - "id": 179, + "id": 193, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -1944,13 +2024,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 225, + "line": 248, "character": 2 } ], "signatures": [ { - "id": 180, + "id": 194, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -1971,7 +2051,7 @@ ] }, { - "id": 184, + "id": 198, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -1979,13 +2059,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 242, + "line": 265, "character": 2 } ], "signatures": [ { - "id": 185, + "id": 199, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -2025,7 +2105,7 @@ ] }, { - "id": 181, + "id": 195, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -2033,13 +2113,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 235, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 182, + "id": 196, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -2049,7 +2129,7 @@ }, "parameters": [ { - "id": 183, + "id": 197, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -2094,7 +2174,7 @@ ] }, { - "id": 164, + "id": 178, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -2102,13 +2182,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 191, + "line": 212, "character": 2 } ], "signatures": [ { - "id": 165, + "id": 179, "name": "rpc", "kind": 4096, "kindString": "Call signature", @@ -2118,7 +2198,7 @@ }, "typeParameter": [ { - "id": 166, + "id": 180, "name": "FnName", "kind": 131072, "kindString": "Type parameter", @@ -2129,21 +2209,21 @@ } }, { - "id": 167, + "id": 181, "name": "Fn", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 101, + "id": 112, "name": "GenericFunction" } } ], "parameters": [ { - "id": 168, + "id": 182, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -2153,13 +2233,13 @@ }, "type": { "type": "reference", - "id": 166, + "id": 180, "name": "FnName", "dereferenced": {} } }, { - "id": 169, + "id": 183, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -2175,14 +2255,14 @@ }, "objectType": { "type": "reference", - "id": 167, + "id": 181, "name": "Fn" } }, "defaultValue": "{}" }, { - "id": 170, + "id": 184, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -2193,14 +2273,14 @@ "type": { "type": "reflection", "declaration": { - "id": 171, + "id": 185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 174, + "id": 188, "name": "count", "kind": 1024, "kindString": "Property", @@ -2213,7 +2293,7 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 197, + "line": 218, "character": 6 } ], @@ -2236,7 +2316,7 @@ } }, { - "id": 173, + "id": 187, "name": "get", "kind": 1024, "kindString": "Property", @@ -2249,7 +2329,7 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 196, + "line": 217, "character": 6 } ], @@ -2259,7 +2339,7 @@ } }, { - "id": 172, + "id": 186, "name": "head", "kind": 1024, "kindString": "Property", @@ -2272,7 +2352,7 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 195, + "line": 216, "character": 6 } ], @@ -2286,7 +2366,7 @@ { "title": "Properties", "kind": 1024, - "children": [174, 173, 172] + "children": [188, 187, 186] } ] } @@ -2299,7 +2379,7 @@ "typeArguments": [ { "type": "reference", - "id": 124, + "id": 135, "name": "Schema" }, { @@ -2312,7 +2392,7 @@ }, "objectType": { "type": "reference", - "id": 167, + "id": 181, "name": "Fn" } }, @@ -2388,17 +2468,18 @@ }, "objectType": { "type": "reference", - "id": 167, + "id": 181, "name": "Fn" } }, { - "type": "intrinsic", - "name": "unknown" + "type": "reference", + "id": 180, + "name": "FnName" }, { - "type": "intrinsic", - "name": "unknown" + "type": "literal", + "value": null } ], "qualifiedName": "PostgrestFilterBuilder", @@ -2409,7 +2490,7 @@ ] }, { - "id": 160, + "id": 174, "name": "schema", "kind": 2048, "kindString": "Method", @@ -2417,13 +2498,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 157, + "line": 178, "character": 2 } ], "signatures": [ { - "id": 161, + "id": 175, "name": "schema", "kind": 4096, "kindString": "Call signature", @@ -2434,7 +2515,7 @@ }, "typeParameter": [ { - "id": 162, + "id": 176, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", @@ -2447,7 +2528,7 @@ ], "parameters": [ { - "id": 163, + "id": 177, "name": "schema", "kind": 32768, "kindString": "Parameter", @@ -2457,7 +2538,7 @@ }, "type": { "type": "reference", - "id": 162, + "id": 176, "name": "DynamicSchema", "dereferenced": {} } @@ -2468,12 +2549,12 @@ "typeArguments": [ { "type": "reference", - "id": 122, + "id": 133, "name": "Database" }, { "type": "reference", - "id": 162, + "id": 176, "name": "DynamicSchema" }, { @@ -2482,18 +2563,18 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 162, + "id": 176, "name": "DynamicSchema" }, "objectType": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, "extendsType": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "trueType": { @@ -2525,22 +2606,22 @@ { "title": "Constructors", "kind": 512, - "children": [120] + "children": [131] }, { "title": "Properties", "kind": 1024, - "children": [128, 131, 141, 136, 133, 142, 129, 130, 134, 135, 132, 144, 143] + "children": [153, 139, 142, 152, 147, 144, 156, 140, 141, 145, 146, 143, 158, 157] }, { "title": "Accessors", "kind": 262144, - "children": [145, 147] + "children": [159, 161] }, { "title": "Methods", "kind": 2048, - "children": [186, 203, 197, 188, 200, 175, 149, 179, 184, 181, 164, 160] + "children": [200, 217, 211, 202, 214, 189, 163, 193, 198, 195, 178, 174] } ], "sources": [ @@ -2552,7 +2633,7 @@ ], "typeParameter": [ { - "id": 208, + "id": 222, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -2563,7 +2644,7 @@ } }, { - "id": 209, + "id": 223, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -2580,7 +2661,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } } @@ -2597,7 +2678,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, @@ -2617,7 +2698,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } } @@ -2626,14 +2707,14 @@ } }, { - "id": 210, + "id": 224, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "default": { @@ -2642,30 +2723,30 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, "extendsType": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, @@ -2769,7 +2850,7 @@ "flags": {}, "type": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "default": { @@ -2789,7 +2870,7 @@ }, "extendsType": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "trueType": { @@ -2867,7 +2948,7 @@ ], "typeParameter": [ { - "id": 90, + "id": 92, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -3191,7 +3272,7 @@ ], "type": { "type": "reference", - "id": 90, + "id": 92, "name": "SchemaName", "dereferenced": {} } @@ -3363,6 +3444,56 @@ "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } + }, + { + "id": 90, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "signatures": [ + { + "id": 91, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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 client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", + "text": "When 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.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -3370,6 +3501,11 @@ "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] + }, + { + "title": "Methods", + "kind": 2048, + "children": [90] } ], "sources": [ @@ -3387,7 +3523,7 @@ ], "type": { "type": "reference", - "id": 119, + "id": 130, "typeArguments": [ { "type": "reference", @@ -3415,12 +3551,12 @@ { "title": "References", "kind": 16777216, - "children": [213, 214, 212, 211] + "children": [227, 228, 226, 225] }, { "title": "Classes", "kind": 128, - "children": [119] + "children": [130] }, { "title": "Functions", @@ -4297,7 +4433,7 @@ ], "typeParameter": [ { - "id": 90, + "id": 92, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -4621,7 +4757,7 @@ ], "type": { "type": "reference", - "id": 90, + "id": 92, "name": "SchemaName", "dereferenced": {} } @@ -4793,6 +4929,56 @@ "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } + }, + { + "id": 90, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "signatures": [ + { + "id": 91, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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 client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", + "text": "When 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.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -4800,6 +4986,11 @@ "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] + }, + { + "title": "Methods", + "kind": 2048, + "children": [90] } ], "sources": [ @@ -4845,7 +5036,7 @@ ], "typeParameter": [ { - "id": 90, + "id": 92, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -5169,7 +5360,7 @@ ], "type": { "type": "reference", - "id": 90, + "id": 92, "name": "SchemaName", "dereferenced": {} } @@ -5341,6 +5532,56 @@ "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } + }, + { + "id": 90, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "signatures": [ + { + "id": 91, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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 client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", + "text": "When 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.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -5348,6 +5589,11 @@ "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] + }, + { + "title": "Methods", + "kind": 2048, + "children": [90] } ], "sources": [ @@ -5365,15 +5611,23 @@ ], "type": { "type": "reference", - "id": 70, "typeArguments": [ { "type": "reference", - "id": 62, - "name": "SchemaName" + "id": 70, + "typeArguments": [ + { + "type": "reference", + "id": 62, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" } ], - "name": "SupabaseClientOptions" + "qualifiedName": "Required", + "package": "typescript", + "name": "Required" } } ] @@ -5540,7 +5794,7 @@ } }, { - "id": 101, + "id": 112, "name": "GenericFunction", "kind": 4194304, "kindString": "Type alias", @@ -5548,25 +5802,246 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 85, + "line": 107, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 102, + "id": 113, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 103, + "id": 114, "name": "Args", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 115, + "name": "Returns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 109, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [114, 115] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 107, + "character": 30 + } + ] + } + } + }, + { + "id": 107, + "name": "GenericNonUpdatableView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 108, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 110, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 102, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 93, + "name": "GenericRelationship" + } + } + }, + { + "id": 109, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 101, + "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": [110, 109] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, + "character": 38 + } + ] + } + } + }, + { + "id": 93, + "name": "GenericRelationship", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 83, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 94, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 96, + "name": "columns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 85, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 95, + "name": "foreignKeyName", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 84, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 97, + "name": "isOneToOne", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", @@ -5574,6 +6049,288 @@ "character": 2 } ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 99, + "name": "referencedColumns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 98, + "name": "referencedRelation", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 87, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [96, 95, 97, 99, 98] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 83, + "character": 34 + } + ] + } + } + }, + { + "id": 116, + "name": "GenericSchema", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 112, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 117, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 120, + "name": "Functions", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 112, + "name": "GenericFunction" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 118, + "name": "Tables", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 100, + "name": "GenericTable" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 119, + "name": "Views", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 114, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 111, + "name": "GenericView" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [120, 118, 119] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 112, + "character": 28 + } + ] + } + } + }, + { + "id": 100, + "name": "GenericTable", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 91, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 101, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 103, + "name": "Insert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 93, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 105, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 95, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 93, + "name": "GenericRelationship" + } + } + }, + { + "id": 102, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 92, + "character": 2 + } + ], "type": { "type": "reference", "typeArguments": [ @@ -5593,327 +6350,6 @@ }, { "id": 104, - "name": "Returns", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [103, 104] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 85, - "character": 30 - } - ] - } - } - }, - { - "id": 97, - "name": "GenericNonUpdatableView", - "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": 99, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 80, - "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": [99] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 38 - } - ] - } - } - }, - { - "id": 105, - "name": "GenericSchema", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 90, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 106, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 109, - "name": "Functions", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 101, - "name": "GenericFunction" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 107, - "name": "Tables", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 91, - "name": "GenericTable" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 108, - "name": "Views", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 100, - "name": "GenericView" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [109, 107, 108] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 90, - "character": 28 - } - ] - } - } - }, - { - "id": 91, - "name": "GenericTable", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 92, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 94, - "name": "Insert", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 93, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 95, "name": "Update", "kind": 1024, "kindString": "Property", @@ -5921,7 +6357,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 94, "character": 2 } ], @@ -5947,13 +6383,13 @@ { "title": "Properties", "kind": 1024, - "children": [94, 93, 95] + "children": [103, 105, 102, 104] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 71, + "line": 91, "character": 27 } ] @@ -5961,7 +6397,7 @@ } }, { - "id": 96, + "id": 106, "name": "GenericUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -5969,18 +6405,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 77, + "line": 98, "character": 12 } ], "type": { "type": "reference", - "id": 91, + "id": 100, "name": "GenericTable" } }, { - "id": 100, + "id": 111, "name": "GenericView", "kind": 4194304, "kindString": "Type alias", @@ -5988,7 +6424,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 83, + "line": 105, "character": 12 } ], @@ -5996,7 +6432,7 @@ "type": "union", "types": [ { - "id": 96, + "id": 106, "name": "GenericUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -6004,18 +6440,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 77, + "line": 98, "character": 12 } ], "type": { "type": "reference", - "id": 91, + "id": 100, "name": "GenericTable" } }, { - "id": 97, + "id": 107, "name": "GenericNonUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -6023,21 +6459,43 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 79, + "line": 100, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 98, + "id": 108, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 99, + "id": 110, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 102, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 93, + "name": "GenericRelationship" + } + } + }, + { + "id": 109, "name": "Row", "kind": 1024, "kindString": "Property", @@ -6045,7 +6503,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, + "line": 101, "character": 2 } ], @@ -6071,13 +6529,13 @@ { "title": "Properties", "kind": 1024, - "children": [99] + "children": [110, 109] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 79, + "line": 100, "character": 38 } ] @@ -6088,7 +6546,7 @@ } }, { - "id": 112, + "id": 123, "name": "QueryData", "kind": 4194304, "kindString": "Type alias", @@ -6096,13 +6554,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, + "line": 122, "character": 12 } ], "typeParameter": [ { - "id": 115, + "id": 126, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6113,7 +6571,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 115, + "id": 126, "name": "T" }, "extendsType": { @@ -6122,14 +6580,14 @@ { "type": "reflection", "declaration": { - "id": 113, + "id": 124, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 114, + "id": 125, "name": "data", "kind": 1024, "kindString": "Property", @@ -6137,7 +6595,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, + "line": 122, "character": 51 } ], @@ -6151,13 +6609,13 @@ { "title": "Properties", "kind": 1024, - "children": [114] + "children": [125] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, + "line": 122, "character": 49 } ] @@ -6191,7 +6649,7 @@ } }, { - "id": 116, + "id": 127, "name": "QueryError", "kind": 4194304, "kindString": "Type alias", @@ -6199,7 +6657,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 101, + "line": 123, "character": 12 } ], @@ -6211,7 +6669,7 @@ } }, { - "id": 110, + "id": 121, "name": "QueryResult", "kind": 4194304, "kindString": "Type alias", @@ -6222,13 +6680,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 99, + "line": 121, "character": 12 } ], "typeParameter": [ { - "id": 111, + "id": 122, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6239,7 +6697,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 111, + "id": 122, "name": "T" }, "extendsType": { @@ -6279,7 +6737,7 @@ ], "typeParameter": [ { - "id": 90, + "id": 92, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -6603,7 +7061,7 @@ ], "type": { "type": "reference", - "id": 90, + "id": 92, "name": "SchemaName", "dereferenced": {} } @@ -6775,6 +7233,56 @@ "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } + }, + { + "id": 90, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "signatures": [ + { + "id": 91, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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 client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", + "text": "When 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.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -6782,6 +7290,11 @@ "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] + }, + { + "title": "Methods", + "kind": 2048, + "children": [90] } ], "sources": [ @@ -6804,7 +7317,7 @@ { "title": "Type Aliases", "kind": 4194304, - "children": [69, 101, 97, 105, 91, 96, 100, 112, 116, 110, 70] + "children": [69, 112, 107, 93, 116, 100, 106, 111, 123, 127, 121, 70] } ], "sources": [ @@ -6816,14 +7329,14 @@ ] }, { - "id": 117, + "id": 128, "name": "lib/version", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 118, + "id": 129, "name": "version", "kind": 32, "kindString": "Variable", @@ -6848,7 +7361,7 @@ { "title": "Variables", "kind": 32, - "children": [118] + "children": [129] } ], "sources": [ @@ -6864,7 +7377,7 @@ { "title": "Modules", "kind": 2, - "children": [1, 10, 24, 53, 67, 117] + "children": [1, 10, 24, 53, 67, 128] } ] }, @@ -6877,14 +7390,14 @@ "originalName": "", "children": [ { - "id": 1065, + "id": 1121, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1066, + "id": 1122, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -6892,20 +7405,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 21, + "line": 33, "character": 2 } ], "signatures": [ { - "id": 1067, + "id": 1123, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1068, + "id": 1124, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -6916,7 +7429,7 @@ } }, { - "id": 1069, + "id": 1125, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -6925,36 +7438,113 @@ "type": "intrinsic", "name": "number" } + }, + { + "id": 1126, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } } ], "type": { "type": "reference", - "id": 1065, + "id": 1121, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 1060, + "id": 1113, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1059, + "id": 1112, "name": "AuthError.constructor" } }, { - "id": 1070, + "id": 1128, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1129, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1117, + "name": "AuthError.code" + } + }, + { + "id": 1127, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 19, + "line": 31, "character": 2 } ], @@ -6964,151 +7554,47 @@ }, "overwrites": { "type": "reference", - "id": 1063, + "id": 1119, "name": "AuthError.status" } - }, - { - "id": 1071, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 27, - "character": 2 - } - ], - "signatures": [ - { - "id": 1072, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1073, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1075, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 30, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1074, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 29, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1076, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 31, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1075, 1074, 1076] - } - ] - } - } - } - ] } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1066] + "children": [1122] }, { "title": "Properties", "kind": 1024, - "children": [1070] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1071] + "children": [1128, 1127] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 18, + "line": 30, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] }, { - "id": 1058, + "id": 1111, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1059, + "id": 1112, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -7116,20 +7602,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 7, + "line": 18, "character": 2 } ], "signatures": [ { - "id": 1060, + "id": 1113, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1061, + "id": 1114, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -7140,7 +7626,7 @@ } }, { - "id": 1062, + "id": 1115, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -7151,11 +7637,24 @@ "type": "intrinsic", "name": "number" } + }, + { + "id": 1116, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" }, "overwrites": { @@ -7170,15 +7669,67 @@ } }, { - "id": 1063, + "id": 1117, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1118, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + } + }, + { + "id": 1119, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 4, + "line": 14, "character": 2 } ], @@ -7201,18 +7752,18 @@ { "title": "Constructors", "kind": 512, - "children": [1059] + "children": [1112] }, { "title": "Properties", "kind": 1024, - "children": [1063] + "children": [1117, 1119] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 3, + "line": 4, "character": 13 } ], @@ -7227,30 +7778,30 @@ "extendedBy": [ { "type": "reference", - "id": 1065, + "id": 1121, "name": "AuthApiError" }, { "type": "reference", - "id": 1078, + "id": 1131, "name": "AuthUnknownError" }, { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1138, + "id": 1178, "name": "AuthImplicitGrantRedirectError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1139, + "id": 1179, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -7258,20 +7809,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 88, + "line": 90, "character": 2 } ], "signatures": [ { - "id": 1140, + "id": 1180, "name": "new AuthImplicitGrantRedirectError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1141, + "id": 1181, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -7282,7 +7833,7 @@ } }, { - "id": 1142, + "id": 1182, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -7297,14 +7848,14 @@ { "type": "reflection", "declaration": { - "id": 1143, + "id": 1183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1145, + "id": 1185, "name": "code", "kind": 1024, "kindString": "Property", @@ -7312,7 +7863,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 88, + "line": 90, "character": 57 } ], @@ -7322,7 +7873,7 @@ } }, { - "id": 1144, + "id": 1184, "name": "error", "kind": 1024, "kindString": "Property", @@ -7330,7 +7881,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 88, + "line": 90, "character": 42 } ], @@ -7344,7 +7895,7 @@ { "title": "Properties", "kind": 1024, - "children": [1145, 1144] + "children": [1185, 1184] } ] } @@ -7356,24 +7907,78 @@ ], "type": { "type": "reference", - "id": 1138, + "id": 1178, "name": "AuthImplicitGrantRedirectError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1146, + "id": 1202, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1203, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1186, "name": "details", "kind": 1024, "kindString": "Property", @@ -7381,7 +7986,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 2 } ], @@ -7395,14 +8000,14 @@ { "type": "reflection", "declaration": { - "id": 1147, + "id": 1187, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1149, + "id": 1189, "name": "code", "kind": 1024, "kindString": "Property", @@ -7410,7 +8015,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 28 } ], @@ -7420,7 +8025,7 @@ } }, { - "id": 1148, + "id": 1188, "name": "error", "kind": 1024, "kindString": "Property", @@ -7428,7 +8033,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 13 } ], @@ -7442,7 +8047,7 @@ { "title": "Properties", "kind": 1024, - "children": [1149, 1148] + "children": [1189, 1188] } ] } @@ -7452,7 +8057,7 @@ "defaultValue": "null" }, { - "id": 1160, + "id": 1200, "name": "name", "kind": 1024, "kindString": "Property", @@ -7460,7 +8065,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -7470,20 +8075,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1161, + "id": 1201, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -7493,12 +8101,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } }, { - "id": 1150, + "id": 1190, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -7506,13 +8114,13 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 93, + "line": 95, "character": 2 } ], "signatures": [ { - "id": 1151, + "id": 1191, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -7520,14 +8128,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1152, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1156, + "id": 1196, "name": "details", "kind": 1024, "kindString": "Property", @@ -7535,7 +8143,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 98, + "line": 100, "character": 6 } ], @@ -7549,14 +8157,14 @@ { "type": "reflection", "declaration": { - "id": 1157, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1159, + "id": 1199, "name": "code", "kind": 1024, "kindString": "Property", @@ -7564,7 +8172,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 28 } ], @@ -7574,7 +8182,7 @@ } }, { - "id": 1158, + "id": 1198, "name": "error", "kind": 1024, "kindString": "Property", @@ -7582,7 +8190,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 13 } ], @@ -7596,7 +8204,7 @@ { "title": "Properties", "kind": 1024, - "children": [1159, 1158] + "children": [1199, 1198] } ] } @@ -7606,7 +8214,7 @@ "defaultValue": "..." }, { - "id": 1154, + "id": 1194, "name": "message", "kind": 1024, "kindString": "Property", @@ -7614,7 +8222,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 96, + "line": 98, "character": 6 } ], @@ -7625,30 +8233,11 @@ "defaultValue": "..." }, { - "id": 1153, + "id": 1193, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 95, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1155, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", @@ -7656,6 +8245,25 @@ "character": 6 } ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1195, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 99, + "character": 6 + } + ], "type": { "type": "intrinsic", "name": "number" @@ -7667,66 +8275,56 @@ { "title": "Properties", "kind": 1024, - "children": [1156, 1154, 1153, 1155] + "children": [1196, 1194, 1193, 1195] } ] } - }, - "overwrites": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" } } - ], - "overwrites": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } + ] } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1139] + "children": [1179] }, { "title": "Properties", "kind": 1024, - "children": [1146, 1160, 1161] + "children": [1202, 1186, 1200, 1201] }, { "title": "Methods", "kind": 2048, - "children": [1150] + "children": [1190] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 86, + "line": 88, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1125, + "id": 1169, "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1126, + "id": 1170, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -7734,20 +8332,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 81, + "line": 83, "character": 2 } ], "signatures": [ { - "id": 1127, + "id": 1171, "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1128, + "id": 1172, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -7760,24 +8358,78 @@ ], "type": { "type": "reference", - "id": 1125, + "id": 1169, "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1129, + "id": 1175, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1176, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1173, "name": "name", "kind": 1024, "kindString": "Property", @@ -7785,7 +8437,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -7795,20 +8447,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1130, + "id": 1174, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -7818,161 +8473,47 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } - }, - { - "id": 1131, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1132, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1135, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1134, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1136, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1135, 1134, 1136] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1126] + "children": [1170] }, { "title": "Properties", "kind": 1024, - "children": [1129, 1130] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1131] + "children": [1175, 1173, 1174] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 80, + "line": 82, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1113, + "id": 1161, "name": "AuthInvalidTokenResponseError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1114, + "id": 1162, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -7980,37 +8521,91 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 75, + "line": 77, "character": 2 } ], "signatures": [ { - "id": 1115, + "id": 1163, "name": "new AuthInvalidTokenResponseError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1113, + "id": 1161, "name": "AuthInvalidTokenResponseError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1116, + "id": 1166, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1167, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1164, "name": "name", "kind": 1024, "kindString": "Property", @@ -8018,7 +8613,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -8028,20 +8623,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1117, + "id": 1165, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -8051,161 +8649,47 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } - }, - { - "id": 1118, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1119, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1120, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1122, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1121, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1123, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1122, 1121, 1123] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1114] + "children": [1162] }, { "title": "Properties", "kind": 1024, - "children": [1116, 1117] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1118] + "children": [1166, 1164, 1165] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 74, + "line": 76, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1163, + "id": 1205, "name": "AuthPKCEGrantCodeExchangeError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1164, + "id": 1206, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -8213,20 +8697,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 105, + "line": 114, "character": 2 } ], "signatures": [ { - "id": 1165, + "id": 1207, "name": "new AuthPKCEGrantCodeExchangeError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1166, + "id": 1208, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -8237,7 +8721,7 @@ } }, { - "id": 1167, + "id": 1209, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -8252,14 +8736,14 @@ { "type": "reflection", "declaration": { - "id": 1168, + "id": 1210, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1170, + "id": 1212, "name": "code", "kind": 1024, "kindString": "Property", @@ -8267,7 +8751,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 105, + "line": 114, "character": 57 } ], @@ -8277,7 +8761,7 @@ } }, { - "id": 1169, + "id": 1211, "name": "error", "kind": 1024, "kindString": "Property", @@ -8285,7 +8769,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 105, + "line": 114, "character": 42 } ], @@ -8299,7 +8783,7 @@ { "title": "Properties", "kind": 1024, - "children": [1170, 1169] + "children": [1212, 1211] } ] } @@ -8311,24 +8795,78 @@ ], "type": { "type": "reference", - "id": 1163, + "id": 1205, "name": "AuthPKCEGrantCodeExchangeError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1171, + "id": 1229, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1230, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1213, "name": "details", "kind": 1024, "kindString": "Property", @@ -8336,7 +8874,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 2 } ], @@ -8350,14 +8888,14 @@ { "type": "reflection", "declaration": { - "id": 1172, + "id": 1214, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1174, + "id": 1216, "name": "code", "kind": 1024, "kindString": "Property", @@ -8365,7 +8903,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 28 } ], @@ -8375,7 +8913,7 @@ } }, { - "id": 1173, + "id": 1215, "name": "error", "kind": 1024, "kindString": "Property", @@ -8383,7 +8921,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 13 } ], @@ -8397,7 +8935,7 @@ { "title": "Properties", "kind": 1024, - "children": [1174, 1173] + "children": [1216, 1215] } ] } @@ -8407,7 +8945,7 @@ "defaultValue": "null" }, { - "id": 1185, + "id": 1227, "name": "name", "kind": 1024, "kindString": "Property", @@ -8415,7 +8953,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -8425,20 +8963,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1186, + "id": 1228, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -8448,12 +8989,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } }, { - "id": 1175, + "id": 1217, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -8461,13 +9002,13 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 110, + "line": 119, "character": 2 } ], "signatures": [ { - "id": 1176, + "id": 1218, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -8475,14 +9016,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1177, + "id": 1219, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1181, + "id": 1223, "name": "details", "kind": 1024, "kindString": "Property", @@ -8490,7 +9031,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 115, + "line": 124, "character": 6 } ], @@ -8504,14 +9045,14 @@ { "type": "reflection", "declaration": { - "id": 1182, + "id": 1224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1184, + "id": 1226, "name": "code", "kind": 1024, "kindString": "Property", @@ -8519,7 +9060,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 28 } ], @@ -8529,7 +9070,7 @@ } }, { - "id": 1183, + "id": 1225, "name": "error", "kind": 1024, "kindString": "Property", @@ -8537,7 +9078,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 13 } ], @@ -8551,7 +9092,7 @@ { "title": "Properties", "kind": 1024, - "children": [1184, 1183] + "children": [1226, 1225] } ] } @@ -8561,7 +9102,7 @@ "defaultValue": "..." }, { - "id": 1179, + "id": 1221, "name": "message", "kind": 1024, "kindString": "Property", @@ -8569,7 +9110,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 113, + "line": 122, "character": 6 } ], @@ -8580,7 +9121,7 @@ "defaultValue": "..." }, { - "id": 1178, + "id": 1220, "name": "name", "kind": 1024, "kindString": "Property", @@ -8588,7 +9129,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 112, + "line": 121, "character": 6 } ], @@ -8599,7 +9140,7 @@ "defaultValue": "..." }, { - "id": 1180, + "id": 1222, "name": "status", "kind": 1024, "kindString": "Property", @@ -8607,7 +9148,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 114, + "line": 123, "character": 6 } ], @@ -8622,66 +9163,56 @@ { "title": "Properties", "kind": 1024, - "children": [1181, 1179, 1178, 1180] + "children": [1223, 1221, 1220, 1222] } ] } - }, - "overwrites": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" } } - ], - "overwrites": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } + ] } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1164] + "children": [1206] }, { "title": "Properties", "kind": 1024, - "children": [1171, 1185, 1186] + "children": [1229, 1213, 1227, 1228] }, { "title": "Methods", "kind": 2048, - "children": [1175] + "children": [1217] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 103, + "line": 111, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1188, + "id": 1232, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1189, + "id": 1233, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -8689,20 +9220,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 121, + "line": 130, "character": 2 } ], "signatures": [ { - "id": 1190, + "id": 1234, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1191, + "id": 1235, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -8713,7 +9244,7 @@ } }, { - "id": 1192, + "id": 1236, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -8726,24 +9257,78 @@ ], "type": { "type": "reference", - "id": 1188, + "id": 1232, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1193, + "id": 1239, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1240, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1237, "name": "name", "kind": 1024, "kindString": "Property", @@ -8751,7 +9336,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -8761,20 +9346,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1194, + "id": 1238, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -8784,161 +9372,47 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } - }, - { - "id": 1195, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1196, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1197, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1199, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1198, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1200, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1199, 1198, 1200] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1189] + "children": [1233] }, { "title": "Properties", "kind": 1024, - "children": [1193, 1194] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1195] + "children": [1239, 1237, 1238] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 120, + "line": 129, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1101, + "id": 1153, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1102, + "id": 1154, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -8946,37 +9420,91 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 69, + "line": 67, "character": 2 } ], "signatures": [ { - "id": 1103, + "id": 1155, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1101, + "id": 1153, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1104, + "id": 1158, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1159, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1156, "name": "name", "kind": 1024, "kindString": "Property", @@ -8984,7 +9512,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -8994,20 +9522,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1105, + "id": 1157, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -9017,161 +9548,47 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } - }, - { - "id": 1106, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1107, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1110, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1109, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1111, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1110, 1109, 1111] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1102] + "children": [1154] }, { "title": "Properties", "kind": 1024, - "children": [1104, 1105] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1106] + "children": [1158, 1156, 1157] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 68, + "line": 66, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1078, + "id": 1131, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1079, + "id": 1132, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -9179,20 +9596,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 43, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 1080, + "id": 1133, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1081, + "id": 1134, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -9203,7 +9620,7 @@ } }, { - "id": 1082, + "id": 1135, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -9216,24 +9633,78 @@ ], "type": { "type": "reference", - "id": 1078, + "id": 1131, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 1060, + "id": 1113, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1059, + "id": 1112, "name": "AuthError.constructor" } }, { - "id": 1083, + "id": 1137, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1138, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1117, + "name": "AuthError.code" + } + }, + { + "id": 1136, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -9241,7 +9712,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 41, + "line": 46, "character": 2 } ], @@ -9251,15 +9722,18 @@ } }, { - "id": 1084, + "id": 1139, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 4, + "line": 14, "character": 2 } ], @@ -9278,7 +9752,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1063, + "id": 1119, "name": "AuthError.status" } } @@ -9287,31 +9761,31 @@ { "title": "Constructors", "kind": 512, - "children": [1079] + "children": [1132] }, { "title": "Properties", "kind": 1024, - "children": [1083, 1084] + "children": [1137, 1136, 1139] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 40, + "line": 45, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] }, { - "id": 1202, + "id": 1242, "name": "AuthWeakPasswordError", "kind": 128, "kindString": "Class", @@ -9321,7 +9795,7 @@ }, "children": [ { - "id": 1203, + "id": 1243, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -9329,20 +9803,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 141, + "line": 150, "character": 2 } ], "signatures": [ { - "id": 1204, + "id": 1244, "name": "new AuthWeakPasswordError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1205, + "id": 1245, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -9353,7 +9827,7 @@ } }, { - "id": 1206, + "id": 1246, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -9364,7 +9838,7 @@ } }, { - "id": 1207, + "id": 1247, "name": "reasons", "kind": 32768, "kindString": "Parameter", @@ -9380,24 +9854,78 @@ ], "type": { "type": "reference", - "id": 1202, + "id": 1242, "name": "AuthWeakPasswordError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1209, + "id": 1251, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1252, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1249, "name": "name", "kind": 1024, "kindString": "Property", @@ -9405,7 +9933,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -9415,12 +9943,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1208, + "id": 1248, "name": "reasons", "kind": 1024, "kindString": "Property", @@ -9431,28 +9959,32 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 139, + "line": 148, "character": 2 } ], "type": { "type": "array", "elementType": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "id": 526, + "name": "WeakPasswordReasons" } } }, { - "id": 1210, + "id": 1250, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -9462,15 +9994,50 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1243] }, { - "id": 1211, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", + "title": "Properties", + "kind": 1024, + "children": [1251, 1249, 1248, 1250] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 144, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1141, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1141, + "name": "CustomAuthError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1142, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, "sources": [ { @@ -9481,163 +10048,14 @@ ], "signatures": [ { - "id": 1212, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1213, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1215, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1214, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1216, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1215, 1214, 1216] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1203] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1209, 1208, 1210] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1211] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 135, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1086, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1086, - "name": "CustomAuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1087, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 2 - } - ], - "signatures": [ - { - "id": 1088, + "id": 1143, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1089, + "id": 1144, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -9648,7 +10066,7 @@ } }, { - "id": 1090, + "id": 1145, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -9659,7 +10077,7 @@ } }, { - "id": 1091, + "id": 1146, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -9668,28 +10086,102 @@ "type": "intrinsic", "name": "number" } + }, + { + "id": 1147, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } } ], "type": { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 1060, + "id": 1113, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1059, + "id": 1112, "name": "AuthError.constructor" } }, { - "id": 1092, + "id": 1150, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1151, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1117, + "name": "AuthError.code" + } + }, + { + "id": 1148, "name": "name", "kind": 1024, "kindString": "Property", @@ -9697,7 +10189,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -9711,15 +10203,18 @@ } }, { - "id": 1093, + "id": 1149, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -9729,175 +10224,71 @@ }, "overwrites": { "type": "reference", - "id": 1063, + "id": 1119, "name": "AuthError.status" } - }, - { - "id": 1094, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1095, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1096, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1098, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1097, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1099, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1098, 1097, 1099] - } - ] - } - } - } - ] } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1087] + "children": [1142] }, { "title": "Properties", "kind": 1024, - "children": [1092, 1093] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1094] + "children": [1150, 1148, 1149] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 50, + "line": 55, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 1101, + "id": 1153, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 1113, + "id": 1161, "name": "AuthInvalidTokenResponseError" }, { "type": "reference", - "id": 1125, + "id": 1169, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 1138, + "id": 1178, "name": "AuthImplicitGrantRedirectError" }, { "type": "reference", - "id": 1163, + "id": 1205, "name": "AuthPKCEGrantCodeExchangeError" }, { "type": "reference", - "id": 1188, + "id": 1232, "name": "AuthRetryableFetchError" }, { "type": "reference", - "id": 1202, + "id": 1242, "name": "AuthWeakPasswordError" } ] @@ -10140,10 +10531,10 @@ ], "type": { "type": "reference", - "id": 1012, + "id": 1021, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 1012, + "id": 1021, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -10159,14 +10550,14 @@ }, "children": [ { - "id": 1016, + "id": 1025, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1017, + "id": 1026, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -10186,17 +10577,17 @@ }, "parameters": [ { - "id": 1018, + "id": 1027, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -10212,21 +10603,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1028, + "line": 1015, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 997, + "id": 1006, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 998, + "id": 1007, "name": "id", "kind": 1024, "kindString": "Property", @@ -10237,7 +10628,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1030, + "line": 1017, "character": 2 } ], @@ -10247,7 +10638,7 @@ } }, { - "id": 999, + "id": 1008, "name": "userId", "kind": 1024, "kindString": "Property", @@ -10258,7 +10649,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1033, + "line": 1020, "character": 2 } ], @@ -10272,13 +10663,13 @@ { "title": "Properties", "kind": 1024, - "children": [998, 999] + "children": [1007, 1008] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1028, + "line": 1015, "character": 45 } ] @@ -10293,7 +10684,7 @@ "typeArguments": [ { "type": "reference", - "id": 987, + "id": 996, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -10305,14 +10696,14 @@ ] }, { - "id": 1013, + "id": 1022, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1014, + "id": 1023, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -10322,17 +10713,17 @@ }, "parameters": [ { - "id": 1015, + "id": 1024, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -10348,21 +10739,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1039, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1010, + "id": 1019, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1011, + "id": 1020, "name": "userId", "kind": 1024, "kindString": "Property", @@ -10373,7 +10764,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1054, + "line": 1041, "character": 2 } ], @@ -10387,13 +10778,13 @@ { "title": "Properties", "kind": 1024, - "children": [1011] + "children": [1020] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1039, "character": 44 } ] @@ -10408,7 +10799,7 @@ "typeArguments": [ { "type": "reference", - "id": 1000, + "id": 1009, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -10424,13 +10815,13 @@ { "title": "Methods", "kind": 2048, - "children": [1016, 1013] + "children": [1025, 1022] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1062, + "line": 1049, "character": 17 } ] @@ -10469,17 +10860,17 @@ "flags": {}, "type": { "type": "reference", - "id": 685, + "id": 705, "name": "AdminUserAttributes", "dereferenced": { - "id": 685, + "id": 705, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 687, + "id": 707, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -10493,7 +10884,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 398, + "line": 404, "character": 2 } ], @@ -10503,7 +10894,7 @@ } }, { - "id": 690, + "id": 710, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -10517,7 +10908,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 424, + "line": 430, "character": 2 } ], @@ -10527,7 +10918,7 @@ } }, { - "id": 694, + "id": 717, "name": "email", "kind": 1024, "kindString": "Property", @@ -10540,7 +10931,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -10554,7 +10945,7 @@ } }, { - "id": 688, + "id": 708, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -10568,7 +10959,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 411, "character": 2 } ], @@ -10578,7 +10969,31 @@ } }, { - "id": 693, + "id": 713, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `id` for the user.", + "text": "Allows you to overwrite the default `id` set for the user.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 455, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 715, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -10592,7 +11007,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -10606,7 +11021,7 @@ } }, { - "id": 692, + "id": 714, "name": "password", "kind": 1024, "kindString": "Property", @@ -10619,7 +11034,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -10633,7 +11048,31 @@ } }, { - "id": 695, + "id": 712, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `password_hash` for the user's password.", + "text": "Allows 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.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 716, "name": "phone", "kind": 1024, "kindString": "Property", @@ -10646,7 +11085,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -10660,7 +11099,7 @@ } }, { - "id": 689, + "id": 709, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -10674,7 +11113,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 412, + "line": 418, "character": 2 } ], @@ -10684,7 +11123,7 @@ } }, { - "id": 691, + "id": 711, "name": "role", "kind": 1024, "kindString": "Property", @@ -10698,7 +11137,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 439, "character": 2 } ], @@ -10708,7 +11147,7 @@ } }, { - "id": 686, + "id": 706, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -10722,7 +11161,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 388, + "line": 394, "character": 2 } ], @@ -10736,13 +11175,15 @@ { "title": "Properties", "kind": 1024, - "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] + "children": [ + 707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 377, + "line": 383, "character": 17 } ], @@ -10752,7 +11193,7 @@ "typeArguments": [ { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes" }, { @@ -10774,7 +11215,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -10830,7 +11271,7 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If true, then the user will be soft-deleted (setting `deleted_at` to the current timestamp and disabling their account while preserving their data) from the auth schema.\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.\n" + "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.\n" }, "type": { "type": "intrinsic", @@ -10844,7 +11285,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -10887,10 +11328,10 @@ "flags": {}, "type": { "type": "reference", - "id": 855, + "id": 876, "name": "GenerateLinkParams", "dereferenced": { - "id": 855, + "id": 876, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -10898,7 +11339,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 733, + "line": 751, "character": 12 } ], @@ -10906,7 +11347,7 @@ "type": "union", "types": [ { - "id": 830, + "id": 851, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -10914,21 +11355,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 831, + "id": 852, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 854, "name": "email", "kind": 1024, "kindString": "Property", @@ -10936,7 +11377,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 692, + "line": 710, "character": 2 } ], @@ -10946,7 +11387,7 @@ } }, { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -10956,7 +11397,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 694, + "line": 712, "character": 2 } ], @@ -10965,7 +11406,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -10988,7 +11429,7 @@ } }, { - "id": 834, + "id": 855, "name": "password", "kind": 1024, "kindString": "Property", @@ -10996,7 +11437,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 693, + "line": 711, "character": 2 } ], @@ -11006,7 +11447,7 @@ } }, { - "id": 832, + "id": 853, "name": "type", "kind": 1024, "kindString": "Property", @@ -11014,7 +11455,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 691, + "line": 709, "character": 2 } ], @@ -11028,13 +11469,13 @@ { "title": "Properties", "kind": 1024, - "children": [833, 835, 834, 832] + "children": [854, 856, 855, 853] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 39 } ] @@ -11042,7 +11483,7 @@ } }, { - "id": 836, + "id": 857, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -11050,21 +11491,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 837, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 839, + "id": 860, "name": "email", "kind": 1024, "kindString": "Property", @@ -11075,7 +11516,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 700, + "line": 718, "character": 2 } ], @@ -11085,7 +11526,7 @@ } }, { - "id": 840, + "id": 861, "name": "options", "kind": 1024, "kindString": "Property", @@ -11095,7 +11536,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 701, + "line": 719, "character": 2 } ], @@ -11104,7 +11545,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -11127,7 +11568,7 @@ } }, { - "id": 838, + "id": 859, "name": "type", "kind": 1024, "kindString": "Property", @@ -11135,7 +11576,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 698, + "line": 716, "character": 2 } ], @@ -11158,13 +11599,13 @@ { "title": "Properties", "kind": 1024, - "children": [839, 840, 838] + "children": [860, 861, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 46 } ] @@ -11172,7 +11613,7 @@ } }, { - "id": 841, + "id": 862, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -11180,21 +11621,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "email", "kind": 1024, "kindString": "Property", @@ -11205,7 +11646,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 707, + "line": 725, "character": 2 } ], @@ -11215,7 +11656,7 @@ } }, { - "id": 845, + "id": 866, "name": "options", "kind": 1024, "kindString": "Property", @@ -11225,7 +11666,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 708, + "line": 726, "character": 2 } ], @@ -11234,7 +11675,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -11248,7 +11689,7 @@ } }, { - "id": 843, + "id": 864, "name": "type", "kind": 1024, "kindString": "Property", @@ -11256,7 +11697,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 705, + "line": 723, "character": 2 } ], @@ -11270,13 +11711,13 @@ { "title": "Properties", "kind": 1024, - "children": [844, 845, 843] + "children": [865, 866, 864] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 41 } ] @@ -11284,7 +11725,7 @@ } }, { - "id": 846, + "id": 867, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -11292,21 +11733,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 847, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 849, + "id": 870, "name": "email", "kind": 1024, "kindString": "Property", @@ -11317,7 +11758,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 714, + "line": 732, "character": 2 } ], @@ -11327,7 +11768,7 @@ } }, { - "id": 850, + "id": 871, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -11338,7 +11779,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 718, + "line": 736, "character": 2 } ], @@ -11348,7 +11789,7 @@ } }, { - "id": 851, + "id": 872, "name": "options", "kind": 1024, "kindString": "Property", @@ -11358,7 +11799,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 719, + "line": 737, "character": 2 } ], @@ -11367,7 +11808,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -11381,7 +11822,7 @@ } }, { - "id": 848, + "id": 869, "name": "type", "kind": 1024, "kindString": "Property", @@ -11389,7 +11830,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 712, + "line": 730, "character": 2 } ], @@ -11412,13 +11853,13 @@ { "title": "Properties", "kind": 1024, - "children": [849, 850, 851, 848] + "children": [870, 871, 872, 869] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 44 } ] @@ -11436,7 +11877,7 @@ "typeArguments": [ { "type": "reference", - "id": 856, + "id": 877, "name": "GenerateLinkResponse" } ], @@ -11491,7 +11932,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -11622,7 +12063,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -11671,10 +12112,10 @@ }, "type": { "type": "reference", - "id": 1039, + "id": 1048, "name": "PageParams", "dereferenced": { - "id": 1039, + "id": 1048, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -11682,21 +12123,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1040, + "id": 1049, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1050, "name": "page", "kind": 1024, "kindString": "Property", @@ -11709,7 +12150,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1123, + "line": 1110, "character": 2 } ], @@ -11719,7 +12160,7 @@ } }, { - "id": 1042, + "id": 1051, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -11732,7 +12173,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1125, + "line": 1112, "character": 2 } ], @@ -11746,13 +12187,13 @@ { "title": "Properties", "kind": 1024, - "children": [1041, 1042] + "children": [1050, 1051] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 25 } ] @@ -11837,7 +12278,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } } @@ -11854,7 +12295,7 @@ }, { "type": "reference", - "id": 1032, + "id": 1041, "name": "Pagination" } ] @@ -11962,7 +12403,7 @@ ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -12105,7 +12546,7 @@ }, { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] @@ -12175,17 +12616,17 @@ }, "type": { "type": "reference", - "id": 685, + "id": 705, "name": "AdminUserAttributes", "dereferenced": { - "id": 685, + "id": 705, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 687, + "id": 707, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -12199,7 +12640,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 398, + "line": 404, "character": 2 } ], @@ -12209,7 +12650,7 @@ } }, { - "id": 690, + "id": 710, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -12223,7 +12664,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 424, + "line": 430, "character": 2 } ], @@ -12233,7 +12674,7 @@ } }, { - "id": 694, + "id": 717, "name": "email", "kind": 1024, "kindString": "Property", @@ -12246,7 +12687,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -12260,7 +12701,7 @@ } }, { - "id": 688, + "id": 708, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -12274,7 +12715,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 411, "character": 2 } ], @@ -12284,7 +12725,31 @@ } }, { - "id": 693, + "id": 713, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `id` for the user.", + "text": "Allows you to overwrite the default `id` set for the user.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 455, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 715, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -12298,7 +12763,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -12312,7 +12777,7 @@ } }, { - "id": 692, + "id": 714, "name": "password", "kind": 1024, "kindString": "Property", @@ -12325,7 +12790,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -12339,7 +12804,31 @@ } }, { - "id": 695, + "id": 712, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `password_hash` for the user's password.", + "text": "Allows 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.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 716, "name": "phone", "kind": 1024, "kindString": "Property", @@ -12352,7 +12841,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -12366,7 +12855,7 @@ } }, { - "id": 689, + "id": 709, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -12380,7 +12869,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 412, + "line": 418, "character": 2 } ], @@ -12390,7 +12879,7 @@ } }, { - "id": 691, + "id": 711, "name": "role", "kind": 1024, "kindString": "Property", @@ -12404,7 +12893,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 439, "character": 2 } ], @@ -12414,7 +12903,7 @@ } }, { - "id": 686, + "id": 706, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -12428,7 +12917,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 388, + "line": 394, "character": 2 } ], @@ -12442,13 +12931,15 @@ { "title": "Properties", "kind": 1024, - "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] + "children": [ + 707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 377, + "line": 383, "character": 17 } ], @@ -12458,7 +12949,7 @@ "typeArguments": [ { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes" }, { @@ -12480,7 +12971,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -12533,7 +13024,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 175, + "line": 182, "character": 2 } ], @@ -12556,10 +13047,10 @@ "flags": {}, "type": { "type": "reference", - "id": 490, + "id": 505, "name": "GoTrueClientOptions", "dereferenced": { - "id": 490, + "id": 505, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -12567,21 +13058,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 491, + "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 499, + "id": 514, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -12591,7 +13082,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 66, + "line": 67, "character": 2 } ], @@ -12601,7 +13092,7 @@ } }, { - "id": 504, + "id": 519, "name": "debug", "kind": 1024, "kindString": "Property", @@ -12611,7 +13102,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 76, + "line": 77, "character": 2 } ], @@ -12625,7 +13116,7 @@ { "type": "reflection", "declaration": { - "id": 505, + "id": 520, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -12633,20 +13124,20 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 76, + "line": 77, "character": 21 } ], "signatures": [ { - "id": 506, + "id": 521, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 522, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -12657,7 +13148,7 @@ } }, { - "id": 508, + "id": 523, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -12685,7 +13176,7 @@ } }, { - "id": 498, + "id": 513, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -12695,7 +13186,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 65, "character": 2 } ], @@ -12705,7 +13196,7 @@ } }, { - "id": 502, + "id": 517, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -12715,7 +13206,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 72, + "line": 73, "character": 2 } ], @@ -12725,7 +13216,7 @@ } }, { - "id": 503, + "id": 518, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -12735,16 +13226,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 75, "character": 2 } ], "type": { "type": "reference", - "id": 759, + "id": 779, "name": "AuthFlowType", "dereferenced": { - "id": 759, + "id": 779, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -12752,7 +13243,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 565, + "line": 583, "character": 12 } ], @@ -12773,7 +13264,36 @@ } }, { - "id": 493, + "id": 525, + "name": "hasCustomAuthorizationHeader", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set to \"true\" if there is a custom authorization header set globally.", + "tags": [ + { + "tag": "experimental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 508, "name": "headers", "kind": 1024, "kindString": "Property", @@ -12783,14 +13303,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 61, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 494, + "id": 509, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -12798,19 +13318,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 61, "character": 12 } ], "indexSignature": { - "id": 495, + "id": 510, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 496, + "id": 511, "name": "key", "kind": 32768, "flags": {}, @@ -12829,7 +13349,7 @@ } }, { - "id": 509, + "id": 524, "name": "lock", "kind": 1024, "kindString": "Property", @@ -12848,16 +13368,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 83, "character": 2 } ], "type": { "type": "reference", - "id": 481, + "id": 496, "name": "LockFunc", "dereferenced": { - "id": 481, + "id": 496, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -12865,14 +13385,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 482, + "id": 497, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -12880,13 +13400,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 23 } ], "signatures": [ { - "id": 483, + "id": 498, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -12902,7 +13422,7 @@ }, "typeParameter": [ { - "id": 489, + "id": 504, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -12911,7 +13431,7 @@ ], "parameters": [ { - "id": 484, + "id": 499, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -12925,7 +13445,7 @@ } }, { - "id": 485, + "id": 500, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -12939,7 +13459,7 @@ } }, { - "id": 486, + "id": 501, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -12950,7 +13470,7 @@ "type": { "type": "reflection", "declaration": { - "id": 487, + "id": 502, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -12958,13 +13478,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 69 } ], "signatures": [ { - "id": 488, + "id": 503, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -12974,7 +13494,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -12993,7 +13513,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -13009,7 +13529,7 @@ } }, { - "id": 500, + "id": 515, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -13019,7 +13539,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 68, + "line": 69, "character": 2 } ], @@ -13029,7 +13549,7 @@ } }, { - "id": 501, + "id": 516, "name": "storage", "kind": 1024, "kindString": "Property", @@ -13039,16 +13559,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 71, "character": 2 } ], "type": { "type": "reference", - "id": 1019, + "id": 1028, "name": "SupportedStorage", "dereferenced": { - "id": 1019, + "id": 1028, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -13056,7 +13576,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1089, + "line": 1076, "character": 12 } ], @@ -13103,14 +13623,14 @@ { "type": "reflection", "declaration": { - "id": 1020, + "id": 1029, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1021, + "id": 1030, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -13123,7 +13643,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1099, + "line": 1086, "character": 2 } ], @@ -13137,13 +13657,13 @@ { "title": "Properties", "kind": 1024, - "children": [1021] + "children": [1030] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1091, + "line": 1078, "character": 4 } ] @@ -13155,7 +13675,7 @@ } }, { - "id": 497, + "id": 512, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -13165,7 +13685,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 62, + "line": 63, "character": 2 } ], @@ -13175,7 +13695,7 @@ } }, { - "id": 492, + "id": 507, "name": "url", "kind": 1024, "kindString": "Property", @@ -13185,7 +13705,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, + "line": 59, "character": 2 } ], @@ -13200,14 +13720,14 @@ "title": "Properties", "kind": 1024, "children": [ - 499, 504, 498, 502, 503, 493, 509, 500, 501, 497, 492 + 514, 519, 513, 517, 518, 525, 508, 524, 515, 516, 512, 507 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 34 } ] @@ -13237,7 +13757,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 125, + "line": 132, "character": 2 } ], @@ -13483,10 +14003,10 @@ ], "type": { "type": "reference", - "id": 1012, + "id": 1021, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 1012, + "id": 1021, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -13502,14 +14022,14 @@ }, "children": [ { - "id": 1016, + "id": 1025, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1017, + "id": 1026, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -13529,17 +14049,17 @@ }, "parameters": [ { - "id": 1018, + "id": 1027, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -13555,21 +14075,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1028, + "line": 1015, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 997, + "id": 1006, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 998, + "id": 1007, "name": "id", "kind": 1024, "kindString": "Property", @@ -13580,7 +14100,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1030, + "line": 1017, "character": 2 } ], @@ -13590,7 +14110,7 @@ } }, { - "id": 999, + "id": 1008, "name": "userId", "kind": 1024, "kindString": "Property", @@ -13601,7 +14121,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1033, + "line": 1020, "character": 2 } ], @@ -13615,13 +14135,13 @@ { "title": "Properties", "kind": 1024, - "children": [998, 999] + "children": [1007, 1008] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1028, + "line": 1015, "character": 45 } ] @@ -13636,7 +14156,7 @@ "typeArguments": [ { "type": "reference", - "id": 987, + "id": 996, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -13648,14 +14168,14 @@ ] }, { - "id": 1013, + "id": 1022, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1014, + "id": 1023, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -13665,17 +14185,17 @@ }, "parameters": [ { - "id": 1015, + "id": 1024, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -13691,21 +14211,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1039, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1010, + "id": 1019, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1011, + "id": 1020, "name": "userId", "kind": 1024, "kindString": "Property", @@ -13716,7 +14236,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1054, + "line": 1041, "character": 2 } ], @@ -13730,13 +14250,13 @@ { "title": "Properties", "kind": 1024, - "children": [1011] + "children": [1020] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1039, "character": 44 } ] @@ -13751,7 +14271,7 @@ "typeArguments": [ { "type": "reference", - "id": 1000, + "id": 1009, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -13767,13 +14287,13 @@ { "title": "Methods", "kind": 2048, - "children": [1016, 1013] + "children": [1025, 1022] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1062, + "line": 1049, "character": 17 } ] @@ -13812,17 +14332,17 @@ "flags": {}, "type": { "type": "reference", - "id": 685, + "id": 705, "name": "AdminUserAttributes", "dereferenced": { - "id": 685, + "id": 705, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 687, + "id": 707, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -13836,7 +14356,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 398, + "line": 404, "character": 2 } ], @@ -13846,7 +14366,7 @@ } }, { - "id": 690, + "id": 710, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -13860,7 +14380,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 424, + "line": 430, "character": 2 } ], @@ -13870,7 +14390,7 @@ } }, { - "id": 694, + "id": 717, "name": "email", "kind": 1024, "kindString": "Property", @@ -13883,7 +14403,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -13897,7 +14417,7 @@ } }, { - "id": 688, + "id": 708, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -13911,7 +14431,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 411, "character": 2 } ], @@ -13921,7 +14441,31 @@ } }, { - "id": 693, + "id": 713, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `id` for the user.", + "text": "Allows you to overwrite the default `id` set for the user.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 455, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 715, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -13935,7 +14479,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -13949,7 +14493,7 @@ } }, { - "id": 692, + "id": 714, "name": "password", "kind": 1024, "kindString": "Property", @@ -13962,7 +14506,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -13976,7 +14520,31 @@ } }, { - "id": 695, + "id": 712, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `password_hash` for the user's password.", + "text": "Allows 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.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 716, "name": "phone", "kind": 1024, "kindString": "Property", @@ -13989,7 +14557,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -14003,7 +14571,7 @@ } }, { - "id": 689, + "id": 709, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -14017,7 +14585,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 412, + "line": 418, "character": 2 } ], @@ -14027,7 +14595,7 @@ } }, { - "id": 691, + "id": 711, "name": "role", "kind": 1024, "kindString": "Property", @@ -14041,7 +14609,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 439, "character": 2 } ], @@ -14051,7 +14619,7 @@ } }, { - "id": 686, + "id": 706, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -14065,7 +14633,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 388, + "line": 394, "character": 2 } ], @@ -14079,13 +14647,15 @@ { "title": "Properties", "kind": 1024, - "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] + "children": [ + 707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 377, + "line": 383, "character": 17 } ], @@ -14095,7 +14665,7 @@ "typeArguments": [ { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes" }, { @@ -14117,7 +14687,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -14173,7 +14743,7 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If true, then the user will be soft-deleted (setting `deleted_at` to the current timestamp and disabling their account while preserving their data) from the auth schema.\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.\n" + "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.\n" }, "type": { "type": "intrinsic", @@ -14187,7 +14757,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -14230,10 +14800,10 @@ "flags": {}, "type": { "type": "reference", - "id": 855, + "id": 876, "name": "GenerateLinkParams", "dereferenced": { - "id": 855, + "id": 876, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -14241,7 +14811,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 733, + "line": 751, "character": 12 } ], @@ -14249,7 +14819,7 @@ "type": "union", "types": [ { - "id": 830, + "id": 851, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -14257,21 +14827,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 831, + "id": 852, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 854, "name": "email", "kind": 1024, "kindString": "Property", @@ -14279,7 +14849,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 692, + "line": 710, "character": 2 } ], @@ -14289,7 +14859,7 @@ } }, { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -14299,7 +14869,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 694, + "line": 712, "character": 2 } ], @@ -14308,7 +14878,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -14331,7 +14901,7 @@ } }, { - "id": 834, + "id": 855, "name": "password", "kind": 1024, "kindString": "Property", @@ -14339,7 +14909,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 693, + "line": 711, "character": 2 } ], @@ -14349,7 +14919,7 @@ } }, { - "id": 832, + "id": 853, "name": "type", "kind": 1024, "kindString": "Property", @@ -14357,7 +14927,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 691, + "line": 709, "character": 2 } ], @@ -14371,13 +14941,13 @@ { "title": "Properties", "kind": 1024, - "children": [833, 835, 834, 832] + "children": [854, 856, 855, 853] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 39 } ] @@ -14385,7 +14955,7 @@ } }, { - "id": 836, + "id": 857, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -14393,21 +14963,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 837, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 839, + "id": 860, "name": "email", "kind": 1024, "kindString": "Property", @@ -14418,7 +14988,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 700, + "line": 718, "character": 2 } ], @@ -14428,7 +14998,7 @@ } }, { - "id": 840, + "id": 861, "name": "options", "kind": 1024, "kindString": "Property", @@ -14438,7 +15008,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 701, + "line": 719, "character": 2 } ], @@ -14447,7 +15017,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -14470,7 +15040,7 @@ } }, { - "id": 838, + "id": 859, "name": "type", "kind": 1024, "kindString": "Property", @@ -14478,7 +15048,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 698, + "line": 716, "character": 2 } ], @@ -14501,13 +15071,13 @@ { "title": "Properties", "kind": 1024, - "children": [839, 840, 838] + "children": [860, 861, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 46 } ] @@ -14515,7 +15085,7 @@ } }, { - "id": 841, + "id": 862, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -14523,21 +15093,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "email", "kind": 1024, "kindString": "Property", @@ -14548,7 +15118,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 707, + "line": 725, "character": 2 } ], @@ -14558,7 +15128,7 @@ } }, { - "id": 845, + "id": 866, "name": "options", "kind": 1024, "kindString": "Property", @@ -14568,7 +15138,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 708, + "line": 726, "character": 2 } ], @@ -14577,7 +15147,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -14591,7 +15161,7 @@ } }, { - "id": 843, + "id": 864, "name": "type", "kind": 1024, "kindString": "Property", @@ -14599,7 +15169,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 705, + "line": 723, "character": 2 } ], @@ -14613,13 +15183,13 @@ { "title": "Properties", "kind": 1024, - "children": [844, 845, 843] + "children": [865, 866, 864] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 41 } ] @@ -14627,7 +15197,7 @@ } }, { - "id": 846, + "id": 867, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -14635,21 +15205,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 847, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 849, + "id": 870, "name": "email", "kind": 1024, "kindString": "Property", @@ -14660,7 +15230,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 714, + "line": 732, "character": 2 } ], @@ -14670,7 +15240,7 @@ } }, { - "id": 850, + "id": 871, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -14681,7 +15251,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 718, + "line": 736, "character": 2 } ], @@ -14691,7 +15261,7 @@ } }, { - "id": 851, + "id": 872, "name": "options", "kind": 1024, "kindString": "Property", @@ -14701,7 +15271,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 719, + "line": 737, "character": 2 } ], @@ -14710,7 +15280,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -14724,7 +15294,7 @@ } }, { - "id": 848, + "id": 869, "name": "type", "kind": 1024, "kindString": "Property", @@ -14732,7 +15302,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 712, + "line": 730, "character": 2 } ], @@ -14755,13 +15325,13 @@ { "title": "Properties", "kind": 1024, - "children": [849, 850, 851, 848] + "children": [870, 871, 872, 869] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 44 } ] @@ -14779,7 +15349,7 @@ "typeArguments": [ { "type": "reference", - "id": 856, + "id": 877, "name": "GenerateLinkResponse" } ], @@ -14834,7 +15404,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -14965,7 +15535,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -15014,10 +15584,10 @@ }, "type": { "type": "reference", - "id": 1039, + "id": 1048, "name": "PageParams", "dereferenced": { - "id": 1039, + "id": 1048, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -15025,21 +15595,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1040, + "id": 1049, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1050, "name": "page", "kind": 1024, "kindString": "Property", @@ -15052,7 +15622,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1123, + "line": 1110, "character": 2 } ], @@ -15062,7 +15632,7 @@ } }, { - "id": 1042, + "id": 1051, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -15075,7 +15645,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1125, + "line": 1112, "character": 2 } ], @@ -15089,13 +15659,13 @@ { "title": "Properties", "kind": 1024, - "children": [1041, 1042] + "children": [1050, 1051] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 25 } ] @@ -15180,7 +15750,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } } @@ -15197,7 +15767,7 @@ }, { "type": "reference", - "id": 1032, + "id": 1041, "name": "Pagination" } ] @@ -15305,7 +15875,7 @@ ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -15448,7 +16018,7 @@ }, { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] @@ -15518,17 +16088,17 @@ }, "type": { "type": "reference", - "id": 685, + "id": 705, "name": "AdminUserAttributes", "dereferenced": { - "id": 685, + "id": 705, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 687, + "id": 707, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -15542,7 +16112,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 398, + "line": 404, "character": 2 } ], @@ -15552,7 +16122,7 @@ } }, { - "id": 690, + "id": 710, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -15566,7 +16136,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 424, + "line": 430, "character": 2 } ], @@ -15576,7 +16146,7 @@ } }, { - "id": 694, + "id": 717, "name": "email", "kind": 1024, "kindString": "Property", @@ -15589,7 +16159,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -15603,7 +16173,7 @@ } }, { - "id": 688, + "id": 708, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -15617,7 +16187,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 411, "character": 2 } ], @@ -15627,7 +16197,31 @@ } }, { - "id": 693, + "id": 713, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `id` for the user.", + "text": "Allows you to overwrite the default `id` set for the user.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 455, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 715, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -15641,7 +16235,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -15655,7 +16249,7 @@ } }, { - "id": 692, + "id": 714, "name": "password", "kind": 1024, "kindString": "Property", @@ -15668,7 +16262,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -15682,7 +16276,31 @@ } }, { - "id": 695, + "id": 712, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `password_hash` for the user's password.", + "text": "Allows 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.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 716, "name": "phone", "kind": 1024, "kindString": "Property", @@ -15695,7 +16313,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -15709,7 +16327,7 @@ } }, { - "id": 689, + "id": 709, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -15723,7 +16341,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 412, + "line": 418, "character": 2 } ], @@ -15733,7 +16351,7 @@ } }, { - "id": 691, + "id": 711, "name": "role", "kind": 1024, "kindString": "Property", @@ -15747,7 +16365,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 439, "character": 2 } ], @@ -15757,7 +16375,7 @@ } }, { - "id": 686, + "id": 706, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -15771,7 +16389,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 388, + "line": 394, "character": 2 } ], @@ -15785,13 +16403,15 @@ { "title": "Properties", "kind": 1024, - "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] + "children": [ + 707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 377, + "line": 383, "character": 17 } ], @@ -15801,7 +16421,7 @@ "typeArguments": [ { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes" }, { @@ -15823,7 +16443,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -15874,16 +16494,16 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 129, + "line": 136, "character": 2 } ], "type": { "type": "reference", - "id": 967, + "id": 972, "name": "GoTrueMFAApi", "dereferenced": { - "id": 967, + "id": 972, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -15893,14 +16513,14 @@ }, "children": [ { - "id": 971, + "id": 980, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 972, + "id": 981, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -15910,17 +16530,17 @@ }, "parameters": [ { - "id": 973, + "id": 982, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 890, + "id": 907, "name": "MFAChallengeParams", "dereferenced": { - "id": 890, + "id": 907, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -15928,21 +16548,53 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 810, + "line": 821, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 891, + "id": 908, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 892, + "id": 910, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 825, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 909, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -15953,7 +16605,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 812, + "line": 823, "character": 2 } ], @@ -15967,13 +16619,13 @@ { "title": "Properties", "kind": 1024, - "children": [892] + "children": [910, 909] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 810, + "line": 821, "character": 33 } ] @@ -15988,7 +16640,7 @@ "typeArguments": [ { "type": "reference", - "id": 935, + "id": 938, "name": "AuthMFAChallengeResponse" } ], @@ -16000,14 +16652,14 @@ ] }, { - "id": 980, + "id": 989, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 981, + "id": 990, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -16017,17 +16669,17 @@ }, "parameters": [ { - "id": 982, + "id": 991, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 893, + "id": 911, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 893, + "id": 911, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -16035,21 +16687,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 894, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 896, + "id": 914, "name": "code", "kind": 1024, "kindString": "Property", @@ -16060,7 +16712,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 819, + "line": 832, "character": 2 } ], @@ -16070,7 +16722,7 @@ } }, { - "id": 895, + "id": 913, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -16081,7 +16733,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 817, + "line": 830, "character": 2 } ], @@ -16095,13 +16747,13 @@ { "title": "Properties", "kind": 1024, - "children": [896, 895] + "children": [914, 913] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 42 } ] @@ -16116,7 +16768,7 @@ "typeArguments": [ { "type": "reference", - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse" } ], @@ -16128,14 +16780,14 @@ ] }, { - "id": 968, + "id": 973, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 969, + "id": 974, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -16146,39 +16798,39 @@ }, "parameters": [ { - "id": 970, + "id": 975, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 877, - "name": "MFAEnrollParams", + "id": 1055, + "name": "MFAEnrollTOTPParams", "dereferenced": { - "id": 877, - "name": "MFAEnrollParams", + "id": 1055, + "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 785, + "line": 1129, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 878, + "id": 1056, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 879, + "id": 1057, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -16189,7 +16841,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 787, + "line": 1131, "character": 2 } ], @@ -16199,7 +16851,7 @@ } }, { - "id": 881, + "id": 1059, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -16212,7 +16864,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 791, + "line": 1135, "character": 2 } ], @@ -16222,7 +16874,7 @@ } }, { - "id": 880, + "id": 1058, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -16235,7 +16887,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 789, + "line": 1133, "character": 2 } ], @@ -16249,14 +16901,14 @@ { "title": "Properties", "kind": 1024, - "children": [879, 881, 880] + "children": [1057, 1059, 1058] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 785, - "character": 30 + "line": 1129, + "character": 34 } ] } @@ -16270,7 +16922,411 @@ "typeArguments": [ { "type": "reference", - "id": 910, + "id": 1065, + "name": "AuthMFAEnrollTOTPResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + }, + { + "id": 976, + "name": "enroll", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 977, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 1060, + "name": "MFAEnrollPhoneParams", + "dereferenced": { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1081, + "name": "AuthMFAEnrollPhoneResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + }, + { + "id": 978, + "name": "enroll", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 979, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 898, + "name": "MFAEnrollParams", + "dereferenced": { + "id": 898, + "name": "MFAEnrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 803, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "id": 1055, + "name": "MFAEnrollTOTPParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1056, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1057, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1131, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + }, + { + "id": 1059, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1135, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1058, + "name": "issuer", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Domain which the user is enrolled with." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1133, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1057, 1059, 1058] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 34 + } + ] + } + } + }, + { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + } + ] + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 928, "name": "AuthMFAEnrollResponse" } ], @@ -16282,14 +17338,14 @@ ] }, { - "id": 985, + "id": 994, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 986, + "id": 995, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -16303,7 +17359,7 @@ "typeArguments": [ { "type": "reference", - "id": 956, + "id": 961, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -16315,14 +17371,14 @@ ] }, { - "id": 983, + "id": 992, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 984, + "id": 993, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -16349,7 +17405,7 @@ "typeArguments": [ { "type": "reference", - "id": 945, + "id": 949, "name": "AuthMFAListFactorsResponse" } ], @@ -16361,14 +17417,14 @@ ] }, { - "id": 977, + "id": 986, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 978, + "id": 987, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -16378,17 +17434,17 @@ }, "parameters": [ { - "id": 979, + "id": 988, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 882, + "id": 899, "name": "MFAUnenrollParams", "dereferenced": { - "id": 882, + "id": 899, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -16396,21 +17452,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 794, + "line": 805, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 883, + "id": 900, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 884, + "id": 901, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -16421,7 +17477,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 796, + "line": 807, "character": 2 } ], @@ -16435,13 +17491,13 @@ { "title": "Properties", "kind": 1024, - "children": [884] + "children": [901] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 794, + "line": 805, "character": 32 } ] @@ -16456,7 +17512,7 @@ "typeArguments": [ { "type": "reference", - "id": 926, + "id": 929, "name": "AuthMFAUnenrollResponse" } ], @@ -16468,14 +17524,14 @@ ] }, { - "id": 974, + "id": 983, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 975, + "id": 984, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -16485,17 +17541,17 @@ }, "parameters": [ { - "id": 976, + "id": 985, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 885, + "id": 902, "name": "MFAVerifyParams", "dereferenced": { - "id": 885, + "id": 902, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -16503,21 +17559,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 799, + "line": 810, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 886, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 888, + "id": 905, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -16528,7 +17584,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 804, + "line": 815, "character": 2 } ], @@ -16538,7 +17594,7 @@ } }, { - "id": 889, + "id": 906, "name": "code", "kind": 1024, "kindString": "Property", @@ -16549,7 +17605,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 807, + "line": 818, "character": 2 } ], @@ -16559,7 +17615,7 @@ } }, { - "id": 887, + "id": 904, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -16570,7 +17626,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 801, + "line": 812, "character": 2 } ], @@ -16584,13 +17640,13 @@ { "title": "Properties", "kind": 1024, - "children": [888, 889, 887] + "children": [905, 906, 904] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 799, + "line": 810, "character": 30 } ] @@ -16605,7 +17661,7 @@ "typeArguments": [ { "type": "reference", - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse" } ], @@ -16621,13 +17677,13 @@ { "title": "Methods", "kind": 2048, - "children": [971, 980, 968, 985, 983, 977, 974] + "children": [980, 989, 973, 994, 992, 986, 983] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 949, + "line": 934, "character": 17 } ] @@ -16635,7 +17691,7 @@ } }, { - "id": 143, + "id": 144, "name": "exchangeCodeForSession", "kind": 2048, "kindString": "Method", @@ -16643,13 +17699,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 571, + "line": 584, "character": 8 } ], "signatures": [ { - "id": 144, + "id": 145, "name": "exchangeCodeForSession", "kind": 4096, "kindString": "Call signature", @@ -16659,7 +17715,7 @@ }, "parameters": [ { - "id": 145, + "id": 146, "name": "authCode", "kind": 32768, "kindString": "Parameter", @@ -16675,7 +17731,7 @@ "typeArguments": [ { "type": "reference", - "id": 557, + "id": 574, "name": "AuthTokenResponse" } ], @@ -16687,7 +17743,7 @@ ] }, { - "id": 182, + "id": 183, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -16695,13 +17751,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 926, + "line": 935, "character": 8 } ], "signatures": [ { - "id": 183, + "id": 184, "name": "getSession", "kind": 4096, "kindString": "Call signature", @@ -16719,14 +17775,14 @@ { "type": "reflection", "declaration": { - "id": 184, + "id": 185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 185, + "id": 186, "name": "data", "kind": 1024, "kindString": "Property", @@ -16741,14 +17797,14 @@ "type": { "type": "reflection", "declaration": { - "id": 186, + "id": 187, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 187, + "id": 188, "name": "session", "kind": 1024, "kindString": "Property", @@ -16762,7 +17818,7 @@ ], "type": { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } } @@ -16771,14 +17827,14 @@ { "title": "Properties", "kind": 1024, - "children": [187] + "children": [188] } ] } } }, { - "id": 188, + "id": 189, "name": "error", "kind": 1024, "kindString": "Property", @@ -16800,7 +17856,7 @@ { "title": "Properties", "kind": 1024, - "children": [185, 188] + "children": [186, 189] } ] } @@ -16808,14 +17864,14 @@ { "type": "reflection", "declaration": { - "id": 189, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 190, + "id": 191, "name": "data", "kind": 1024, "kindString": "Property", @@ -16830,14 +17886,14 @@ "type": { "type": "reflection", "declaration": { - "id": 191, + "id": 192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 192, + "id": 193, "name": "session", "kind": 1024, "kindString": "Property", @@ -16859,14 +17915,14 @@ { "title": "Properties", "kind": 1024, - "children": [192] + "children": [193] } ] } } }, { - "id": 193, + "id": 194, "name": "error", "kind": 1024, "kindString": "Property", @@ -16880,7 +17936,7 @@ ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -16889,7 +17945,7 @@ { "title": "Properties", "kind": 1024, - "children": [190, 193] + "children": [191, 194] } ] } @@ -16897,14 +17953,14 @@ { "type": "reflection", "declaration": { - "id": 194, + "id": 195, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 195, + "id": 196, "name": "data", "kind": 1024, "kindString": "Property", @@ -16919,14 +17975,14 @@ "type": { "type": "reflection", "declaration": { - "id": 196, + "id": 197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 197, + "id": 198, "name": "session", "kind": 1024, "kindString": "Property", @@ -16948,14 +18004,14 @@ { "title": "Properties", "kind": 1024, - "children": [197] + "children": [198] } ] } } }, { - "id": 198, + "id": 199, "name": "error", "kind": 1024, "kindString": "Property", @@ -16977,7 +18033,7 @@ { "title": "Properties", "kind": 1024, - "children": [195, 198] + "children": [196, 199] } ] } @@ -16993,7 +18049,7 @@ ] }, { - "id": 245, + "id": 246, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -17007,7 +18063,7 @@ ], "signatures": [ { - "id": 246, + "id": 247, "name": "getUser", "kind": 4096, "kindString": "Call signature", @@ -17017,7 +18073,7 @@ }, "parameters": [ { - "id": 247, + "id": 248, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -17038,7 +18094,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -17050,7 +18106,7 @@ ] }, { - "id": 349, + "id": 362, "name": "getUserIdentities", "kind": 2048, "kindString": "Method", @@ -17058,13 +18114,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1710, + "line": 1735, "character": 8 } ], "signatures": [ { - "id": 350, + "id": 363, "name": "getUserIdentities", "kind": 4096, "kindString": "Call signature", @@ -17081,14 +18137,14 @@ { "type": "reflection", "declaration": { - "id": 351, + "id": 364, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 352, + "id": 365, "name": "data", "kind": 1024, "kindString": "Property", @@ -17096,21 +18152,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1712, + "line": 1737, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 353, + "id": 366, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 367, "name": "identities", "kind": 1024, "kindString": "Property", @@ -17118,7 +18174,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1713, + "line": 1738, "character": 10 } ], @@ -17126,7 +18182,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 630, + "id": 648, "name": "UserIdentity" } } @@ -17136,14 +18192,14 @@ { "title": "Properties", "kind": 1024, - "children": [354] + "children": [367] } ] } } }, { - "id": 355, + "id": 368, "name": "error", "kind": 1024, "kindString": "Property", @@ -17151,7 +18207,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1715, + "line": 1740, "character": 8 } ], @@ -17165,7 +18221,7 @@ { "title": "Properties", "kind": 1024, - "children": [352, 355] + "children": [365, 368] } ] } @@ -17173,14 +18229,14 @@ { "type": "reflection", "declaration": { - "id": 356, + "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 370, "name": "data", "kind": 1024, "kindString": "Property", @@ -17188,7 +18244,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1717, + "line": 1742, "character": 8 } ], @@ -17198,7 +18254,7 @@ } }, { - "id": 358, + "id": 371, "name": "error", "kind": 1024, "kindString": "Property", @@ -17206,13 +18262,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1717, + "line": 1742, "character": 20 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -17221,7 +18277,7 @@ { "title": "Properties", "kind": 1024, - "children": [357, 358] + "children": [370, 371] } ] } @@ -17237,7 +18293,7 @@ ] }, { - "id": 127, + "id": 128, "name": "initialize", "kind": 2048, "kindString": "Method", @@ -17245,13 +18301,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 278, + "line": 286, "character": 8 } ], "signatures": [ { - "id": 128, + "id": 129, "name": "initialize", "kind": 4096, "kindString": "Call signature", @@ -17264,7 +18320,7 @@ "typeArguments": [ { "type": "reference", - "id": 1022, + "id": 1031, "name": "InitializeResult" } ], @@ -17276,7 +18332,7 @@ ] }, { - "id": 359, + "id": 372, "name": "linkIdentity", "kind": 2048, "kindString": "Method", @@ -17284,13 +18340,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1734, + "line": 1759, "character": 8 } ], "signatures": [ { - "id": 360, + "id": 373, "name": "linkIdentity", "kind": 4096, "kindString": "Call signature", @@ -17300,17 +18356,17 @@ }, "parameters": [ { - "id": 361, + "id": 374, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -17318,21 +18374,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 761, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 763, + "id": 783, "name": "options", "kind": 1024, "kindString": "Property", @@ -17342,21 +18398,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 764, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 767, + "id": 787, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -17369,14 +18425,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 768, + "id": 788, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -17384,19 +18440,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 18 } ], "indexSignature": { - "id": 769, + "id": 789, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 770, + "id": 790, "name": "key", "kind": 32768, "flags": {}, @@ -17415,7 +18471,7 @@ } }, { - "id": 765, + "id": 785, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -17428,7 +18484,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 571, + "line": 589, "character": 4 } ], @@ -17438,7 +18494,7 @@ } }, { - "id": 766, + "id": 786, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -17451,7 +18507,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 573, + "line": 591, "character": 4 } ], @@ -17461,7 +18517,7 @@ } }, { - "id": 771, + "id": 791, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -17474,7 +18530,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 577, + "line": 595, "character": 4 } ], @@ -17488,13 +18544,13 @@ { "title": "Properties", "kind": 1024, - "children": [767, 765, 766, 771] + "children": [787, 785, 786, 791] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 12 } ] @@ -17502,7 +18558,7 @@ } }, { - "id": 762, + "id": 782, "name": "provider", "kind": 1024, "kindString": "Property", @@ -17513,16 +18569,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 568, + "line": 586, "character": 2 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider", "dereferenced": { - "id": 478, + "id": 493, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -17600,6 +18656,10 @@ "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -17634,13 +18694,13 @@ { "title": "Properties", "kind": 1024, - "children": [763, 762] + "children": [783, 782] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 41 } ] @@ -17655,7 +18715,7 @@ "typeArguments": [ { "type": "reference", - "id": 585, + "id": 602, "name": "OAuthResponse" } ], @@ -17667,7 +18727,7 @@ ] }, { - "id": 321, + "id": 334, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -17675,13 +18735,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1608, + "line": 1633, "character": 2 } ], "signatures": [ { - "id": 322, + "id": 335, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -17691,7 +18751,7 @@ }, "parameters": [ { - "id": 323, + "id": 336, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -17702,33 +18762,33 @@ "type": { "type": "reflection", "declaration": { - "id": 324, + "id": 337, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 325, + "id": 338, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 326, + "id": 339, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 480, + "id": 495, "name": "AuthChangeEvent" } }, { - "id": 327, + "id": 340, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -17742,7 +18802,7 @@ }, { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } ] @@ -17779,14 +18839,14 @@ "type": { "type": "reflection", "declaration": { - "id": 328, + "id": 341, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 329, + "id": 342, "name": "data", "kind": 1024, "kindString": "Property", @@ -17794,21 +18854,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1611, + "line": 1636, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 330, + "id": 343, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 331, + "id": 344, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -17816,23 +18876,23 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1611, + "line": 1636, "character": 12 } ], "type": { "type": "reference", - "id": 696, + "id": 718, "name": "Subscription", "dereferenced": { - "id": 696, + "id": 718, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 697, + "id": 719, "name": "id", "kind": 1024, "kindString": "Property", @@ -17843,7 +18903,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 462, "character": 2 } ], @@ -17853,7 +18913,7 @@ } }, { - "id": 698, + "id": 720, "name": "callback", "kind": 2048, "kindString": "Method", @@ -17861,13 +18921,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 444, + "line": 466, "character": 2 } ], "signatures": [ { - "id": 699, + "id": 721, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -17877,17 +18937,17 @@ }, "parameters": [ { - "id": 700, + "id": 722, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 480, + "id": 495, "name": "AuthChangeEvent", "dereferenced": { - "id": 480, + "id": 495, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -17895,7 +18955,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 30, + "line": 31, "character": 12 } ], @@ -17927,7 +18987,7 @@ "value": "USER_UPDATED" }, { - "id": 479, + "id": 494, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -17935,7 +18995,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 28, + "line": 29, "character": 12 } ], @@ -17950,7 +19010,7 @@ } }, { - "id": 701, + "id": 723, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -17964,7 +19024,7 @@ }, { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } ] @@ -17979,7 +19039,7 @@ ] }, { - "id": 702, + "id": 724, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -17987,13 +19047,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 448, + "line": 470, "character": 2 } ], "signatures": [ { - "id": 703, + "id": 725, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -18013,18 +19073,18 @@ { "title": "Properties", "kind": 1024, - "children": [697] + "children": [719] }, { "title": "Methods", "kind": 2048, - "children": [698, 702] + "children": [720, 724] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 436, + "line": 458, "character": 17 } ] @@ -18036,7 +19096,7 @@ { "title": "Properties", "kind": 1024, - "children": [331] + "children": [344] } ] } @@ -18047,7 +19107,7 @@ { "title": "Properties", "kind": 1024, - "children": [329] + "children": [342] } ] } @@ -18056,7 +19116,7 @@ ] }, { - "id": 175, + "id": 176, "name": "reauthenticate", "kind": 2048, "kindString": "Method", @@ -18064,13 +19124,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 838, + "line": 851, "character": 8 } ], "signatures": [ { - "id": 176, + "id": 177, "name": "reauthenticate", "kind": 4096, "kindString": "Call signature", @@ -18083,7 +19143,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -18095,7 +19155,7 @@ ] }, { - "id": 282, + "id": 283, "name": "refreshSession", "kind": 2048, "kindString": "Method", @@ -18103,13 +19163,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1374, + "line": 1382, "character": 8 } ], "signatures": [ { - "id": 283, + "id": 284, "name": "refreshSession", "kind": 4096, "kindString": "Call signature", @@ -18119,7 +19179,7 @@ }, "parameters": [ { - "id": 284, + "id": 285, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -18132,14 +19192,14 @@ "type": { "type": "reflection", "declaration": { - "id": 285, + "id": 286, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 286, + "id": 287, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -18147,7 +19207,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1374, + "line": 1382, "character": 42 } ], @@ -18161,7 +19221,7 @@ { "title": "Properties", "kind": 1024, - "children": [286] + "children": [287] } ] } @@ -18173,7 +19233,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -18185,7 +19245,7 @@ ] }, { - "id": 179, + "id": 180, "name": "resend", "kind": 2048, "kindString": "Method", @@ -18193,13 +19253,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 873, + "line": 886, "character": 8 } ], "signatures": [ { - "id": 180, + "id": 181, "name": "resend", "kind": 4096, "kindString": "Call signature", @@ -18209,17 +19269,17 @@ }, "parameters": [ { - "id": 181, + "id": 182, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 803, + "id": 824, "name": "ResendParams", "dereferenced": { - "id": 803, + "id": 824, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -18227,7 +19287,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 646, + "line": 664, "character": 12 } ], @@ -18237,14 +19297,14 @@ { "type": "reflection", "declaration": { - "id": 804, + "id": 825, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 806, + "id": 827, "name": "email", "kind": 1024, "kindString": "Property", @@ -18252,7 +19312,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 649, + "line": 667, "character": 6 } ], @@ -18262,7 +19322,7 @@ } }, { - "id": 807, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -18272,21 +19332,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 650, + "line": 668, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 808, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18299,7 +19359,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 654, + "line": 672, "character": 8 } ], @@ -18309,7 +19369,7 @@ } }, { - "id": 809, + "id": 830, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -18322,7 +19382,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 670, "character": 8 } ], @@ -18336,13 +19396,13 @@ { "title": "Properties", "kind": 1024, - "children": [810, 809] + "children": [831, 830] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 650, + "line": 668, "character": 16 } ] @@ -18350,7 +19410,7 @@ } }, { - "id": 805, + "id": 826, "name": "type", "kind": 1024, "kindString": "Property", @@ -18358,7 +19418,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 648, + "line": 666, "character": 6 } ], @@ -18367,7 +19427,7 @@ "typeArguments": [ { "type": "reference", - "id": 802, + "id": 823, "name": "EmailOtpType" }, { @@ -18394,13 +19454,13 @@ { "title": "Properties", "kind": 1024, - "children": [806, 807, 805] + "children": [827, 828, 826] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 647, + "line": 665, "character": 4 } ] @@ -18409,14 +19469,14 @@ { "type": "reflection", "declaration": { - "id": 811, + "id": 832, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 814, + "id": 835, "name": "options", "kind": 1024, "kindString": "Property", @@ -18426,21 +19486,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 660, + "line": 678, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 815, + "id": 836, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 816, + "id": 837, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18453,7 +19513,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 662, + "line": 680, "character": 8 } ], @@ -18467,13 +19527,13 @@ { "title": "Properties", "kind": 1024, - "children": [816] + "children": [837] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 660, + "line": 678, "character": 16 } ] @@ -18481,7 +19541,7 @@ } }, { - "id": 813, + "id": 834, "name": "phone", "kind": 1024, "kindString": "Property", @@ -18489,7 +19549,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 659, + "line": 677, "character": 6 } ], @@ -18499,7 +19559,7 @@ } }, { - "id": 812, + "id": 833, "name": "type", "kind": 1024, "kindString": "Property", @@ -18507,7 +19567,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 658, + "line": 676, "character": 6 } ], @@ -18516,7 +19576,7 @@ "typeArguments": [ { "type": "reference", - "id": 801, + "id": 822, "name": "MobileOtpType" }, { @@ -18543,13 +19603,13 @@ { "title": "Properties", "kind": 1024, - "children": [814, 813, 812] + "children": [835, 834, 833] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 675, "character": 4 } ] @@ -18566,7 +19626,7 @@ "typeArguments": [ { "type": "reference", - "id": 542, + "id": 559, "name": "AuthOtpResponse" } ], @@ -18578,7 +19638,7 @@ ] }, { - "id": 335, + "id": 348, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", @@ -18586,13 +19646,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1664, + "line": 1689, "character": 8 } ], "signatures": [ { - "id": 336, + "id": 349, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", @@ -18602,7 +19662,7 @@ }, "parameters": [ { - "id": 337, + "id": 350, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -18616,7 +19676,7 @@ } }, { - "id": 338, + "id": 351, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -18624,14 +19684,14 @@ "type": { "type": "reflection", "declaration": { - "id": 339, + "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 341, + "id": 354, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18644,7 +19704,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1668, + "line": 1693, "character": 6 } ], @@ -18654,7 +19714,7 @@ } }, { - "id": 340, + "id": 353, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -18667,7 +19727,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1667, + "line": 1692, "character": 6 } ], @@ -18681,7 +19741,7 @@ { "title": "Properties", "kind": 1024, - "children": [341, 340] + "children": [354, 353] } ] } @@ -18698,14 +19758,14 @@ { "type": "reflection", "declaration": { - "id": 342, + "id": 355, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 343, + "id": 356, "name": "data", "kind": 1024, "kindString": "Property", @@ -18713,14 +19773,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1672, + "line": 1697, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 344, + "id": 357, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -18729,7 +19789,7 @@ } }, { - "id": 345, + "id": 358, "name": "error", "kind": 1024, "kindString": "Property", @@ -18737,7 +19797,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1673, + "line": 1698, "character": 8 } ], @@ -18751,7 +19811,7 @@ { "title": "Properties", "kind": 1024, - "children": [343, 345] + "children": [356, 358] } ] } @@ -18759,14 +19819,14 @@ { "type": "reflection", "declaration": { - "id": 346, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 347, + "id": 360, "name": "data", "kind": 1024, "kindString": "Property", @@ -18774,7 +19834,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1675, + "line": 1700, "character": 8 } ], @@ -18784,7 +19844,7 @@ } }, { - "id": 348, + "id": 361, "name": "error", "kind": 1024, "kindString": "Property", @@ -18792,13 +19852,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1675, + "line": 1700, "character": 20 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -18807,7 +19867,7 @@ { "title": "Properties", "kind": 1024, - "children": [347, 348] + "children": [360, 361] } ] } @@ -18823,7 +19883,7 @@ ] }, { - "id": 270, + "id": 271, "name": "setSession", "kind": 2048, "kindString": "Method", @@ -18831,13 +19891,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1299, + "line": 1307, "character": 8 } ], "signatures": [ { - "id": 271, + "id": 272, "name": "setSession", "kind": 4096, "kindString": "Call signature", @@ -18847,7 +19907,7 @@ }, "parameters": [ { - "id": 272, + "id": 273, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -18858,14 +19918,14 @@ "type": { "type": "reflection", "declaration": { - "id": 273, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 274, + "id": 275, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -18873,7 +19933,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1300, + "line": 1308, "character": 4 } ], @@ -18883,7 +19943,7 @@ } }, { - "id": 275, + "id": 276, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -18891,7 +19951,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1301, + "line": 1309, "character": 4 } ], @@ -18905,7 +19965,7 @@ { "title": "Properties", "kind": 1024, - "children": [274, 275] + "children": [275, 276] } ] } @@ -18917,7 +19977,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -18929,7 +19989,7 @@ ] }, { - "id": 131, + "id": 132, "name": "signInAnonymously", "kind": 2048, "kindString": "Method", @@ -18937,13 +19997,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 368, + "line": 389, "character": 8 } ], "signatures": [ { - "id": 132, + "id": 133, "name": "signInAnonymously", "kind": 4096, "kindString": "Call signature", @@ -18954,7 +20014,7 @@ }, "parameters": [ { - "id": 133, + "id": 134, "name": "credentials", "kind": 32768, "kindString": "Parameter", @@ -18963,10 +20023,10 @@ }, "type": { "type": "reference", - "id": 706, + "id": 726, "name": "SignInAnonymouslyCredentials", "dereferenced": { - "id": 706, + "id": 726, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -18974,21 +20034,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 473, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 707, + "id": 727, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 708, + "id": 728, "name": "options", "kind": 1024, "kindString": "Property", @@ -18998,21 +20058,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 456, + "line": 474, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 709, + "id": 729, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 711, + "id": 731, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -19025,7 +20085,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 482, "character": 4 } ], @@ -19035,7 +20095,7 @@ } }, { - "id": 710, + "id": 730, "name": "data", "kind": 1024, "kindString": "Property", @@ -19049,7 +20109,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 462, + "line": 480, "character": 4 } ], @@ -19063,13 +20123,13 @@ { "title": "Properties", "kind": 1024, - "children": [711, 710] + "children": [731, 730] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 456, + "line": 474, "character": 12 } ] @@ -19081,13 +20141,13 @@ { "title": "Properties", "kind": 1024, - "children": [708] + "children": [728] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 473, "character": 43 } ] @@ -19102,7 +20162,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -19114,7 +20174,7 @@ ] }, { - "id": 163, + "id": 164, "name": "signInWithIdToken", "kind": 2048, "kindString": "Method", @@ -19122,13 +20182,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 621, + "line": 644, "character": 8 } ], "signatures": [ { - "id": 164, + "id": 165, "name": "signInWithIdToken", "kind": 4096, "kindString": "Call signature", @@ -19138,17 +20198,17 @@ }, "parameters": [ { - "id": 165, + "id": 166, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 772, + "id": 792, "name": "SignInWithIdTokenCredentials", "dereferenced": { - "id": 772, + "id": 792, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -19156,21 +20216,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 581, + "line": 599, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 773, + "id": 793, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 776, + "id": 797, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -19183,7 +20243,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 587, + "line": 605, "character": 2 } ], @@ -19193,7 +20253,7 @@ } }, { - "id": 777, + "id": 798, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -19206,7 +20266,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 589, + "line": 607, "character": 2 } ], @@ -19216,7 +20276,7 @@ } }, { - "id": 778, + "id": 799, "name": "options", "kind": 1024, "kindString": "Property", @@ -19226,21 +20286,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 608, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 779, + "id": 800, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 780, + "id": 801, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -19253,7 +20313,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 592, + "line": 610, "character": 4 } ], @@ -19267,13 +20327,13 @@ { "title": "Properties", "kind": 1024, - "children": [780] + "children": [801] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 608, "character": 12 } ] @@ -19281,18 +20341,18 @@ } }, { - "id": 774, + "id": 794, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "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`, `keycloak` (deprecated)." + "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`, `keycloak` (deprecated)." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 583, + "line": 601, "character": 2 } ], @@ -19316,14 +20376,40 @@ "value": "facebook" }, { - "type": "intrinsic", - "name": "string" + "type": "literal", + "value": "kakao" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 795, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 601, + "character": 76 + } + ] + } + } + ] } ] } }, { - "id": 775, + "id": 796, "name": "token", "kind": 1024, "kindString": "Property", @@ -19334,7 +20420,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 585, + "line": 603, "character": 2 } ], @@ -19348,13 +20434,13 @@ { "title": "Properties", "kind": 1024, - "children": [776, 777, 778, 774, 775] + "children": [797, 798, 799, 794, 796] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 581, + "line": 599, "character": 43 } ] @@ -19369,7 +20455,7 @@ "typeArguments": [ { "type": "reference", - "id": 557, + "id": 574, "name": "AuthTokenResponse" } ], @@ -19381,7 +20467,7 @@ ] }, { - "id": 140, + "id": 141, "name": "signInWithOAuth", "kind": 2048, "kindString": "Method", @@ -19389,13 +20475,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 557, + "line": 572, "character": 8 } ], "signatures": [ { - "id": 141, + "id": 142, "name": "signInWithOAuth", "kind": 4096, "kindString": "Call signature", @@ -19405,17 +20491,17 @@ }, "parameters": [ { - "id": 142, + "id": 143, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -19423,21 +20509,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 761, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 763, + "id": 783, "name": "options", "kind": 1024, "kindString": "Property", @@ -19447,21 +20533,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 764, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 767, + "id": 787, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -19474,14 +20560,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 768, + "id": 788, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -19489,19 +20575,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 18 } ], "indexSignature": { - "id": 769, + "id": 789, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 770, + "id": 790, "name": "key", "kind": 32768, "flags": {}, @@ -19520,7 +20606,7 @@ } }, { - "id": 765, + "id": 785, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -19533,7 +20619,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 571, + "line": 589, "character": 4 } ], @@ -19543,7 +20629,7 @@ } }, { - "id": 766, + "id": 786, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -19556,7 +20642,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 573, + "line": 591, "character": 4 } ], @@ -19566,7 +20652,7 @@ } }, { - "id": 771, + "id": 791, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -19579,7 +20665,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 577, + "line": 595, "character": 4 } ], @@ -19593,13 +20679,13 @@ { "title": "Properties", "kind": 1024, - "children": [767, 765, 766, 771] + "children": [787, 785, 786, 791] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 12 } ] @@ -19607,7 +20693,7 @@ } }, { - "id": 762, + "id": 782, "name": "provider", "kind": 1024, "kindString": "Property", @@ -19618,16 +20704,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 568, + "line": 586, "character": 2 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider", "dereferenced": { - "id": 478, + "id": 493, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -19705,6 +20791,10 @@ "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -19739,13 +20829,13 @@ { "title": "Properties", "kind": 1024, - "children": [763, 762] + "children": [783, 782] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 41 } ] @@ -19760,7 +20850,7 @@ "typeArguments": [ { "type": "reference", - "id": 585, + "id": 602, "name": "OAuthResponse" } ], @@ -19772,7 +20862,7 @@ ] }, { - "id": 166, + "id": 167, "name": "signInWithOtp", "kind": 2048, "kindString": "Method", @@ -19780,13 +20870,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 678, + "line": 699, "character": 8 } ], "signatures": [ { - "id": 167, + "id": 168, "name": "signInWithOtp", "kind": 4096, "kindString": "Call signature", @@ -19797,17 +20887,17 @@ }, "parameters": [ { - "id": 168, + "id": 169, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 742, + "id": 762, "name": "SignInWithPasswordlessCredentials", "dereferenced": { - "id": 742, + "id": 762, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -19815,7 +20905,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 527, + "line": 545, "character": 12 } ], @@ -19825,14 +20915,14 @@ { "type": "reflection", "declaration": { - "id": 743, + "id": 763, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 744, + "id": 764, "name": "email", "kind": 1024, "kindString": "Property", @@ -19843,7 +20933,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 530, + "line": 548, "character": 6 } ], @@ -19853,168 +20943,7 @@ } }, { - "id": 745, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 531, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 746, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 750, - "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": 543, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 749, - "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.raw_user_meta_data` 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": 541, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 747, - "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": 533, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 748, - "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": 535, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [750, 749, 747, 748] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 531, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [744, 745] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 528, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 751, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 753, + "id": 765, "name": "options", "kind": 1024, "kindString": "Property", @@ -20031,14 +20960,14 @@ "type": { "type": "reflection", "declaration": { - "id": 754, + "id": 766, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 757, + "id": 770, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20051,7 +20980,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 559, + "line": 561, "character": 8 } ], @@ -20061,7 +20990,168 @@ } }, { - "id": 758, + "id": 769, + "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.raw_user_meta_data` 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": 559, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 767, + "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": 551, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 768, + "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": 553, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [770, 769, 767, 768] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 549, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [764, 765] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 546, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 771, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 773, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 567, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 774, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 777, + "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": 577, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 778, "name": "channel", "kind": 1024, "kindString": "Property", @@ -20074,7 +21164,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 579, "character": 8 } ], @@ -20093,7 +21183,7 @@ } }, { - "id": 756, + "id": 776, "name": "data", "kind": 1024, "kindString": "Property", @@ -20107,7 +21197,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 557, + "line": 575, "character": 8 } ], @@ -20117,7 +21207,7 @@ } }, { - "id": 755, + "id": 775, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -20130,7 +21220,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 551, + "line": 569, "character": 8 } ], @@ -20144,13 +21234,13 @@ { "title": "Properties", "kind": 1024, - "children": [757, 758, 756, 755] + "children": [777, 778, 776, 775] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 567, "character": 16 } ] @@ -20158,7 +21248,7 @@ } }, { - "id": 752, + "id": 772, "name": "phone", "kind": 1024, "kindString": "Property", @@ -20169,7 +21259,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 548, + "line": 566, "character": 6 } ], @@ -20183,13 +21273,13 @@ { "title": "Properties", "kind": 1024, - "children": [753, 752] + "children": [773, 772] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 564, "character": 4 } ] @@ -20206,7 +21296,7 @@ "typeArguments": [ { "type": "reference", - "id": 542, + "id": 559, "name": "AuthOtpResponse" } ], @@ -20218,7 +21308,7 @@ ] }, { - "id": 137, + "id": 138, "name": "signInWithPassword", "kind": 2048, "kindString": "Method", @@ -20226,13 +21316,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 492, + "line": 509, "character": 8 } ], "signatures": [ { - "id": 138, + "id": 139, "name": "signInWithPassword", "kind": 4096, "kindString": "Call signature", @@ -20243,17 +21333,17 @@ }, "parameters": [ { - "id": 139, + "id": 140, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 729, + "id": 749, "name": "SignInWithPasswordCredentials", "dereferenced": { - "id": 729, + "id": 749, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -20261,7 +21351,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 523, "character": 12 } ], @@ -20271,14 +21361,14 @@ { "type": "reflection", "declaration": { - "id": 730, + "id": 750, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 731, + "id": 751, "name": "email", "kind": 1024, "kindString": "Property", @@ -20289,7 +21379,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 508, + "line": 526, "character": 6 } ], @@ -20299,7 +21389,7 @@ } }, { - "id": 733, + "id": 753, "name": "options", "kind": 1024, "kindString": "Property", @@ -20309,21 +21399,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 511, + "line": 529, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20336,7 +21426,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 513, + "line": 531, "character": 8 } ], @@ -20350,13 +21440,13 @@ { "title": "Properties", "kind": 1024, - "children": [735] + "children": [755] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 511, + "line": 529, "character": 16 } ] @@ -20364,7 +21454,7 @@ } }, { - "id": 732, + "id": 752, "name": "password", "kind": 1024, "kindString": "Property", @@ -20375,7 +21465,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 510, + "line": 528, "character": 6 } ], @@ -20389,13 +21479,13 @@ { "title": "Properties", "kind": 1024, - "children": [731, 733, 732] + "children": [751, 753, 752] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 524, "character": 4 } ] @@ -20404,14 +21494,14 @@ { "type": "reflection", "declaration": { - "id": 736, + "id": 756, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 739, + "id": 759, "name": "options", "kind": 1024, "kindString": "Property", @@ -20421,21 +21511,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 521, + "line": 539, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 740, + "id": 760, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 741, + "id": 761, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20448,7 +21538,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 523, + "line": 541, "character": 8 } ], @@ -20462,13 +21552,13 @@ { "title": "Properties", "kind": 1024, - "children": [741] + "children": [761] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 521, + "line": 539, "character": 16 } ] @@ -20476,7 +21566,7 @@ } }, { - "id": 738, + "id": 758, "name": "password", "kind": 1024, "kindString": "Property", @@ -20487,7 +21577,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 520, + "line": 538, "character": 6 } ], @@ -20497,7 +21587,7 @@ } }, { - "id": 737, + "id": 757, "name": "phone", "kind": 1024, "kindString": "Property", @@ -20508,7 +21598,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 518, + "line": 536, "character": 6 } ], @@ -20522,13 +21612,13 @@ { "title": "Properties", "kind": 1024, - "children": [739, 738, 737] + "children": [759, 758, 757] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 516, + "line": 534, "character": 4 } ] @@ -20545,7 +21635,7 @@ "typeArguments": [ { "type": "reference", - "id": 570, + "id": 587, "name": "AuthTokenResponsePassword" } ], @@ -20557,7 +21647,7 @@ ] }, { - "id": 172, + "id": 173, "name": "signInWithSSO", "kind": 2048, "kindString": "Method", @@ -20565,13 +21655,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 799, + "line": 813, "character": 8 } ], "signatures": [ { - "id": 173, + "id": 174, "name": "signInWithSSO", "kind": 4096, "kindString": "Call signature", @@ -20582,17 +21672,17 @@ }, "parameters": [ { - "id": 174, + "id": 175, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 817, + "id": 838, "name": "SignInWithSSO", "dereferenced": { - "id": 817, + "id": 838, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -20600,7 +21690,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 666, + "line": 684, "character": 12 } ], @@ -20610,14 +21700,14 @@ { "type": "reflection", "declaration": { - "id": 818, + "id": 839, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 820, + "id": 841, "name": "options", "kind": 1024, "kindString": "Property", @@ -20627,21 +21717,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 671, + "line": 689, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 821, + "id": 842, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 823, + "id": 844, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20654,7 +21744,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 675, + "line": 693, "character": 8 } ], @@ -20664,7 +21754,7 @@ } }, { - "id": 822, + "id": 843, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -20677,7 +21767,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 673, + "line": 691, "character": 8 } ], @@ -20691,13 +21781,13 @@ { "title": "Properties", "kind": 1024, - "children": [823, 822] + "children": [844, 843] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 671, + "line": 689, "character": 16 } ] @@ -20705,7 +21795,7 @@ } }, { - "id": 819, + "id": 840, "name": "providerId", "kind": 1024, "kindString": "Property", @@ -20716,7 +21806,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 669, + "line": 687, "character": 6 } ], @@ -20730,13 +21820,13 @@ { "title": "Properties", "kind": 1024, - "children": [820, 819] + "children": [841, 840] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 667, + "line": 685, "character": 4 } ] @@ -20745,14 +21835,14 @@ { "type": "reflection", "declaration": { - "id": 824, + "id": 845, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 825, + "id": 846, "name": "domain", "kind": 1024, "kindString": "Property", @@ -20763,7 +21853,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 680, + "line": 698, "character": 6 } ], @@ -20773,7 +21863,7 @@ } }, { - "id": 826, + "id": 847, "name": "options", "kind": 1024, "kindString": "Property", @@ -20783,21 +21873,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 682, + "line": 700, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 827, + "id": 848, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 829, + "id": 850, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -20810,7 +21900,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 686, + "line": 704, "character": 8 } ], @@ -20820,7 +21910,7 @@ } }, { - "id": 828, + "id": 849, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -20833,7 +21923,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 684, + "line": 702, "character": 8 } ], @@ -20847,13 +21937,13 @@ { "title": "Properties", "kind": 1024, - "children": [829, 828] + "children": [850, 849] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 682, + "line": 700, "character": 16 } ] @@ -20865,13 +21955,13 @@ { "title": "Properties", "kind": 1024, - "children": [825, 826] + "children": [846, 847] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 678, + "line": 696, "character": 4 } ] @@ -20888,7 +21978,7 @@ "typeArguments": [ { "type": "reference", - "id": 598, + "id": 615, "name": "SSOResponse" } ], @@ -20900,7 +21990,7 @@ ] }, { - "id": 311, + "id": 324, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -20908,13 +21998,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1568, + "line": 1589, "character": 8 } ], "signatures": [ { - "id": 312, + "id": 325, "name": "signOut", "kind": 4096, "kindString": "Call signature", @@ -20925,17 +22015,17 @@ }, "parameters": [ { - "id": 313, + "id": 326, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1043, + "id": 1052, "name": "SignOut", "dereferenced": { - "id": 1043, + "id": 1052, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -20943,21 +22033,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1128, + "line": 1115, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1044, + "id": 1053, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1045, + "id": 1054, "name": "scope", "kind": 1024, "kindString": "Property", @@ -20970,7 +22060,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1139, + "line": 1126, "character": 2 } ], @@ -20997,13 +22087,13 @@ { "title": "Properties", "kind": 1024, - "children": [1045] + "children": [1054] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1128, + "line": 1115, "character": 22 } ] @@ -21020,14 +22110,14 @@ { "type": "reflection", "declaration": { - "id": 314, + "id": 327, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 315, + "id": 328, "name": "error", "kind": 1024, "kindString": "Property", @@ -21035,7 +22125,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1568, + "line": 1589, "character": 67 } ], @@ -21048,7 +22138,7 @@ }, { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] @@ -21059,7 +22149,7 @@ { "title": "Properties", "kind": 1024, - "children": [315] + "children": [328] } ] } @@ -21073,7 +22163,7 @@ ] }, { - "id": 134, + "id": 135, "name": "signUp", "kind": 2048, "kindString": "Method", @@ -21081,13 +22171,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 413, + "line": 432, "character": 8 } ], "signatures": [ { - "id": 135, + "id": 136, "name": "signUp", "kind": 4096, "kindString": "Call signature", @@ -21099,17 +22189,17 @@ }, "parameters": [ { - "id": 136, + "id": 137, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 712, + "id": 732, "name": "SignUpWithPasswordCredentials", "dereferenced": { - "id": 712, + "id": 732, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -21117,7 +22207,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 468, + "line": 486, "character": 12 } ], @@ -21127,14 +22217,14 @@ { "type": "reflection", "declaration": { - "id": 713, + "id": 733, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 714, + "id": 734, "name": "email", "kind": 1024, "kindString": "Property", @@ -21145,7 +22235,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 471, + "line": 489, "character": 6 } ], @@ -21155,166 +22245,7 @@ } }, { - "id": 716, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 474, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 717, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 720, - "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": 484, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 719, - "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.raw_user_meta_data` 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": 482, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 718, - "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": 476, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [720, 719, 718] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 474, - "character": 16 - } - ] - } - } - }, - { - "id": 715, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 473, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [714, 716, 715] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 469, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 721, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 724, + "id": 736, "name": "options", "kind": 1024, "kindString": "Property", @@ -21331,14 +22262,14 @@ "type": { "type": "reflection", "declaration": { - "id": 725, + "id": 737, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 727, + "id": 740, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -21346,30 +22277,7 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 500, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 728, - "name": "channel", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { @@ -21379,21 +22287,12 @@ } ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] + "type": "intrinsic", + "name": "string" } }, { - "id": 726, + "id": 739, "name": "data", "kind": 1024, "kindString": "Property", @@ -21407,7 +22306,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 498, + "line": 500, "character": 8 } ], @@ -21415,13 +22314,36 @@ "type": "intrinsic", "name": "object" } + }, + { + "id": 738, + "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": 494, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [727, 728, 726] + "children": [740, 739, 738] } ], "sources": [ @@ -21435,7 +22357,7 @@ } }, { - "id": 723, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -21454,9 +22376,177 @@ "type": "intrinsic", "name": "string" } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [734, 736, 735] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 487, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 741, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 744, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 510, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 745, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 747, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 518, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 748, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 746, + "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.raw_user_meta_data` 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": 516, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [747, 748, 746] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 510, + "character": 16 + } + ] + } + } }, { - "id": 722, + "id": 743, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 509, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 742, "name": "phone", "kind": 1024, "kindString": "Property", @@ -21467,7 +22557,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 489, + "line": 507, "character": 6 } ], @@ -21481,13 +22571,13 @@ { "title": "Properties", "kind": 1024, - "children": [724, 723, 722] + "children": [744, 743, 742] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 487, + "line": 505, "character": 4 } ] @@ -21504,7 +22594,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -21516,7 +22606,7 @@ ] }, { - "id": 417, + "id": 430, "name": "startAutoRefresh", "kind": 2048, "kindString": "Method", @@ -21524,13 +22614,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 2142, + "line": 2174, "character": 8 } ], "signatures": [ { - "id": 418, + "id": 431, "name": "startAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -21555,7 +22645,7 @@ ] }, { - "id": 419, + "id": 432, "name": "stopAutoRefresh", "kind": 2048, "kindString": "Method", @@ -21563,13 +22653,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 2155, + "line": 2187, "character": 8 } ], "signatures": [ { - "id": 420, + "id": 433, "name": "stopAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -21594,7 +22684,7 @@ ] }, { - "id": 362, + "id": 375, "name": "unlinkIdentity", "kind": 2048, "kindString": "Method", @@ -21602,13 +22692,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1770, + "line": 1795, "character": 8 } ], "signatures": [ { - "id": 363, + "id": 376, "name": "unlinkIdentity", "kind": 4096, "kindString": "Call signature", @@ -21618,24 +22708,24 @@ }, "parameters": [ { - "id": 364, + "id": 377, "name": "identity", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 630, + "id": 648, "name": "UserIdentity", "dereferenced": { - "id": 630, + "id": 648, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 639, + "id": 657, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -21645,7 +22735,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 279, + "line": 285, "character": 2 } ], @@ -21655,7 +22745,7 @@ } }, { - "id": 631, + "id": 649, "name": "id", "kind": 1024, "kindString": "Property", @@ -21663,7 +22753,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 272, + "line": 278, "character": 2 } ], @@ -21673,7 +22763,7 @@ } }, { - "id": 633, + "id": 651, "name": "identity_data", "kind": 1024, "kindString": "Property", @@ -21683,27 +22773,27 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 274, + "line": 280, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 634, + "id": 652, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 635, + "id": 653, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 636, + "id": 654, "name": "key", "kind": 32768, "flags": {}, @@ -21722,7 +22812,7 @@ } }, { - "id": 637, + "id": 655, "name": "identity_id", "kind": 1024, "kindString": "Property", @@ -21730,7 +22820,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 277, + "line": 283, "character": 2 } ], @@ -21740,7 +22830,7 @@ } }, { - "id": 640, + "id": 658, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -21750,7 +22840,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 280, + "line": 286, "character": 2 } ], @@ -21760,7 +22850,7 @@ } }, { - "id": 638, + "id": 656, "name": "provider", "kind": 1024, "kindString": "Property", @@ -21768,7 +22858,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 284, "character": 2 } ], @@ -21778,7 +22868,7 @@ } }, { - "id": 641, + "id": 659, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -21788,7 +22878,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 281, + "line": 287, "character": 2 } ], @@ -21798,7 +22888,7 @@ } }, { - "id": 632, + "id": 650, "name": "user_id", "kind": 1024, "kindString": "Property", @@ -21806,7 +22896,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 273, + "line": 279, "character": 2 } ], @@ -21820,13 +22910,13 @@ { "title": "Properties", "kind": 1024, - "children": [639, 631, 633, 637, 640, 638, 641, 632] + "children": [657, 649, 651, 655, 658, 656, 659, 650] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 271, + "line": 277, "character": 17 } ] @@ -21843,14 +22933,14 @@ { "type": "reflection", "declaration": { - "id": 365, + "id": 378, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 366, + "id": 379, "name": "data", "kind": 1024, "kindString": "Property", @@ -21858,14 +22948,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1772, + "line": 1797, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 367, + "id": 380, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -21874,7 +22964,7 @@ } }, { - "id": 368, + "id": 381, "name": "error", "kind": 1024, "kindString": "Property", @@ -21882,7 +22972,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1773, + "line": 1798, "character": 8 } ], @@ -21896,7 +22986,7 @@ { "title": "Properties", "kind": 1024, - "children": [366, 368] + "children": [379, 381] } ] } @@ -21904,14 +22994,14 @@ { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 370, + "id": 383, "name": "data", "kind": 1024, "kindString": "Property", @@ -21919,7 +23009,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1775, + "line": 1800, "character": 8 } ], @@ -21929,7 +23019,7 @@ } }, { - "id": 371, + "id": 384, "name": "error", "kind": 1024, "kindString": "Property", @@ -21937,13 +23027,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1775, + "line": 1800, "character": 20 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -21952,7 +23042,7 @@ { "title": "Properties", "kind": 1024, - "children": [370, 371] + "children": [383, 384] } ] } @@ -21968,7 +23058,7 @@ ] }, { - "id": 251, + "id": 252, "name": "updateUser", "kind": 2048, "kindString": "Method", @@ -21976,13 +23066,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1219, + "line": 1227, "character": 8 } ], "signatures": [ { - "id": 252, + "id": 253, "name": "updateUser", "kind": 4096, "kindString": "Call signature", @@ -21992,24 +23082,24 @@ }, "parameters": [ { - "id": 253, + "id": 254, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes", "dereferenced": { - "id": 679, + "id": 699, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 684, + "id": 704, "name": "data", "kind": 1024, "kindString": "Property", @@ -22023,7 +23113,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 374, + "line": 380, "character": 2 } ], @@ -22033,7 +23123,7 @@ } }, { - "id": 680, + "id": 700, "name": "email", "kind": 1024, "kindString": "Property", @@ -22046,7 +23136,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -22056,7 +23146,7 @@ } }, { - "id": 683, + "id": 703, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -22070,7 +23160,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -22080,7 +23170,7 @@ } }, { - "id": 682, + "id": 702, "name": "password", "kind": 1024, "kindString": "Property", @@ -22093,7 +23183,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -22103,7 +23193,7 @@ } }, { - "id": 681, + "id": 701, "name": "phone", "kind": 1024, "kindString": "Property", @@ -22116,7 +23206,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -22130,13 +23220,13 @@ { "title": "Properties", "kind": 1024, - "children": [684, 680, 683, 682, 681] + "children": [704, 700, 703, 702, 701] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 345, + "line": 351, "character": 17 } ] @@ -22144,7 +23234,7 @@ } }, { - "id": 254, + "id": 255, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -22152,14 +23242,14 @@ "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 256, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 256, + "id": 257, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -22169,7 +23259,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1222, + "line": 1230, "character": 6 } ], @@ -22183,7 +23273,7 @@ { "title": "Properties", "kind": 1024, - "children": [256] + "children": [257] } ] } @@ -22196,7 +23286,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -22208,7 +23298,7 @@ ] }, { - "id": 169, + "id": 170, "name": "verifyOtp", "kind": 2048, "kindString": "Method", @@ -22216,13 +23306,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 733, + "line": 752, "character": 8 } ], "signatures": [ { - "id": 170, + "id": 171, "name": "verifyOtp", "kind": 4096, "kindString": "Call signature", @@ -22232,17 +23322,17 @@ }, "parameters": [ { - "id": 171, + "id": 172, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 781, + "id": 802, "name": "VerifyOtpParams", "dereferenced": { - "id": 781, + "id": 802, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -22250,7 +23340,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 596, + "line": 614, "character": 12 } ], @@ -22258,14 +23348,14 @@ "type": "union", "types": [ { - "id": 782, + "id": 803, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 786, + "id": 807, "name": "options", "kind": 1024, "kindString": "Property", @@ -22275,243 +23365,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 604, + "line": 622, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 787, + "id": 808, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 789, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ - { - "tag": "deprecated", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 613, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 788, - "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": 606, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [789, 788] - } - ] - } - } - }, - { - "id": 783, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 599, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 784, - "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": 601, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 785, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 603, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 801, - "name": "MobileOtpType", - "dereferenced": { - "id": 801, - "name": "MobileOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 643, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [786, 783, 784, 785] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 597, - "character": 17 - } - ] - }, - { - "id": 790, - "name": "VerifyEmailOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 791, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 618, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 794, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 623, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 795, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 797, + "id": 810, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -22540,7 +23408,7 @@ } }, { - "id": 796, + "id": 809, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -22553,7 +23421,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 625, + "line": 624, "character": 4 } ], @@ -22567,25 +23435,25 @@ { "title": "Properties", "kind": 1024, - "children": [797, 796] + "children": [810, 809] } ] } } }, { - "id": 792, - "name": "token", + "id": 804, + "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's email address." + "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 620, + "line": 617, "character": 2 } ], @@ -22595,7 +23463,28 @@ } }, { - "id": 793, + "id": 805, + "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": 619, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 806, "name": "type", "kind": 1024, "kindString": "Property", @@ -22606,24 +23495,24 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 622, + "line": 621, "character": 2 } ], "type": { "type": "reference", - "id": 802, - "name": "EmailOtpType", + "id": 822, + "name": "MobileOtpType", "dereferenced": { - "id": 802, - "name": "EmailOtpType", + "id": 822, + "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 661, "character": 12 } ], @@ -22632,27 +23521,11 @@ "types": [ { "type": "literal", - "value": "signup" + "value": "sms" }, { "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" + "value": "phone_change" } ] } @@ -22664,37 +23537,37 @@ { "title": "Properties", "kind": 1024, - "children": [791, 794, 792, 793] + "children": [807, 804, 805, 806] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 616, + "line": 615, "character": 17 } ] }, { - "id": 798, - "name": "VerifyTokenHashParams", + "id": 811, + "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 799, - "name": "token_hash", + "id": 812, + "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The token hash used in an email link" + "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 637, + "line": 636, "character": 2 } ], @@ -22704,7 +23577,115 @@ } }, { - "id": 800, + "id": 815, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 641, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 816, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 818, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site.", + "tags": [ + { + "tag": "deprecated", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 649, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 817, + "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": 643, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [818, 817] + } + ] + } + } + }, + { + "id": 813, + "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": 638, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 814, "name": "type", "kind": 1024, "kindString": "Property", @@ -22721,10 +23702,10 @@ ], "type": { "type": "reference", - "id": 802, + "id": 823, "name": "EmailOtpType", "dereferenced": { - "id": 802, + "id": 823, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -22732,7 +23713,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 662, "character": 12 } ], @@ -22773,13 +23754,122 @@ { "title": "Properties", "kind": 1024, - "children": [799, 800] + "children": [812, 815, 813, 814] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 635, + "line": 634, + "character": 17 + } + ] + }, + { + "id": 819, + "name": "VerifyTokenHashParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 820, + "name": "token_hash", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The token hash used in an email link" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 655, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 821, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 658, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 823, + "name": "EmailOtpType", + "dereferenced": { + "id": 823, + "name": "EmailOtpType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 662, + "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" + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [820, 821] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 653, "character": 17 } ] @@ -22795,7 +23885,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -22822,42 +23912,42 @@ "title": "Methods", "kind": 2048, "children": [ - 143, 182, 245, 349, 127, 359, 321, 175, 282, 179, 335, 270, 131, 163, 140, 166, 137, - 172, 311, 134, 417, 419, 362, 251, 169 + 144, 183, 246, 362, 128, 372, 334, 176, 283, 180, 348, 271, 132, 164, 141, 167, 138, + 173, 324, 135, 430, 432, 375, 252, 170 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 116, + "line": 123, "character": 21 } ] }, { - "id": 470, + "id": 485, "name": "NavigatorLockAcquireTimeoutError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 471, + "id": 486, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 472, + "id": 487, "name": "new NavigatorLockAcquireTimeoutError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 473, + "id": 488, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -22870,7 +23960,7 @@ ], "type": { "type": "reference", - "id": 470, + "id": 485, "name": "NavigatorLockAcquireTimeoutError" }, "inheritedFrom": { @@ -22885,7 +23975,7 @@ } }, { - "id": 474, + "id": 489, "name": "isAcquireTimeout", "kind": 1024, "kindString": "Property", @@ -22915,12 +24005,12 @@ { "title": "Constructors", "kind": 512, - "children": [471] + "children": [486] }, { "title": "Properties", "kind": 1024, - "children": [474] + "children": [489] } ], "sources": [ @@ -22938,7 +24028,7 @@ ] }, { - "id": 627, + "id": 644, "name": "AMREntry", "kind": 256, "kindString": "Interface", @@ -22955,7 +24045,7 @@ }, "children": [ { - "id": 628, + "id": 645, "name": "method", "kind": 1024, "kindString": "Property", @@ -22966,17 +24056,53 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 262, + "line": 268, "character": 2 } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "literal", + "value": "password" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 646, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "literal", + "value": "otp" + }, + { + "type": "literal", + "value": "oauth" + }, + { + "type": "literal", + "value": "mfa/totp" + } + ] } }, { - "id": 629, + "id": 647, "name": "timestamp", "kind": 1024, "kindString": "Property", @@ -22987,7 +24113,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 268, + "line": 274, "character": 2 } ], @@ -23001,26 +24127,26 @@ { "title": "Properties", "kind": 1024, - "children": [628, 629] + "children": [645, 647] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 260, + "line": 266, "character": 17 } ] }, { - "id": 685, + "id": 705, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 687, + "id": 707, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -23034,7 +24160,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 398, + "line": 404, "character": 2 } ], @@ -23044,7 +24170,7 @@ } }, { - "id": 690, + "id": 710, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -23058,7 +24184,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 424, + "line": 430, "character": 2 } ], @@ -23068,7 +24194,7 @@ } }, { - "id": 694, + "id": 717, "name": "email", "kind": 1024, "kindString": "Property", @@ -23081,7 +24207,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -23095,7 +24221,7 @@ } }, { - "id": 688, + "id": 708, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -23109,7 +24235,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 411, "character": 2 } ], @@ -23119,7 +24245,31 @@ } }, { - "id": 693, + "id": 713, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `id` for the user.", + "text": "Allows you to overwrite the default `id` set for the user.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 455, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 715, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -23133,7 +24283,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -23147,7 +24297,7 @@ } }, { - "id": 692, + "id": 714, "name": "password", "kind": 1024, "kindString": "Property", @@ -23160,7 +24310,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -23174,7 +24324,31 @@ } }, { - "id": 695, + "id": 712, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `password_hash` for the user's password.", + "text": "Allows 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.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 716, "name": "phone", "kind": 1024, "kindString": "Property", @@ -23187,7 +24361,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -23201,7 +24375,7 @@ } }, { - "id": 689, + "id": 709, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -23215,7 +24389,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 412, + "line": 418, "character": 2 } ], @@ -23225,7 +24399,7 @@ } }, { - "id": 691, + "id": 711, "name": "role", "kind": 1024, "kindString": "Property", @@ -23239,7 +24413,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 439, "character": 2 } ], @@ -23249,7 +24423,7 @@ } }, { - "id": 686, + "id": 706, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -23263,7 +24437,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 388, + "line": 394, "character": 2 } ], @@ -23277,13 +24451,13 @@ { "title": "Properties", "kind": 1024, - "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] + "children": [707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 377, + "line": 383, "character": 17 } ], @@ -23293,7 +24467,7 @@ "typeArguments": [ { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes" }, { @@ -23308,7 +24482,7 @@ ] }, { - "id": 642, + "id": 660, "name": "Factor", "kind": 256, "kindString": "Interface", @@ -23332,7 +24506,7 @@ }, "children": [ { - "id": 647, + "id": 666, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -23340,7 +24514,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 307, + "line": 312, "character": 2 } ], @@ -23350,13 +24524,64 @@ } }, { - "id": 645, + "id": 663, "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." + "shortText": "Type of factor. `totp` and `phone` supported with this version" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 307, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 664, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] + } + }, + { + "id": 662, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." }, "sources": [ { @@ -23371,30 +24596,7 @@ } }, { - "id": 644, - "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": 296, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 643, + "id": 661, "name": "id", "kind": 1024, "kindString": "Property", @@ -23405,7 +24607,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 293, + "line": 299, "character": 2 } ], @@ -23415,7 +24617,7 @@ } }, { - "id": 646, + "id": 665, "name": "status", "kind": 1024, "kindString": "Property", @@ -23426,7 +24628,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 305, + "line": 310, "character": 2 } ], @@ -23445,7 +24647,7 @@ } }, { - "id": 648, + "id": 667, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -23453,7 +24655,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 308, + "line": 313, "character": 2 } ], @@ -23467,26 +24669,26 @@ { "title": "Properties", "kind": 1024, - "children": [647, 645, 644, 643, 646, 648] + "children": [666, 663, 662, 661, 665, 667] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 291, + "line": 297, "character": 17 } ] }, { - "id": 852, + "id": 873, "name": "GenerateLinkOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 853, + "id": 874, "name": "data", "kind": 1024, "kindString": "Property", @@ -23500,7 +24702,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 728, + "line": 746, "character": 2 } ], @@ -23510,7 +24712,7 @@ } }, { - "id": 854, + "id": 875, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -23523,7 +24725,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 730, + "line": 748, "character": 2 } ], @@ -23537,19 +24739,19 @@ { "title": "Properties", "kind": 1024, - "children": [853, 854] + "children": [874, 875] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 722, + "line": 740, "character": 17 } ] }, { - "id": 1012, + "id": 1021, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -23565,14 +24767,14 @@ }, "children": [ { - "id": 1016, + "id": 1025, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1017, + "id": 1026, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -23592,17 +24794,17 @@ }, "parameters": [ { - "id": 1018, + "id": 1027, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -23618,21 +24820,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1028, + "line": 1015, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 997, + "id": 1006, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 998, + "id": 1007, "name": "id", "kind": 1024, "kindString": "Property", @@ -23643,7 +24845,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1030, + "line": 1017, "character": 2 } ], @@ -23653,7 +24855,7 @@ } }, { - "id": 999, + "id": 1008, "name": "userId", "kind": 1024, "kindString": "Property", @@ -23664,7 +24866,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1033, + "line": 1020, "character": 2 } ], @@ -23678,13 +24880,13 @@ { "title": "Properties", "kind": 1024, - "children": [998, 999] + "children": [1007, 1008] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1028, + "line": 1015, "character": 45 } ] @@ -23699,7 +24901,7 @@ "typeArguments": [ { "type": "reference", - "id": 987, + "id": 996, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -23711,14 +24913,14 @@ ] }, { - "id": 1013, + "id": 1022, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1014, + "id": 1023, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -23728,17 +24930,17 @@ }, "parameters": [ { - "id": 1015, + "id": 1024, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -23754,21 +24956,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1039, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1010, + "id": 1019, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1011, + "id": 1020, "name": "userId", "kind": 1024, "kindString": "Property", @@ -23779,7 +24981,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1054, + "line": 1041, "character": 2 } ], @@ -23793,13 +24995,13 @@ { "title": "Properties", "kind": 1024, - "children": [1011] + "children": [1020] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1039, "character": 44 } ] @@ -23814,7 +25016,7 @@ "typeArguments": [ { "type": "reference", - "id": 1000, + "id": 1009, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -23830,19 +25032,19 @@ { "title": "Methods", "kind": 2048, - "children": [1016, 1013] + "children": [1025, 1022] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1062, + "line": 1049, "character": 17 } ] }, { - "id": 967, + "id": 972, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -23852,14 +25054,14 @@ }, "children": [ { - "id": 971, + "id": 980, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 972, + "id": 981, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -23869,17 +25071,17 @@ }, "parameters": [ { - "id": 973, + "id": 982, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 890, + "id": 907, "name": "MFAChallengeParams", "dereferenced": { - "id": 890, + "id": 907, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -23887,21 +25089,53 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 810, + "line": 821, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 891, + "id": 908, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 892, + "id": 910, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 825, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 909, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -23912,7 +25146,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 812, + "line": 823, "character": 2 } ], @@ -23926,13 +25160,13 @@ { "title": "Properties", "kind": 1024, - "children": [892] + "children": [910, 909] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 810, + "line": 821, "character": 33 } ] @@ -23947,7 +25181,7 @@ "typeArguments": [ { "type": "reference", - "id": 935, + "id": 938, "name": "AuthMFAChallengeResponse" } ], @@ -23959,14 +25193,14 @@ ] }, { - "id": 980, + "id": 989, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 981, + "id": 990, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -23976,17 +25210,17 @@ }, "parameters": [ { - "id": 982, + "id": 991, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 893, + "id": 911, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 893, + "id": 911, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -23994,21 +25228,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 894, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 896, + "id": 914, "name": "code", "kind": 1024, "kindString": "Property", @@ -24019,7 +25253,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 819, + "line": 832, "character": 2 } ], @@ -24029,7 +25263,7 @@ } }, { - "id": 895, + "id": 913, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -24040,7 +25274,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 817, + "line": 830, "character": 2 } ], @@ -24054,13 +25288,13 @@ { "title": "Properties", "kind": 1024, - "children": [896, 895] + "children": [914, 913] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 42 } ] @@ -24075,7 +25309,7 @@ "typeArguments": [ { "type": "reference", - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse" } ], @@ -24087,14 +25321,14 @@ ] }, { - "id": 968, + "id": 973, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 969, + "id": 974, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -24105,39 +25339,39 @@ }, "parameters": [ { - "id": 970, + "id": 975, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 877, - "name": "MFAEnrollParams", + "id": 1055, + "name": "MFAEnrollTOTPParams", "dereferenced": { - "id": 877, - "name": "MFAEnrollParams", + "id": 1055, + "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 785, + "line": 1129, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 878, + "id": 1056, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 879, + "id": 1057, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -24148,7 +25382,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 787, + "line": 1131, "character": 2 } ], @@ -24158,7 +25392,7 @@ } }, { - "id": 881, + "id": 1059, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -24171,7 +25405,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 791, + "line": 1135, "character": 2 } ], @@ -24181,7 +25415,7 @@ } }, { - "id": 880, + "id": 1058, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -24194,7 +25428,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 789, + "line": 1133, "character": 2 } ], @@ -24208,14 +25442,14 @@ { "title": "Properties", "kind": 1024, - "children": [879, 881, 880] + "children": [1057, 1059, 1058] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 785, - "character": 30 + "line": 1129, + "character": 34 } ] } @@ -24229,7 +25463,411 @@ "typeArguments": [ { "type": "reference", - "id": 910, + "id": 1065, + "name": "AuthMFAEnrollTOTPResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + }, + { + "id": 976, + "name": "enroll", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 977, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 1060, + "name": "MFAEnrollPhoneParams", + "dereferenced": { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1081, + "name": "AuthMFAEnrollPhoneResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + }, + { + "id": 978, + "name": "enroll", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 979, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 898, + "name": "MFAEnrollParams", + "dereferenced": { + "id": 898, + "name": "MFAEnrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 803, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "id": 1055, + "name": "MFAEnrollTOTPParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1056, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1057, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1131, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + }, + { + "id": 1059, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1135, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1058, + "name": "issuer", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Domain which the user is enrolled with." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1133, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1057, 1059, 1058] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 34 + } + ] + } + } + }, + { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + } + ] + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 928, "name": "AuthMFAEnrollResponse" } ], @@ -24241,14 +25879,14 @@ ] }, { - "id": 985, + "id": 994, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 986, + "id": 995, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -24262,7 +25900,7 @@ "typeArguments": [ { "type": "reference", - "id": 956, + "id": 961, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -24274,14 +25912,14 @@ ] }, { - "id": 983, + "id": 992, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 984, + "id": 993, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -24308,7 +25946,7 @@ "typeArguments": [ { "type": "reference", - "id": 945, + "id": 949, "name": "AuthMFAListFactorsResponse" } ], @@ -24320,14 +25958,14 @@ ] }, { - "id": 977, + "id": 986, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 978, + "id": 987, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -24337,17 +25975,17 @@ }, "parameters": [ { - "id": 979, + "id": 988, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 882, + "id": 899, "name": "MFAUnenrollParams", "dereferenced": { - "id": 882, + "id": 899, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -24355,21 +25993,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 794, + "line": 805, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 883, + "id": 900, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 884, + "id": 901, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -24380,7 +26018,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 796, + "line": 807, "character": 2 } ], @@ -24394,13 +26032,13 @@ { "title": "Properties", "kind": 1024, - "children": [884] + "children": [901] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 794, + "line": 805, "character": 32 } ] @@ -24415,7 +26053,7 @@ "typeArguments": [ { "type": "reference", - "id": 926, + "id": 929, "name": "AuthMFAUnenrollResponse" } ], @@ -24427,14 +26065,14 @@ ] }, { - "id": 974, + "id": 983, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 975, + "id": 984, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -24444,17 +26082,17 @@ }, "parameters": [ { - "id": 976, + "id": 985, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 885, + "id": 902, "name": "MFAVerifyParams", "dereferenced": { - "id": 885, + "id": 902, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -24462,21 +26100,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 799, + "line": 810, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 886, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 888, + "id": 905, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -24487,7 +26125,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 804, + "line": 815, "character": 2 } ], @@ -24497,7 +26135,7 @@ } }, { - "id": 889, + "id": 906, "name": "code", "kind": 1024, "kindString": "Property", @@ -24508,7 +26146,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 807, + "line": 818, "character": 2 } ], @@ -24518,7 +26156,7 @@ } }, { - "id": 887, + "id": 904, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -24529,7 +26167,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 801, + "line": 812, "character": 2 } ], @@ -24543,13 +26181,13 @@ { "title": "Properties", "kind": 1024, - "children": [888, 889, 887] + "children": [905, 906, 904] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 799, + "line": 810, "character": 30 } ] @@ -24564,7 +26202,7 @@ "typeArguments": [ { "type": "reference", - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse" } ], @@ -24580,26 +26218,26 @@ { "title": "Methods", "kind": 2048, - "children": [971, 980, 968, 985, 983, 977, 974] + "children": [980, 989, 973, 994, 992, 986, 983] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 949, + "line": 934, "character": 17 } ] }, { - "id": 618, + "id": 635, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 621, + "id": 638, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -24610,7 +26248,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 241, "character": 2 } ], @@ -24620,7 +26258,7 @@ } }, { - "id": 624, + "id": 641, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -24633,7 +26271,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 247, + "line": 253, "character": 2 } ], @@ -24643,7 +26281,7 @@ } }, { - "id": 623, + "id": 640, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -24654,7 +26292,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 243, + "line": 249, "character": 2 } ], @@ -24664,7 +26302,7 @@ } }, { - "id": 620, + "id": 637, "name": "provider_refresh_token", "kind": 1024, "kindString": "Property", @@ -24677,7 +26315,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 231, + "line": 237, "character": 2 } ], @@ -24696,7 +26334,7 @@ } }, { - "id": 619, + "id": 636, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -24709,7 +26347,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 226, + "line": 232, "character": 2 } ], @@ -24728,7 +26366,7 @@ } }, { - "id": 622, + "id": 639, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -24739,7 +26377,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 245, "character": 2 } ], @@ -24749,7 +26387,7 @@ } }, { - "id": 625, + "id": 642, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -24757,7 +26395,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 248, + "line": 254, "character": 2 } ], @@ -24767,7 +26405,7 @@ } }, { - "id": 626, + "id": 643, "name": "user", "kind": 1024, "kindString": "Property", @@ -24775,250 +26413,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 249, + "line": 255, "character": 2 } ], "type": { "type": "reference", - "id": 656, + "id": 675, "name": "User", "dereferenced": { - "id": 656, + "id": 675, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 667, + "id": 686, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 331, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 322, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 649, - "name": "UserAppMetadata", - "dereferenced": { - "id": 649, - "name": "UserAppMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 650, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 312, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [650] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 311, - "character": 17 - } - ], - "indexSignature": { - "id": 651, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 652, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 660, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 324, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 661, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 325, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 671, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 335, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 670, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 334, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 668, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 332, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 663, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 327, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 672, - "name": "email_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -25032,39 +26449,100 @@ } }, { - "id": 678, - "name": "factors", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 642, - "name": "Factor" - } - } - }, - { - "id": 657, - "name": "id", + "id": 677, + "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 321, + "line": 327, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 668, + "name": "UserAppMetadata", + "dereferenced": { + "id": 668, + "name": "UserAppMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 669, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 317, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [669] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 316, + "character": 17 + } + ], + "indexSignature": { + "id": 670, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 671, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 679, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 329, "character": 2 } ], @@ -25074,32 +26552,8 @@ } }, { - "id": 677, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 341, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 630, - "name": "UserIdentity" - } - } - }, - { - "id": 666, - "name": "invited_at", + "id": 680, + "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", "flags": { @@ -25118,148 +26572,8 @@ } }, { - "id": 674, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 338, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 328, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "new_phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 329, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 669, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 333, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 673, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 337, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 662, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 326, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 675, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 339, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 676, - "name": "updated_at", + "id": 690, + "name": "confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -25278,7 +26592,351 @@ } }, { - "id": 659, + "id": 689, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 339, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 687, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 337, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 682, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 332, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 691, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 341, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 698, + "name": "factors", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 348, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + }, + { + "id": 676, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 326, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 696, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 346, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 648, + "name": "UserIdentity" + } + } + }, + { + "id": 685, + "name": "invited_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 335, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 697, + "name": "is_anonymous", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 347, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 693, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 343, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 683, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 333, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 684, + "name": "new_phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 334, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 688, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 338, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 692, + "name": "phone_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 342, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 681, + "name": "recovery_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 331, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 694, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 344, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 695, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 345, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 678, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -25286,16 +26944,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 323, + "line": 328, "character": 2 } ], "type": { "type": "reference", - "id": 653, + "id": 672, "name": "UserMetadata", "dereferenced": { - "id": 653, + "id": 672, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -25303,19 +26961,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 316, + "line": 321, "character": 17 } ], "indexSignature": { - "id": 654, + "id": 673, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 655, + "id": 674, "name": "key", "kind": 32768, "flags": {}, @@ -25339,15 +26997,15 @@ "title": "Properties", "kind": 1024, "children": [ - 667, 658, 660, 661, 671, 670, 668, 663, 672, 678, 657, 677, 666, 674, 664, - 665, 669, 673, 662, 675, 676, 659 + 686, 677, 679, 680, 690, 689, 687, 682, 691, 698, 676, 696, 685, 697, 693, + 683, 684, 688, 692, 681, 694, 695, 678 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 320, + "line": 325, "character": 17 } ] @@ -25359,26 +27017,26 @@ { "title": "Properties", "kind": 1024, - "children": [621, 624, 623, 620, 619, 622, 625, 626] + "children": [638, 641, 640, 637, 636, 639, 642, 643] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 222, + "line": 228, "character": 17 } ] }, { - "id": 696, + "id": 718, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 697, + "id": 719, "name": "id", "kind": 1024, "kindString": "Property", @@ -25389,7 +27047,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 462, "character": 2 } ], @@ -25399,7 +27057,7 @@ } }, { - "id": 698, + "id": 720, "name": "callback", "kind": 2048, "kindString": "Method", @@ -25407,13 +27065,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 444, + "line": 466, "character": 2 } ], "signatures": [ { - "id": 699, + "id": 721, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -25423,17 +27081,17 @@ }, "parameters": [ { - "id": 700, + "id": 722, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 480, + "id": 495, "name": "AuthChangeEvent", "dereferenced": { - "id": 480, + "id": 495, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -25441,7 +27099,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 30, + "line": 31, "character": 12 } ], @@ -25473,7 +27131,7 @@ "value": "USER_UPDATED" }, { - "id": 479, + "id": 494, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -25481,7 +27139,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 28, + "line": 29, "character": 12 } ], @@ -25496,7 +27154,7 @@ } }, { - "id": 701, + "id": 723, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -25510,7 +27168,7 @@ }, { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } ] @@ -25525,7 +27183,7 @@ ] }, { - "id": 702, + "id": 724, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -25533,13 +27191,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 448, + "line": 470, "character": 2 } ], "signatures": [ { - "id": 703, + "id": 725, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -25559,299 +27217,37 @@ { "title": "Properties", "kind": 1024, - "children": [697] + "children": [719] }, { "title": "Methods", "kind": 2048, - "children": [698, 702] + "children": [720, 724] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 436, + "line": 458, "character": 17 } ] }, { - "id": 704, - "name": "UpdatableFactorAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 705, - "name": "friendlyName", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 452, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [705] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 451, - "character": 17 - } - ] - }, - { - "id": 656, + "id": 675, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 667, + "id": 686, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 331, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 322, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 649, - "name": "UserAppMetadata", - "dereferenced": { - "id": 649, - "name": "UserAppMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 650, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 312, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [650] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 311, - "character": 17 - } - ], - "indexSignature": { - "id": 651, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 652, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 660, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 324, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 661, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 325, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 671, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 335, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 670, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 334, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 668, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 332, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 663, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 327, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 672, - "name": "email_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -25865,39 +27261,100 @@ } }, { - "id": 678, - "name": "factors", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 642, - "name": "Factor" - } - } - }, - { - "id": 657, - "name": "id", + "id": 677, + "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 321, + "line": 327, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 668, + "name": "UserAppMetadata", + "dereferenced": { + "id": 668, + "name": "UserAppMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 669, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 317, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [669] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 316, + "character": 17 + } + ], + "indexSignature": { + "id": 670, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 671, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 679, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 329, "character": 2 } ], @@ -25907,32 +27364,8 @@ } }, { - "id": 677, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 341, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 630, - "name": "UserIdentity" - } - } - }, - { - "id": 666, - "name": "invited_at", + "id": 680, + "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", "flags": { @@ -25951,148 +27384,8 @@ } }, { - "id": 674, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 338, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 328, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "new_phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 329, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 669, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 333, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 673, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 337, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 662, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 326, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 675, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 339, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 676, - "name": "updated_at", + "id": 690, + "name": "confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -26111,7 +27404,351 @@ } }, { - "id": 659, + "id": 689, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 339, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 687, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 337, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 682, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 332, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 691, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 341, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 698, + "name": "factors", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 348, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + }, + { + "id": 676, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 326, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 696, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 346, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 648, + "name": "UserIdentity" + } + } + }, + { + "id": 685, + "name": "invited_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 335, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 697, + "name": "is_anonymous", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 347, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 693, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 343, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 683, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 333, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 684, + "name": "new_phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 334, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 688, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 338, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 692, + "name": "phone_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 342, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 681, + "name": "recovery_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 331, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 694, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 344, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 695, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 345, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 678, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -26119,16 +27756,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 323, + "line": 328, "character": 2 } ], "type": { "type": "reference", - "id": 653, + "id": 672, "name": "UserMetadata", "dereferenced": { - "id": 653, + "id": 672, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -26136,19 +27773,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 316, + "line": 321, "character": 17 } ], "indexSignature": { - "id": 654, + "id": 673, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 655, + "id": 674, "name": "key", "kind": 32768, "flags": {}, @@ -26172,28 +27809,28 @@ "title": "Properties", "kind": 1024, "children": [ - 667, 658, 660, 661, 671, 670, 668, 663, 672, 678, 657, 677, 666, 674, 664, 665, 669, - 673, 662, 675, 676, 659 + 686, 677, 679, 680, 690, 689, 687, 682, 691, 698, 676, 696, 685, 697, 693, 683, 684, + 688, 692, 681, 694, 695, 678 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 320, + "line": 325, "character": 17 } ] }, { - "id": 649, + "id": 668, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 650, + "id": 669, "name": "provider", "kind": 1024, "kindString": "Property", @@ -26203,7 +27840,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 312, + "line": 317, "character": 2 } ], @@ -26217,25 +27854,25 @@ { "title": "Properties", "kind": 1024, - "children": [650] + "children": [669] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 311, + "line": 316, "character": 17 } ], "indexSignature": { - "id": 651, + "id": 670, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 652, + "id": 671, "name": "key", "kind": 32768, "flags": {}, @@ -26252,14 +27889,14 @@ } }, { - "id": 679, + "id": 699, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 684, + "id": 704, "name": "data", "kind": 1024, "kindString": "Property", @@ -26273,7 +27910,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 374, + "line": 380, "character": 2 } ], @@ -26283,7 +27920,7 @@ } }, { - "id": 680, + "id": 700, "name": "email", "kind": 1024, "kindString": "Property", @@ -26296,7 +27933,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -26306,7 +27943,7 @@ } }, { - "id": 683, + "id": 703, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -26320,7 +27957,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -26330,7 +27967,7 @@ } }, { - "id": 682, + "id": 702, "name": "password", "kind": 1024, "kindString": "Property", @@ -26343,7 +27980,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -26353,7 +27990,7 @@ } }, { - "id": 681, + "id": 701, "name": "phone", "kind": 1024, "kindString": "Property", @@ -26366,7 +28003,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -26380,26 +28017,26 @@ { "title": "Properties", "kind": 1024, - "children": [684, 680, 683, 682, 681] + "children": [704, 700, 703, 702, 701] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 345, + "line": 351, "character": 17 } ] }, { - "id": 630, + "id": 648, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 639, + "id": 657, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -26409,7 +28046,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 279, + "line": 285, "character": 2 } ], @@ -26419,7 +28056,7 @@ } }, { - "id": 631, + "id": 649, "name": "id", "kind": 1024, "kindString": "Property", @@ -26427,7 +28064,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 272, + "line": 278, "character": 2 } ], @@ -26437,7 +28074,7 @@ } }, { - "id": 633, + "id": 651, "name": "identity_data", "kind": 1024, "kindString": "Property", @@ -26447,27 +28084,27 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 274, + "line": 280, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 634, + "id": 652, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 635, + "id": 653, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 636, + "id": 654, "name": "key", "kind": 32768, "flags": {}, @@ -26486,7 +28123,7 @@ } }, { - "id": 637, + "id": 655, "name": "identity_id", "kind": 1024, "kindString": "Property", @@ -26494,7 +28131,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 277, + "line": 283, "character": 2 } ], @@ -26504,7 +28141,7 @@ } }, { - "id": 640, + "id": 658, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -26514,7 +28151,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 280, + "line": 286, "character": 2 } ], @@ -26524,7 +28161,7 @@ } }, { - "id": 638, + "id": 656, "name": "provider", "kind": 1024, "kindString": "Property", @@ -26532,7 +28169,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 284, "character": 2 } ], @@ -26542,7 +28179,7 @@ } }, { - "id": 641, + "id": 659, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -26552,7 +28189,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 281, + "line": 287, "character": 2 } ], @@ -26562,7 +28199,7 @@ } }, { - "id": 632, + "id": 650, "name": "user_id", "kind": 1024, "kindString": "Property", @@ -26570,7 +28207,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 273, + "line": 279, "character": 2 } ], @@ -26584,19 +28221,19 @@ { "title": "Properties", "kind": 1024, - "children": [639, 631, 633, 637, 640, 638, 641, 632] + "children": [657, 649, 651, 655, 658, 656, 659, 650] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 271, + "line": 277, "character": 17 } ] }, { - "id": 653, + "id": 672, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -26604,19 +28241,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 316, + "line": 321, "character": 17 } ], "indexSignature": { - "id": 654, + "id": 673, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 655, + "id": 674, "name": "key", "kind": 32768, "flags": {}, @@ -26633,14 +28270,14 @@ } }, { - "id": 790, + "id": 811, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 791, + "id": 812, "name": "email", "kind": 1024, "kindString": "Property", @@ -26651,7 +28288,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 618, + "line": 636, "character": 2 } ], @@ -26661,7 +28298,7 @@ } }, { - "id": 794, + "id": 815, "name": "options", "kind": 1024, "kindString": "Property", @@ -26671,21 +28308,217 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 623, + "line": 641, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 795, + "id": 816, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 797, + "id": 818, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site.", + "tags": [ + { + "tag": "deprecated", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 649, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 817, + "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": 643, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [818, 817] + } + ] + } + } + }, + { + "id": 813, + "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": 638, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 814, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 640, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 823, + "name": "EmailOtpType", + "dereferenced": { + "id": 823, + "name": "EmailOtpType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 662, + "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" + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [812, 815, 813, 814] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 634, + "character": 17 + } + ] + }, + { + "id": 803, + "name": "VerifyMobileOtpParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 807, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 622, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 808, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 810, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -26714,7 +28547,7 @@ } }, { - "id": 796, + "id": 809, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -26727,7 +28560,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 625, + "line": 624, "character": 4 } ], @@ -26741,210 +28574,14 @@ { "title": "Properties", "kind": 1024, - "children": [797, 796] + "children": [810, 809] } ] } } }, { - "id": 792, - "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": 620, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 793, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 622, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 802, - "name": "EmailOtpType", - "dereferenced": { - "id": 802, - "name": "EmailOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 644, - "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" - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [791, 794, 792, 793] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 616, - "character": 17 - } - ] - }, - { - "id": 782, - "name": "VerifyMobileOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 786, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 604, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 787, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 789, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ - { - "tag": "deprecated", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 613, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 788, - "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": 606, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [789, 788] - } - ] - } - } - }, - { - "id": 783, + "id": 804, "name": "phone", "kind": 1024, "kindString": "Property", @@ -26955,7 +28592,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 599, + "line": 617, "character": 2 } ], @@ -26965,7 +28602,7 @@ } }, { - "id": 784, + "id": 805, "name": "token", "kind": 1024, "kindString": "Property", @@ -26976,7 +28613,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 601, + "line": 619, "character": 2 } ], @@ -26986,7 +28623,7 @@ } }, { - "id": 785, + "id": 806, "name": "type", "kind": 1024, "kindString": "Property", @@ -26997,16 +28634,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 603, + "line": 621, "character": 2 } ], "type": { "type": "reference", - "id": 801, + "id": 822, "name": "MobileOtpType", "dereferenced": { - "id": 801, + "id": 822, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -27014,7 +28651,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 643, + "line": 661, "character": 12 } ], @@ -27039,26 +28676,26 @@ { "title": "Properties", "kind": 1024, - "children": [786, 783, 784, 785] + "children": [807, 804, 805, 806] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 597, + "line": 615, "character": 17 } ] }, { - "id": 798, + "id": 819, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 799, + "id": 820, "name": "token_hash", "kind": 1024, "kindString": "Property", @@ -27069,7 +28706,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 637, + "line": 655, "character": 2 } ], @@ -27079,7 +28716,7 @@ } }, { - "id": 800, + "id": 821, "name": "type", "kind": 1024, "kindString": "Property", @@ -27090,16 +28727,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 640, + "line": 658, "character": 2 } ], "type": { "type": "reference", - "id": 802, + "id": 823, "name": "EmailOtpType", "dereferenced": { - "id": 802, + "id": 823, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -27107,7 +28744,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 662, "character": 12 } ], @@ -27148,19 +28785,19 @@ { "title": "Properties", "kind": 1024, - "children": [799, 800] + "children": [820, 821] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 635, + "line": 653, "character": 17 } ] }, { - "id": 480, + "id": 495, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -27168,7 +28805,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 30, + "line": 31, "character": 12 } ], @@ -27200,7 +28837,7 @@ "value": "USER_UPDATED" }, { - "id": 479, + "id": 494, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -27208,7 +28845,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 28, + "line": 29, "character": 12 } ], @@ -27221,7 +28858,7 @@ } }, { - "id": 479, + "id": 494, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -27229,7 +28866,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 28, + "line": 29, "character": 12 } ], @@ -27239,7 +28876,7 @@ } }, { - "id": 759, + "id": 779, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -27247,7 +28884,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 565, + "line": 583, "character": 12 } ], @@ -27266,7 +28903,7 @@ } }, { - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -27279,96 +28916,6 @@ } ] }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1028, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 997, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 998, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the MFA factor to delete." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1030, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 999, - "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": 1033, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [998, 999] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1028, - "character": 45 - } - ] - } - } - }, - { - "id": 987, - "name": "AuthMFAAdminDeleteFactorResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -27377,182 +28924,77 @@ } ], "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 988, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "type": "reflection", + "declaration": { + "id": 1006, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1007, + "name": "id", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ - { - "id": 989, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1017, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 990, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 991, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was successfully deleted." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1019, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [991] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1017, - "character": 12 - } - ] - } - } - }, - { - "id": 992, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1021, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [989, 992] - } - ], + "comment": { + "shortText": "ID of the MFA factor to delete." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 1016, - "character": 4 + "line": 1017, + "character": 2 } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 993, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1008, + "name": "userId", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ - { - "id": 994, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1023, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 995, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1023, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [994, 995] - } - ], + "comment": { + "shortText": "ID of the user whose factor is being deleted." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 1023, - "character": 4 + "line": 1020, + "character": 2 } - ] + ], + "type": { + "type": "intrinsic", + "name": "string" + } } - } - ] + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1007, 1008] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1015, + "character": 45 + } + ] + } } }, { - "id": 1009, - "name": "AuthMFAAdminListFactorsParams", + "id": 996, + "name": "AuthMFAAdminDeleteFactorResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, @@ -27567,61 +29009,187 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1002, "character": 12 } ], "type": { - "type": "reflection", - "declaration": { - "id": 1010, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1011, - "name": "userId", - "kind": 1024, - "kindString": "Property", + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 997, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "ID of the user." - }, + "children": [ + { + "id": 998, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1004, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 999, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1000, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor that was successfully deleted." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1006, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1000] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1004, + "character": 12 + } + ] + } + } + }, + { + "id": 1001, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1008, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [998, 1001] + } + ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1054, - "character": 2 + "line": 1003, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1002, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1003, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1010, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1004, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1010, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } } ], - "type": { - "type": "intrinsic", - "name": "string" - } + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1003, 1004] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1010, + "character": 4 + } + ] } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1011] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1052, - "character": 44 - } - ] - } + } + ] } }, { - "id": 1000, - "name": "AuthMFAAdminListFactorsResponse", + "id": 1018, + "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, @@ -27640,20 +29208,89 @@ "character": 12 } ], + "type": { + "type": "reflection", + "declaration": { + "id": 1019, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1020, + "name": "userId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1041, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1020] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1039, + "character": 44 + } + ] + } + } + }, + { + "id": 1009, + "name": "AuthMFAAdminListFactorsResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1026, + "character": 12 + } + ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { - "id": 1001, + "id": 1010, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1002, + "id": 1011, "name": "data", "kind": 1024, "kindString": "Property", @@ -27661,21 +29298,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1041, + "line": 1028, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 1003, + "id": 1012, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1004, + "id": 1013, "name": "factors", "kind": 1024, "kindString": "Property", @@ -27686,7 +29323,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1043, + "line": 1030, "character": 8 } ], @@ -27694,7 +29331,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 642, + "id": 660, "name": "Factor" } } @@ -27704,13 +29341,13 @@ { "title": "Properties", "kind": 1024, - "children": [1004] + "children": [1013] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1041, + "line": 1028, "character": 12 } ] @@ -27718,7 +29355,7 @@ } }, { - "id": 1005, + "id": 1014, "name": "error", "kind": 1024, "kindString": "Property", @@ -27726,7 +29363,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1045, + "line": 1032, "character": 6 } ], @@ -27740,13 +29377,13 @@ { "title": "Properties", "kind": 1024, - "children": [1002, 1005] + "children": [1011, 1014] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1040, + "line": 1027, "character": 4 } ] @@ -27755,14 +29392,14 @@ { "type": "reflection", "declaration": { - "id": 1006, + "id": 1015, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1007, + "id": 1016, "name": "data", "kind": 1024, "kindString": "Property", @@ -27770,7 +29407,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1047, + "line": 1034, "character": 6 } ], @@ -27780,7 +29417,7 @@ } }, { - "id": 1008, + "id": 1017, "name": "error", "kind": 1024, "kindString": "Property", @@ -27788,13 +29425,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1047, + "line": 1034, "character": 18 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -27803,13 +29440,13 @@ { "title": "Properties", "kind": 1024, - "children": [1007, 1008] + "children": [1016, 1017] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1047, + "line": 1034, "character": 4 } ] @@ -27819,7 +29456,7 @@ } }, { - "id": 935, + "id": 938, "name": "AuthMFAChallengeResponse", "kind": 4194304, "kindString": "Type alias", @@ -27827,7 +29464,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 872, "character": 12 } ], @@ -27837,14 +29474,14 @@ { "type": "reflection", "declaration": { - "id": 936, + "id": 939, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 937, + "id": 940, "name": "data", "kind": 1024, "kindString": "Property", @@ -27852,21 +29489,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 894, + "line": 874, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 938, + "id": 941, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 940, + "id": 944, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -27877,7 +29514,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 899, + "line": 882, "character": 8 } ], @@ -27887,7 +29524,7 @@ } }, { - "id": 939, + "id": 942, "name": "id", "kind": 1024, "kindString": "Property", @@ -27898,196 +29535,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 896, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [940, 939] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 894, - "character": 12 - } - ] - } - } - }, - { - "id": 941, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 901, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [937, 941] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 893, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 942, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 943, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 903, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 944, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 903, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [943, 944] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 903, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 910, - "name": "AuthMFAEnrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 847, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 911, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 912, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 849, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 913, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 921, - "name": "friendly_name", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 873, + "line": 876, "character": 8 } ], @@ -28097,357 +29545,18 @@ } }, { - "id": 914, - "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": 851, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 916, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "TOTP enrollment information." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 857, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 917, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 918, - "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": 861, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 919, - "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": 866, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 920, - "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": 870, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [918, 919, 920] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 857, - "character": 14 - } - ] - } - } - }, - { - "id": 915, + "id": 943, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor. Only `totp` supported for now." + "shortText": "Factor Type which generated the challenge" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 854, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [921, 914, 916, 915] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 849, - "character": 12 - } - ] - } - } - }, - { - "id": 922, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 875, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [912, 922] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 848, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 923, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 924, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 878, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 925, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 879, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [924, 925] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 877, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 956, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 920, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 957, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 958, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 922, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 959, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 962, - "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": 939, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 627, - "name": "AMREntry" - } - } - }, - { - "id": 960, - "name": "currentLevel", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Current AAL level of the session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 924, + "line": 879, "character": 8 } ], @@ -28455,50 +29564,12 @@ "type": "union", "types": [ { - "type": "reference", - "id": 955, - "name": "AuthenticatorAssuranceLevels" + "type": "literal", + "value": "totp" }, { "type": "literal", - "value": null - } - ] - } - }, - { - "id": 961, - "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": 932, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 955, - "name": "AuthenticatorAssuranceLevels" - }, - { - "type": "literal", - "value": null + "value": "phone" } ] } @@ -28508,13 +29579,13 @@ { "title": "Properties", "kind": 1024, - "children": [962, 960, 961] + "children": [944, 942, 943] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 922, + "line": 874, "character": 12 } ] @@ -28522,7 +29593,7 @@ } }, { - "id": 963, + "id": 945, "name": "error", "kind": 1024, "kindString": "Property", @@ -28530,7 +29601,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 941, + "line": 884, "character": 6 } ], @@ -28544,100 +29615,18 @@ { "title": "Properties", "kind": 1024, - "children": [958, 963] + "children": [940, 945] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 921, + "line": 873, "character": 4 } ] } }, - { - "type": "reflection", - "declaration": { - "id": 964, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 965, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 943, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 966, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 943, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [965, 966] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 943, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 945, - "name": "AuthMFAListFactorsResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 905, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ { "type": "reflection", "declaration": { @@ -28656,89 +29645,17 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 907, + "line": 886, "character": 6 } ], "type": { - "type": "reflection", - "declaration": { - "id": 948, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 949, - "name": "all", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "All available factors (verified and unverified)." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 909, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 642, - "name": "Factor" - } - } - }, - { - "id": 950, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Only verified TOTP factors. (A subset of `all`.)" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 912, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 642, - "name": "Factor" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [949, 950] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 907, - "character": 12 - } - ] - } + "type": "literal", + "value": null } }, { - "id": 951, + "id": 948, "name": "error", "kind": 1024, "kindString": "Property", @@ -28746,7 +29663,197 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 914, + "line": 886, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [947, 948] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 886, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 1081, + "name": "AuthMFAEnrollPhoneResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1181, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1082, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1083, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1183, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1084, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1087, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1191, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1085, + "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": 1185, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1088, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number of the MFA factor in E.164 format. Used to send messages" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1194, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1086, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1188, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1087, 1085, 1088, 1086] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1183, + "character": 12 + } + ] + } + } + }, + { + "id": 1089, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1196, "character": 6 } ], @@ -28760,7 +29867,1211 @@ { "title": "Properties", "kind": 1024, - "children": [947, 951] + "children": [1083, 1089] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1182, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1090, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1091, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1199, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1092, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1200, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1091, 1092] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1198, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 928, + "name": "AuthMFAEnrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 860, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "id": 1065, + "name": "AuthMFAEnrollTOTPResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1146, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1066, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1067, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1148, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1068, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1076, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1172, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1069, + "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": 1150, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1071, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "TOTP enrollment information." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1156, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1072, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1073, + "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": 1160, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1074, + "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": 1165, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1075, + "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": 1169, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1073, 1074, 1075] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1156, + "character": 14 + } + ] + } + } + }, + { + "id": 1070, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1153, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1076, 1069, 1071, 1070] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1148, + "character": 12 + } + ] + } + } + }, + { + "id": 1077, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1174, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1067, 1077] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1147, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1078, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1079, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1177, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1080, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1178, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1079, 1080] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1176, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 1081, + "name": "AuthMFAEnrollPhoneResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1181, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1082, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1083, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1183, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1084, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1087, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1191, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1085, + "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": 1185, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1088, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number of the MFA factor in E.164 format. Used to send messages" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1194, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1086, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1188, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1087, 1085, 1088, 1086] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1183, + "character": 12 + } + ] + } + } + }, + { + "id": 1089, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1196, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1083, 1089] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1182, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1090, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1091, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1199, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1092, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1200, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1091, 1092] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1198, + "character": 4 + } + ] + } + } + ] + } + } + ] + } + }, + { + "id": 1065, + "name": "AuthMFAEnrollTOTPResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1146, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1066, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1067, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1148, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1068, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1076, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1172, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1069, + "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": 1150, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1071, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "TOTP enrollment information." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1156, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1072, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1073, + "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": 1160, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1074, + "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": 1165, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1075, + "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": 1169, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1073, 1074, 1075] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1156, + "character": 14 + } + ] + } + } + }, + { + "id": 1070, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1153, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1076, 1069, 1071, 1070] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1148, + "character": 12 + } + ] + } + } + }, + { + "id": 1077, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1174, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1067, 1077] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1147, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1078, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1079, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1177, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1080, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1178, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1079, 1080] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1176, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 961, + "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 905, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 962, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 963, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 907, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 964, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 967, + "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": 924, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 644, + "name": "AMREntry" + } + } + }, + { + "id": 965, + "name": "currentLevel", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Current AAL level of the session." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 909, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 960, + "name": "AuthenticatorAssuranceLevels" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 966, + "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": 917, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 960, + "name": "AuthenticatorAssuranceLevels" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [967, 965, 966] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 907, + "character": 12 + } + ] + } + } + }, + { + "id": 968, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 926, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [963, 968] } ], "sources": [ @@ -28775,14 +31086,14 @@ { "type": "reflection", "declaration": { - "id": 952, + "id": 969, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 953, + "id": 970, "name": "data", "kind": 1024, "kindString": "Property", @@ -28790,7 +31101,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 916, + "line": 928, "character": 6 } ], @@ -28800,7 +31111,7 @@ } }, { - "id": 954, + "id": 971, "name": "error", "kind": 1024, "kindString": "Property", @@ -28808,13 +31119,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 916, + "line": 928, "character": 18 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -28823,13 +31134,13 @@ { "title": "Properties", "kind": 1024, - "children": [953, 954] + "children": [970, 971] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 916, + "line": 928, "character": 4 } ] @@ -28839,15 +31150,15 @@ } }, { - "id": 926, - "name": "AuthMFAUnenrollResponse", + "id": 949, + "name": "AuthMFAListFactorsResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 882, + "line": 888, "character": 12 } ], @@ -28857,14 +31168,14 @@ { "type": "reflection", "declaration": { - "id": 927, + "id": 950, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 928, + "id": 951, "name": "data", "kind": 1024, "kindString": "Property", @@ -28872,21 +31183,262 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 884, + "line": 890, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 929, + "id": 952, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 930, + "id": 953, + "name": "all", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "All available factors (verified and unverified)." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 892, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + }, + { + "id": 955, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Only verified Phone factors. (A subset of `all`.)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 897, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + }, + { + "id": 954, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Only verified TOTP factors. (A subset of `all`.)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 895, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [953, 955, 954] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 890, + "character": 12 + } + ] + } + } + }, + { + "id": 956, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 899, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [951, 956] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 889, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 957, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 958, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 901, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 959, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 901, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [958, 959] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 901, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 929, + "name": "AuthMFAUnenrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 862, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 930, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 931, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 864, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 932, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 933, "name": "id", "kind": 1024, "kindString": "Property", @@ -28897,7 +31449,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 886, + "line": 866, "character": 8 } ], @@ -28911,81 +31463,19 @@ { "title": "Properties", "kind": 1024, - "children": [930] + "children": [933] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 884, + "line": 864, "character": 12 } ] } } }, - { - "id": 931, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 888, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [928, 931] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 883, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 932, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 933, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 890, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, { "id": 934, "name": "error", @@ -28995,13 +31485,75 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 890, + "line": 868, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [931, 934] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 863, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 935, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 936, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 870, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 937, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 870, "character": 18 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -29010,13 +31562,13 @@ { "title": "Properties", "kind": 1024, - "children": [933, 934] + "children": [936, 937] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 890, + "line": 870, "character": 4 } ] @@ -29026,7 +31578,7 @@ } }, { - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse", "kind": 4194304, "kindString": "Type alias", @@ -29034,7 +31586,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 822, + "line": 835, "character": 12 } ], @@ -29044,14 +31596,14 @@ { "type": "reflection", "declaration": { - "id": 898, + "id": 916, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 899, + "id": 917, "name": "data", "kind": 1024, "kindString": "Property", @@ -29059,21 +31611,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 824, + "line": 837, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 900, + "id": 918, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 901, + "id": 919, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -29084,7 +31636,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 826, + "line": 839, "character": 8 } ], @@ -29094,7 +31646,7 @@ } }, { - "id": 903, + "id": 921, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -29105,7 +31657,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 832, + "line": 845, "character": 8 } ], @@ -29115,7 +31667,7 @@ } }, { - "id": 904, + "id": 922, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -29126,7 +31678,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 835, + "line": 848, "character": 8 } ], @@ -29136,7 +31688,7 @@ } }, { - "id": 902, + "id": 920, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -29147,7 +31699,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 829, + "line": 842, "character": 8 } ], @@ -29157,7 +31709,7 @@ } }, { - "id": 905, + "id": 923, "name": "user", "kind": 1024, "kindString": "Property", @@ -29168,13 +31720,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 838, + "line": 851, "character": 8 } ], "type": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } } @@ -29183,13 +31735,13 @@ { "title": "Properties", "kind": 1024, - "children": [901, 903, 904, 902, 905] + "children": [919, 921, 922, 920, 923] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 824, + "line": 837, "character": 12 } ] @@ -29197,7 +31749,7 @@ } }, { - "id": 906, + "id": 924, "name": "error", "kind": 1024, "kindString": "Property", @@ -29205,7 +31757,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 840, + "line": 853, "character": 6 } ], @@ -29219,13 +31771,13 @@ { "title": "Properties", "kind": 1024, - "children": [899, 906] + "children": [917, 924] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 823, + "line": 836, "character": 4 } ] @@ -29234,14 +31786,14 @@ { "type": "reflection", "declaration": { - "id": 907, + "id": 925, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 908, + "id": 926, "name": "data", "kind": 1024, "kindString": "Property", @@ -29249,7 +31801,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 843, + "line": 856, "character": 6 } ], @@ -29259,7 +31811,7 @@ } }, { - "id": 909, + "id": 927, "name": "error", "kind": 1024, "kindString": "Property", @@ -29267,13 +31819,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 844, + "line": 857, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -29282,13 +31834,13 @@ { "title": "Properties", "kind": 1024, - "children": [908, 909] + "children": [926, 927] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 842, + "line": 855, "character": 4 } ] @@ -29298,19 +31850,19 @@ } }, { - "id": 542, + "id": 559, "name": "AuthOtpResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "AuthOtpResponse is returned when OTP is used.", - "text": "{@see AuthRsponse}\n" + "text": "{@see AuthResponse}\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 129, + "line": 135, "character": 12 } ], @@ -29320,14 +31872,14 @@ { "type": "reflection", "declaration": { - "id": 543, + "id": 560, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 544, + "id": 561, "name": "data", "kind": 1024, "kindString": "Property", @@ -29335,21 +31887,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 545, + "id": 562, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 548, + "id": 565, "name": "messageId", "kind": 1024, "kindString": "Property", @@ -29359,7 +31911,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 41 } ], @@ -29378,7 +31930,7 @@ } }, { - "id": 547, + "id": 564, "name": "session", "kind": 1024, "kindString": "Property", @@ -29386,7 +31938,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 26 } ], @@ -29396,7 +31948,7 @@ } }, { - "id": 546, + "id": 563, "name": "user", "kind": 1024, "kindString": "Property", @@ -29404,7 +31956,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 14 } ], @@ -29418,13 +31970,13 @@ { "title": "Properties", "kind": 1024, - "children": [548, 547, 546] + "children": [565, 564, 563] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 12 } ] @@ -29432,7 +31984,7 @@ } }, { - "id": 549, + "id": 566, "name": "error", "kind": 1024, "kindString": "Property", @@ -29440,7 +31992,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 132, + "line": 138, "character": 6 } ], @@ -29454,13 +32006,13 @@ { "title": "Properties", "kind": 1024, - "children": [544, 549] + "children": [561, 566] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 136, "character": 4 } ] @@ -29469,773 +32021,14 @@ { "type": "reflection", "declaration": { - "id": 550, + "id": 567, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 551, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 552, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 555, - "name": "messageId", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 41 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 554, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 26 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 553, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [555, 554, 553] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 12 - } - ] - } - } - }, - { - "id": 556, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 136, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [551, 556] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 134, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 515, - "name": "AuthResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 91, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 516, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 517, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 518, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 95, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 618, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 519, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 94, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 656, - "name": "User" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [520, 519] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 12 - } - ] - } - } - }, - { - "id": 521, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 97, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [517, 521] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 92, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 522, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 523, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 524, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 526, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 102, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 525, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [526, 525] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 12 - } - ] - } - } - }, - { - "id": 527, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 104, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [523, 527] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 99, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 528, - "name": "AuthResponsePassword", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 107, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 529, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 530, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 531, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 533, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 618, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 532, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 110, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 656, - "name": "User" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 534, - "name": "weak_password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 112, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 511, - "name": "WeakPassword" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [533, 532, 534] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 12 - } - ] - } - } - }, - { - "id": 535, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 114, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [530, 535] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 536, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 537, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 117, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 538, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 540, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 119, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 539, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 118, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [540, 539] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 117, - "character": 12 - } - ] - } - } - }, - { - "id": 541, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 121, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [537, 541] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 116, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 557, - "name": "AuthTokenResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 139, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 558, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 559, + "id": 568, "name": "data", "kind": 1024, "kindString": "Property", @@ -30250,14 +32043,43 @@ "type": { "type": "reflection", "declaration": { - "id": 560, + "id": 569, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 562, + "id": 572, + "name": "messageId", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 141, + "character": 41 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 571, "name": "session", "kind": 1024, "kindString": "Property", @@ -30265,18 +32087,17 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 143, - "character": 8 + "line": 141, + "character": 26 } ], "type": { - "type": "reference", - "id": 618, - "name": "Session" + "type": "literal", + "value": null } }, { - "id": 561, + "id": 570, "name": "user", "kind": 1024, "kindString": "Property", @@ -30284,14 +32105,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 142, - "character": 8 + "line": 141, + "character": 14 } ], "type": { - "type": "reference", - "id": 656, - "name": "User" + "type": "literal", + "value": null } } ], @@ -30299,7 +32119,7 @@ { "title": "Properties", "kind": 1024, - "children": [562, 561] + "children": [572, 571, 570] } ], "sources": [ @@ -30313,7 +32133,7 @@ } }, { - "id": 563, + "id": 573, "name": "error", "kind": 1024, "kindString": "Property", @@ -30321,7 +32141,167 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 145, + "line": 142, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [568, 573] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 140, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 532, + "name": "AuthResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 97, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 533, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 534, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 99, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 535, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 537, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 101, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 635, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 536, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 675, + "name": "User" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [537, 536] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 99, + "character": 12 + } + ] + } + } + }, + { + "id": 538, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 103, "character": 6 } ], @@ -30335,13 +32315,13 @@ { "title": "Properties", "kind": 1024, - "children": [559, 563] + "children": [534, 538] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 140, + "line": 98, "character": 4 } ] @@ -30350,14 +32330,14 @@ { "type": "reflection", "declaration": { - "id": 564, + "id": 539, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 565, + "id": 540, "name": "data", "kind": 1024, "kindString": "Property", @@ -30365,21 +32345,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 148, + "line": 106, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 566, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 568, + "id": 543, "name": "session", "kind": 1024, "kindString": "Property", @@ -30387,7 +32367,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 150, + "line": 108, "character": 8 } ], @@ -30397,11 +32377,443 @@ } }, { - "id": 567, + "id": 542, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 107, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [543, 542] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 106, + "character": 12 + } + ] + } + } + }, + { + "id": 544, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 110, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [540, 544] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 105, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 545, + "name": "AuthResponsePassword", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 546, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 547, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 548, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 550, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 117, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 635, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 549, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 116, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 675, + "name": "User" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 551, + "name": "weak_password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 118, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 528, + "name": "WeakPassword" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [550, 549, 551] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 12 + } + ] + } + } + }, + { + "id": 552, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 120, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [547, 552] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 114, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 553, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 554, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 123, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 555, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 557, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 125, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 556, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 124, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [557, 556] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 123, + "character": 12 + } + ] + } + } + }, + { + "id": 558, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 127, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [554, 558] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 122, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 574, + "name": "AuthTokenResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 145, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 575, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 576, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 147, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 577, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 579, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -30409,136 +32821,14 @@ "character": 8 } ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [568, 567] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 148, - "character": 12 - } - ] - } - } - }, - { - "id": 569, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 152, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [565, 569] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 147, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 570, - "name": "AuthTokenResponsePassword", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 155, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 571, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 572, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 573, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 575, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 159, - "character": 8 - } - ], "type": { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } }, { - "id": 574, + "id": 578, "name": "user", "kind": 1024, "kindString": "Property", @@ -30546,49 +32836,28 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 158, + "line": 148, "character": 8 } ], "type": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } - }, - { - "id": 576, - "name": "weakPassword", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 160, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 511, - "name": "WeakPassword" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [575, 574, 576] + "children": [579, 578] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 157, + "line": 147, "character": 12 } ] @@ -30596,7 +32865,7 @@ } }, { - "id": 577, + "id": 580, "name": "error", "kind": 1024, "kindString": "Property", @@ -30604,7 +32873,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 162, + "line": 151, "character": 6 } ], @@ -30618,13 +32887,13 @@ { "title": "Properties", "kind": 1024, - "children": [572, 577] + "children": [576, 580] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 156, + "line": 146, "character": 4 } ] @@ -30633,14 +32902,14 @@ { "type": "reflection", "declaration": { - "id": 578, + "id": 581, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 579, + "id": 582, "name": "data", "kind": 1024, "kindString": "Property", @@ -30648,21 +32917,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 154, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 583, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 585, "name": "session", "kind": 1024, "kindString": "Property", @@ -30670,7 +32939,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 167, + "line": 156, "character": 8 } ], @@ -30680,7 +32949,7 @@ } }, { - "id": 581, + "id": 584, "name": "user", "kind": 1024, "kindString": "Property", @@ -30688,27 +32957,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 166, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 583, - "name": "weakPassword", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 168, + "line": 155, "character": 8 } ], @@ -30722,13 +32971,13 @@ { "title": "Properties", "kind": 1024, - "children": [582, 581, 583] + "children": [585, 584] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 154, "character": 12 } ] @@ -30736,7 +32985,7 @@ } }, { - "id": 584, + "id": 586, "name": "error", "kind": 1024, "kindString": "Property", @@ -30744,13 +32993,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 170, + "line": 158, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -30759,13 +33008,13 @@ { "title": "Properties", "kind": 1024, - "children": [579, 584] + "children": [582, 586] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 164, + "line": 153, "character": 4 } ] @@ -30775,7 +33024,310 @@ } }, { - "id": 955, + "id": 587, + "name": "AuthTokenResponsePassword", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 161, + "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": 163, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 590, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 592, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 165, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 635, + "name": "Session" + } + }, + { + "id": 591, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 164, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 675, + "name": "User" + } + }, + { + "id": 593, + "name": "weakPassword", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 166, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 528, + "name": "WeakPassword" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [592, 591, 593] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 163, + "character": 12 + } + ] + } + } + }, + { + "id": 594, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 168, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [589, 594] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 162, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 595, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 596, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 171, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 597, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 599, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 173, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 598, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 172, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 600, + "name": "weakPassword", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 174, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [599, 598, 600] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 171, + "character": 12 + } + ] + } + } + }, + { + "id": 601, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 176, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [596, 601] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 170, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 960, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -30783,7 +33335,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 918, + "line": 903, "character": 12 } ], @@ -30802,7 +33354,7 @@ } }, { - "id": 1025, + "id": 1034, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -30810,7 +33362,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1104, + "line": 1091, "character": 12 } ], @@ -30820,14 +33372,14 @@ { "type": "reflection", "declaration": { - "id": 1026, + "id": 1035, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1028, + "id": 1037, "name": "error", "kind": 1024, "kindString": "Property", @@ -30835,7 +33387,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1107, + "line": 1094, "character": 6 } ], @@ -30845,7 +33397,7 @@ } }, { - "id": 1027, + "id": 1036, "name": "session", "kind": 1024, "kindString": "Property", @@ -30853,13 +33405,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1106, + "line": 1093, "character": 6 } ], "type": { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } } @@ -30868,13 +33420,13 @@ { "title": "Properties", "kind": 1024, - "children": [1028, 1027] + "children": [1037, 1036] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1105, + "line": 1092, "character": 4 } ] @@ -30883,14 +33435,14 @@ { "type": "reflection", "declaration": { - "id": 1029, + "id": 1038, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1031, + "id": 1040, "name": "error", "kind": 1024, "kindString": "Property", @@ -30898,18 +33450,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1111, + "line": 1098, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } }, { - "id": 1030, + "id": 1039, "name": "session", "kind": 1024, "kindString": "Property", @@ -30917,7 +33469,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1110, + "line": 1097, "character": 6 } ], @@ -30931,13 +33483,13 @@ { "title": "Properties", "kind": 1024, - "children": [1031, 1030] + "children": [1040, 1039] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1109, + "line": 1096, "character": 4 } ] @@ -30947,7 +33499,7 @@ } }, { - "id": 802, + "id": 823, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -30955,7 +33507,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 662, "character": 12 } ], @@ -30990,7 +33542,7 @@ } }, { - "id": 846, + "id": 867, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -30998,21 +33550,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 847, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 849, + "id": 870, "name": "email", "kind": 1024, "kindString": "Property", @@ -31023,7 +33575,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 714, + "line": 732, "character": 2 } ], @@ -31033,7 +33585,7 @@ } }, { - "id": 850, + "id": 871, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -31044,7 +33596,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 718, + "line": 736, "character": 2 } ], @@ -31054,7 +33606,7 @@ } }, { - "id": 851, + "id": 872, "name": "options", "kind": 1024, "kindString": "Property", @@ -31064,7 +33616,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 719, + "line": 737, "character": 2 } ], @@ -31073,7 +33625,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -31087,7 +33639,7 @@ } }, { - "id": 848, + "id": 869, "name": "type", "kind": 1024, "kindString": "Property", @@ -31095,7 +33647,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 712, + "line": 730, "character": 2 } ], @@ -31118,13 +33670,13 @@ { "title": "Properties", "kind": 1024, - "children": [849, 850, 851, 848] + "children": [870, 871, 872, 869] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 44 } ] @@ -31132,7 +33684,7 @@ } }, { - "id": 836, + "id": 857, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -31140,21 +33692,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 837, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 839, + "id": 860, "name": "email", "kind": 1024, "kindString": "Property", @@ -31165,7 +33717,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 700, + "line": 718, "character": 2 } ], @@ -31175,7 +33727,7 @@ } }, { - "id": 840, + "id": 861, "name": "options", "kind": 1024, "kindString": "Property", @@ -31185,7 +33737,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 701, + "line": 719, "character": 2 } ], @@ -31194,7 +33746,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -31217,7 +33769,7 @@ } }, { - "id": 838, + "id": 859, "name": "type", "kind": 1024, "kindString": "Property", @@ -31225,7 +33777,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 698, + "line": 716, "character": 2 } ], @@ -31248,13 +33800,13 @@ { "title": "Properties", "kind": 1024, - "children": [839, 840, 838] + "children": [860, 861, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 46 } ] @@ -31262,7 +33814,7 @@ } }, { - "id": 855, + "id": 876, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -31270,7 +33822,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 733, + "line": 751, "character": 12 } ], @@ -31278,7 +33830,7 @@ "type": "union", "types": [ { - "id": 830, + "id": 851, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -31286,21 +33838,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 831, + "id": 852, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 854, "name": "email", "kind": 1024, "kindString": "Property", @@ -31308,7 +33860,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 692, + "line": 710, "character": 2 } ], @@ -31318,7 +33870,7 @@ } }, { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -31328,7 +33880,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 694, + "line": 712, "character": 2 } ], @@ -31337,7 +33889,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -31360,7 +33912,7 @@ } }, { - "id": 834, + "id": 855, "name": "password", "kind": 1024, "kindString": "Property", @@ -31368,7 +33920,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 693, + "line": 711, "character": 2 } ], @@ -31378,7 +33930,7 @@ } }, { - "id": 832, + "id": 853, "name": "type", "kind": 1024, "kindString": "Property", @@ -31386,7 +33938,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 691, + "line": 709, "character": 2 } ], @@ -31400,13 +33952,13 @@ { "title": "Properties", "kind": 1024, - "children": [833, 835, 834, 832] + "children": [854, 856, 855, 853] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 39 } ] @@ -31414,7 +33966,7 @@ } }, { - "id": 836, + "id": 857, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -31422,21 +33974,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 837, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 839, + "id": 860, "name": "email", "kind": 1024, "kindString": "Property", @@ -31447,7 +33999,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 700, + "line": 718, "character": 2 } ], @@ -31457,7 +34009,7 @@ } }, { - "id": 840, + "id": 861, "name": "options", "kind": 1024, "kindString": "Property", @@ -31467,7 +34019,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 701, + "line": 719, "character": 2 } ], @@ -31476,7 +34028,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -31499,7 +34051,7 @@ } }, { - "id": 838, + "id": 859, "name": "type", "kind": 1024, "kindString": "Property", @@ -31507,7 +34059,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 698, + "line": 716, "character": 2 } ], @@ -31530,13 +34082,13 @@ { "title": "Properties", "kind": 1024, - "children": [839, 840, 838] + "children": [860, 861, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 46 } ] @@ -31544,7 +34096,7 @@ } }, { - "id": 841, + "id": 862, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -31552,21 +34104,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "email", "kind": 1024, "kindString": "Property", @@ -31577,7 +34129,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 707, + "line": 725, "character": 2 } ], @@ -31587,7 +34139,7 @@ } }, { - "id": 845, + "id": 866, "name": "options", "kind": 1024, "kindString": "Property", @@ -31597,7 +34149,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 708, + "line": 726, "character": 2 } ], @@ -31606,7 +34158,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -31620,7 +34172,7 @@ } }, { - "id": 843, + "id": 864, "name": "type", "kind": 1024, "kindString": "Property", @@ -31628,7 +34180,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 705, + "line": 723, "character": 2 } ], @@ -31642,13 +34194,13 @@ { "title": "Properties", "kind": 1024, - "children": [844, 845, 843] + "children": [865, 866, 864] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 41 } ] @@ -31656,7 +34208,7 @@ } }, { - "id": 846, + "id": 867, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -31664,21 +34216,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 847, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 849, + "id": 870, "name": "email", "kind": 1024, "kindString": "Property", @@ -31689,7 +34241,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 714, + "line": 732, "character": 2 } ], @@ -31699,7 +34251,7 @@ } }, { - "id": 850, + "id": 871, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -31710,7 +34262,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 718, + "line": 736, "character": 2 } ], @@ -31720,7 +34272,7 @@ } }, { - "id": 851, + "id": 872, "name": "options", "kind": 1024, "kindString": "Property", @@ -31730,7 +34282,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 719, + "line": 737, "character": 2 } ], @@ -31739,7 +34291,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -31753,7 +34305,7 @@ } }, { - "id": 848, + "id": 869, "name": "type", "kind": 1024, "kindString": "Property", @@ -31761,7 +34313,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 712, + "line": 730, "character": 2 } ], @@ -31784,13 +34336,13 @@ { "title": "Properties", "kind": 1024, - "children": [849, 850, 851, 848] + "children": [870, 871, 872, 869] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 44 } ] @@ -31801,7 +34353,7 @@ } }, { - "id": 869, + "id": 890, "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", @@ -31812,21 +34364,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 756, + "line": 774, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 870, + "id": 891, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 871, + "id": 892, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -31837,7 +34389,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 761, + "line": 779, "character": 2 } ], @@ -31847,7 +34399,7 @@ } }, { - "id": 872, + "id": 893, "name": "email_otp", "kind": 1024, "kindString": "Property", @@ -31858,7 +34410,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 766, + "line": 784, "character": 2 } ], @@ -31868,7 +34420,7 @@ } }, { - "id": 873, + "id": 894, "name": "hashed_token", "kind": 1024, "kindString": "Property", @@ -31879,7 +34431,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 770, + "line": 788, "character": 2 } ], @@ -31889,7 +34441,7 @@ } }, { - "id": 874, + "id": 895, "name": "redirect_to", "kind": 1024, "kindString": "Property", @@ -31900,7 +34452,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 772, + "line": 790, "character": 2 } ], @@ -31910,7 +34462,7 @@ } }, { - "id": 875, + "id": 896, "name": "verification_type", "kind": 1024, "kindString": "Property", @@ -31921,16 +34473,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 774, + "line": 792, "character": 2 } ], "type": { "type": "reference", - "id": 876, + "id": 897, "name": "GenerateLinkType", "dereferenced": { - "id": 876, + "id": 897, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -31938,7 +34490,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 777, + "line": 795, "character": 12 } ], @@ -31979,13 +34531,13 @@ { "title": "Properties", "kind": 1024, - "children": [871, 872, 873, 874, 875] + "children": [892, 893, 894, 895, 896] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 756, + "line": 774, "character": 37 } ] @@ -31993,7 +34545,7 @@ } }, { - "id": 856, + "id": 877, "name": "GenerateLinkResponse", "kind": 4194304, "kindString": "Type alias", @@ -32001,7 +34553,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 739, + "line": 757, "character": 12 } ], @@ -32011,14 +34563,14 @@ { "type": "reflection", "declaration": { - "id": 857, + "id": 878, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 858, + "id": 879, "name": "data", "kind": 1024, "kindString": "Property", @@ -32026,21 +34578,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 741, + "line": 759, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 859, + "id": 880, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 860, + "id": 881, "name": "properties", "kind": 1024, "kindString": "Property", @@ -32048,18 +34600,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 742, + "line": 760, "character": 8 } ], "type": { "type": "reference", - "id": 869, + "id": 890, "name": "GenerateLinkProperties" } }, { - "id": 861, + "id": 882, "name": "user", "kind": 1024, "kindString": "Property", @@ -32067,13 +34619,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 743, + "line": 761, "character": 8 } ], "type": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } } @@ -32082,13 +34634,13 @@ { "title": "Properties", "kind": 1024, - "children": [860, 861] + "children": [881, 882] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 741, + "line": 759, "character": 12 } ] @@ -32096,7 +34648,7 @@ } }, { - "id": 862, + "id": 883, "name": "error", "kind": 1024, "kindString": "Property", @@ -32104,7 +34656,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 745, + "line": 763, "character": 6 } ], @@ -32118,13 +34670,13 @@ { "title": "Properties", "kind": 1024, - "children": [858, 862] + "children": [879, 883] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 740, + "line": 758, "character": 4 } ] @@ -32133,14 +34685,14 @@ { "type": "reflection", "declaration": { - "id": 863, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 864, + "id": 885, "name": "data", "kind": 1024, "kindString": "Property", @@ -32148,21 +34700,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 748, + "line": 766, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 865, + "id": 886, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 866, + "id": 887, "name": "properties", "kind": 1024, "kindString": "Property", @@ -32170,7 +34722,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 749, + "line": 767, "character": 8 } ], @@ -32180,7 +34732,7 @@ } }, { - "id": 867, + "id": 888, "name": "user", "kind": 1024, "kindString": "Property", @@ -32188,7 +34740,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 750, + "line": 768, "character": 8 } ], @@ -32202,13 +34754,13 @@ { "title": "Properties", "kind": 1024, - "children": [866, 867] + "children": [887, 888] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 748, + "line": 766, "character": 12 } ] @@ -32216,7 +34768,7 @@ } }, { - "id": 868, + "id": 889, "name": "error", "kind": 1024, "kindString": "Property", @@ -32224,13 +34776,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 752, + "line": 770, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -32239,13 +34791,13 @@ { "title": "Properties", "kind": 1024, - "children": [864, 868] + "children": [885, 889] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 747, + "line": 765, "character": 4 } ] @@ -32255,7 +34807,7 @@ } }, { - "id": 876, + "id": 897, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -32263,7 +34815,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 777, + "line": 795, "character": 12 } ], @@ -32298,7 +34850,7 @@ } }, { - "id": 841, + "id": 862, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -32306,21 +34858,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "email", "kind": 1024, "kindString": "Property", @@ -32331,7 +34883,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 707, + "line": 725, "character": 2 } ], @@ -32341,7 +34893,7 @@ } }, { - "id": 845, + "id": 866, "name": "options", "kind": 1024, "kindString": "Property", @@ -32351,7 +34903,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 708, + "line": 726, "character": 2 } ], @@ -32360,7 +34912,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -32374,7 +34926,7 @@ } }, { - "id": 843, + "id": 864, "name": "type", "kind": 1024, "kindString": "Property", @@ -32382,7 +34934,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 705, + "line": 723, "character": 2 } ], @@ -32396,13 +34948,13 @@ { "title": "Properties", "kind": 1024, - "children": [844, 845, 843] + "children": [865, 866, 864] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 41 } ] @@ -32410,7 +34962,7 @@ } }, { - "id": 830, + "id": 851, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -32418,21 +34970,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 831, + "id": 852, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 854, "name": "email", "kind": 1024, "kindString": "Property", @@ -32440,7 +34992,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 692, + "line": 710, "character": 2 } ], @@ -32450,7 +35002,7 @@ } }, { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -32460,7 +35012,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 694, + "line": 712, "character": 2 } ], @@ -32469,7 +35021,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -32492,7 +35044,7 @@ } }, { - "id": 834, + "id": 855, "name": "password", "kind": 1024, "kindString": "Property", @@ -32500,7 +35052,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 693, + "line": 711, "character": 2 } ], @@ -32510,7 +35062,7 @@ } }, { - "id": 832, + "id": 853, "name": "type", "kind": 1024, "kindString": "Property", @@ -32518,7 +35070,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 691, + "line": 709, "character": 2 } ], @@ -32532,13 +35084,13 @@ { "title": "Properties", "kind": 1024, - "children": [833, 835, 834, 832] + "children": [854, 856, 855, 853] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 39 } ] @@ -32546,7 +35098,7 @@ } }, { - "id": 490, + "id": 505, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -32554,21 +35106,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 491, + "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 499, + "id": 514, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -32578,7 +35130,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 66, + "line": 67, "character": 2 } ], @@ -32588,7 +35140,7 @@ } }, { - "id": 504, + "id": 519, "name": "debug", "kind": 1024, "kindString": "Property", @@ -32598,7 +35150,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 76, + "line": 77, "character": 2 } ], @@ -32612,7 +35164,7 @@ { "type": "reflection", "declaration": { - "id": 505, + "id": 520, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -32620,20 +35172,20 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 76, + "line": 77, "character": 21 } ], "signatures": [ { - "id": 506, + "id": 521, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 522, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -32644,7 +35196,7 @@ } }, { - "id": 508, + "id": 523, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -32672,7 +35224,7 @@ } }, { - "id": 498, + "id": 513, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -32682,7 +35234,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 65, "character": 2 } ], @@ -32692,7 +35244,7 @@ } }, { - "id": 502, + "id": 517, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -32702,7 +35254,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 72, + "line": 73, "character": 2 } ], @@ -32712,7 +35264,7 @@ } }, { - "id": 503, + "id": 518, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -32722,16 +35274,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 75, "character": 2 } ], "type": { "type": "reference", - "id": 759, + "id": 779, "name": "AuthFlowType", "dereferenced": { - "id": 759, + "id": 779, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -32739,7 +35291,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 565, + "line": 583, "character": 12 } ], @@ -32760,7 +35312,36 @@ } }, { - "id": 493, + "id": 525, + "name": "hasCustomAuthorizationHeader", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set to \"true\" if there is a custom authorization header set globally.", + "tags": [ + { + "tag": "experimental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 508, "name": "headers", "kind": 1024, "kindString": "Property", @@ -32770,14 +35351,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 61, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 494, + "id": 509, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -32785,19 +35366,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 61, "character": 12 } ], "indexSignature": { - "id": 495, + "id": 510, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 496, + "id": 511, "name": "key", "kind": 32768, "flags": {}, @@ -32816,7 +35397,7 @@ } }, { - "id": 509, + "id": 524, "name": "lock", "kind": 1024, "kindString": "Property", @@ -32835,16 +35416,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 83, "character": 2 } ], "type": { "type": "reference", - "id": 481, + "id": 496, "name": "LockFunc", "dereferenced": { - "id": 481, + "id": 496, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -32852,14 +35433,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 482, + "id": 497, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -32867,13 +35448,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 23 } ], "signatures": [ { - "id": 483, + "id": 498, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -32889,7 +35470,7 @@ }, "typeParameter": [ { - "id": 489, + "id": 504, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -32898,7 +35479,7 @@ ], "parameters": [ { - "id": 484, + "id": 499, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -32912,7 +35493,7 @@ } }, { - "id": 485, + "id": 500, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -32926,7 +35507,7 @@ } }, { - "id": 486, + "id": 501, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -32937,7 +35518,7 @@ "type": { "type": "reflection", "declaration": { - "id": 487, + "id": 502, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -32945,13 +35526,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 69 } ], "signatures": [ { - "id": 488, + "id": 503, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -32961,7 +35542,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -32980,7 +35561,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -32996,7 +35577,7 @@ } }, { - "id": 500, + "id": 515, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -33006,7 +35587,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 68, + "line": 69, "character": 2 } ], @@ -33016,7 +35597,7 @@ } }, { - "id": 501, + "id": 516, "name": "storage", "kind": 1024, "kindString": "Property", @@ -33026,16 +35607,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 71, "character": 2 } ], "type": { "type": "reference", - "id": 1019, + "id": 1028, "name": "SupportedStorage", "dereferenced": { - "id": 1019, + "id": 1028, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -33043,7 +35624,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1089, + "line": 1076, "character": 12 } ], @@ -33090,14 +35671,14 @@ { "type": "reflection", "declaration": { - "id": 1020, + "id": 1029, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1021, + "id": 1030, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -33110,7 +35691,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1099, + "line": 1086, "character": 2 } ], @@ -33124,13 +35705,13 @@ { "title": "Properties", "kind": 1024, - "children": [1021] + "children": [1030] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1091, + "line": 1078, "character": 4 } ] @@ -33142,7 +35723,7 @@ } }, { - "id": 497, + "id": 512, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -33152,7 +35733,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 62, + "line": 63, "character": 2 } ], @@ -33162,7 +35743,7 @@ } }, { - "id": 492, + "id": 507, "name": "url", "kind": 1024, "kindString": "Property", @@ -33172,7 +35753,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, + "line": 59, "character": 2 } ], @@ -33186,13 +35767,13 @@ { "title": "Properties", "kind": 1024, - "children": [499, 504, 498, 502, 503, 493, 509, 500, 501, 497, 492] + "children": [514, 519, 513, 517, 518, 525, 508, 524, 515, 516, 512, 507] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 34 } ] @@ -33200,7 +35781,7 @@ } }, { - "id": 1022, + "id": 1031, "name": "InitializeResult", "kind": 4194304, "kindString": "Type alias", @@ -33208,21 +35789,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1102, + "line": 1089, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1023, + "id": 1032, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1024, + "id": 1033, "name": "error", "kind": 1024, "kindString": "Property", @@ -33230,7 +35811,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1102, + "line": 1089, "character": 33 } ], @@ -33239,7 +35820,7 @@ "types": [ { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" }, { @@ -33254,13 +35835,13 @@ { "title": "Properties", "kind": 1024, - "children": [1024] + "children": [1033] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1102, + "line": 1089, "character": 31 } ] @@ -33268,7 +35849,7 @@ } }, { - "id": 481, + "id": 496, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -33276,14 +35857,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 482, + "id": 497, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -33291,13 +35872,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 23 } ], "signatures": [ { - "id": 483, + "id": 498, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -33313,7 +35894,7 @@ }, "typeParameter": [ { - "id": 489, + "id": 504, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -33322,7 +35903,7 @@ ], "parameters": [ { - "id": 484, + "id": 499, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -33336,7 +35917,7 @@ } }, { - "id": 485, + "id": 500, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -33350,7 +35931,7 @@ } }, { - "id": 486, + "id": 501, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -33361,7 +35942,7 @@ "type": { "type": "reflection", "declaration": { - "id": 487, + "id": 502, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -33369,13 +35950,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 69 } ], "signatures": [ { - "id": 488, + "id": 503, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -33385,7 +35966,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -33404,7 +35985,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -33418,7 +35999,7 @@ } }, { - "id": 893, + "id": 911, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -33426,21 +36007,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 894, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 896, + "id": 914, "name": "code", "kind": 1024, "kindString": "Property", @@ -33451,7 +36032,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 819, + "line": 832, "character": 2 } ], @@ -33461,7 +36042,7 @@ } }, { - "id": 895, + "id": 913, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -33472,7 +36053,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 817, + "line": 830, "character": 2 } ], @@ -33486,13 +36067,13 @@ { "title": "Properties", "kind": 1024, - "children": [896, 895] + "children": [914, 913] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 42 } ] @@ -33500,11 +36081,608 @@ } }, { - "id": 890, + "id": 907, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 821, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 908, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 910, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 825, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 909, + "name": "factorId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor to be challenged. Returned in enroll()." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 823, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [910, 909] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 821, + "character": 33 + } + ] + } + } + }, + { + "id": 898, + "name": "MFAEnrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 803, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "id": 1055, + "name": "MFAEnrollTOTPParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1056, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1057, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1131, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + }, + { + "id": 1059, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1135, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1058, + "name": "issuer", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Domain which the user is enrolled with." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1133, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1057, 1059, 1058] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 34 + } + ] + } + } + }, + { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + } + ] + } + }, + { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + }, + { + "id": 1055, + "name": "MFAEnrollTOTPParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1056, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1057, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1131, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + }, + { + "id": 1059, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1135, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1058, + "name": "issuer", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Domain which the user is enrolled with." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1133, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1057, 1059, 1058] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 34 + } + ] + } + } + }, + { + "id": 899, + "name": "MFAUnenrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 805, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 900, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 901, + "name": "factorId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor being unenrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 807, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [901] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 805, + "character": 32 + } + ] + } + } + }, + { + "id": 902, + "name": "MFAVerifyParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -33515,20 +36693,62 @@ "type": { "type": "reflection", "declaration": { - "id": 891, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 892, + "id": 905, + "name": "challengeId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the challenge being verified. Returned in challenge()." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 815, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 906, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Verification code provided by the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 818, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 904, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor to be challenged. Returned in enroll()." + "shortText": "ID of the factor being verified. Returned in enroll()." }, "sources": [ { @@ -33547,120 +36767,13 @@ { "title": "Properties", "kind": 1024, - "children": [892] + "children": [905, 906, 904] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 810, - "character": 33 - } - ] - } - } - }, - { - "id": 877, - "name": "MFAEnrollParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 785, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 878, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 879, - "name": "factorType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of factor being enrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 787, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - }, - { - "id": 881, - "name": "friendlyName", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Human readable name assigned to the factor." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 791, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 880, - "name": "issuer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Domain which the user is enrolled with." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 789, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [879, 881, 880] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 785, "character": 30 } ] @@ -33668,171 +36781,7 @@ } }, { - "id": 882, - "name": "MFAUnenrollParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 794, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 883, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 884, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being unenrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 796, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [884] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 794, - "character": 32 - } - ] - } - } - }, - { - "id": 885, - "name": "MFAVerifyParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 799, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 886, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 888, - "name": "challengeId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the challenge being verified. Returned in challenge()." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 804, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 889, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Verification code provided by the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 807, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 887, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 801, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [888, 889, 887] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 799, - "character": 30 - } - ] - } - } - }, - { - "id": 801, + "id": 822, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -33840,7 +36789,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 643, + "line": 661, "character": 12 } ], @@ -33859,7 +36808,7 @@ } }, { - "id": 585, + "id": 602, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -33867,7 +36816,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 173, + "line": 179, "character": 12 } ], @@ -33877,14 +36826,14 @@ { "type": "reflection", "declaration": { - "id": 586, + "id": 603, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 587, + "id": 604, "name": "data", "kind": 1024, "kindString": "Property", @@ -33892,21 +36841,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 175, + "line": 181, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 588, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 589, + "id": 606, "name": "provider", "kind": 1024, "kindString": "Property", @@ -33914,18 +36863,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 176, + "line": 182, "character": 8 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider" } }, { - "id": 590, + "id": 607, "name": "url", "kind": 1024, "kindString": "Property", @@ -33933,7 +36882,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 177, + "line": 183, "character": 8 } ], @@ -33947,13 +36896,13 @@ { "title": "Properties", "kind": 1024, - "children": [589, 590] + "children": [606, 607] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 175, + "line": 181, "character": 12 } ] @@ -33961,7 +36910,7 @@ } }, { - "id": 591, + "id": 608, "name": "error", "kind": 1024, "kindString": "Property", @@ -33969,7 +36918,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 179, + "line": 185, "character": 6 } ], @@ -33983,13 +36932,13 @@ { "title": "Properties", "kind": 1024, - "children": [587, 591] + "children": [604, 608] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 174, + "line": 180, "character": 4 } ] @@ -33998,14 +36947,14 @@ { "type": "reflection", "declaration": { - "id": 592, + "id": 609, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 593, + "id": 610, "name": "data", "kind": 1024, "kindString": "Property", @@ -34013,21 +36962,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 182, + "line": 188, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 594, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 595, + "id": 612, "name": "provider", "kind": 1024, "kindString": "Property", @@ -34035,18 +36984,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 183, + "line": 189, "character": 8 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider" } }, { - "id": 596, + "id": 613, "name": "url", "kind": 1024, "kindString": "Property", @@ -34054,7 +37003,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 184, + "line": 190, "character": 8 } ], @@ -34068,13 +37017,13 @@ { "title": "Properties", "kind": 1024, - "children": [595, 596] + "children": [612, 613] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 182, + "line": 188, "character": 12 } ] @@ -34082,7 +37031,7 @@ } }, { - "id": 597, + "id": 614, "name": "error", "kind": 1024, "kindString": "Property", @@ -34090,13 +37039,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 186, + "line": 192, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -34105,13 +37054,13 @@ { "title": "Properties", "kind": 1024, - "children": [593, 597] + "children": [610, 614] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 181, + "line": 187, "character": 4 } ] @@ -34121,7 +37070,7 @@ } }, { - "id": 1039, + "id": 1048, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -34129,21 +37078,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1040, + "id": 1049, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1050, "name": "page", "kind": 1024, "kindString": "Property", @@ -34156,7 +37105,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1123, + "line": 1110, "character": 2 } ], @@ -34166,7 +37115,7 @@ } }, { - "id": 1042, + "id": 1051, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -34179,7 +37128,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1125, + "line": 1112, "character": 2 } ], @@ -34193,13 +37142,13 @@ { "title": "Properties", "kind": 1024, - "children": [1041, 1042] + "children": [1050, 1051] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 25 } ] @@ -34207,7 +37156,7 @@ } }, { - "id": 1032, + "id": 1041, "name": "Pagination", "kind": 4194304, "kindString": "Type alias", @@ -34215,21 +37164,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1114, + "line": 1101, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1033, + "id": 1042, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1035, + "id": 1044, "name": "lastPage", "kind": 1024, "kindString": "Property", @@ -34237,7 +37186,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1117, + "line": 1104, "character": 2 } ], @@ -34247,7 +37196,7 @@ } }, { - "id": 1034, + "id": 1043, "name": "nextPage", "kind": 1024, "kindString": "Property", @@ -34255,7 +37204,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1116, + "line": 1103, "character": 2 } ], @@ -34274,7 +37223,7 @@ } }, { - "id": 1036, + "id": 1045, "name": "total", "kind": 1024, "kindString": "Property", @@ -34282,7 +37231,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1118, + "line": 1105, "character": 2 } ], @@ -34296,25 +37245,25 @@ { "title": "Properties", "kind": 1024, - "children": [1035, 1034, 1036] + "children": [1044, 1043, 1045] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1114, + "line": 1101, "character": 25 } ], "indexSignature": { - "id": 1037, + "id": 1046, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1038, + "id": 1047, "name": "key", "kind": 32768, "flags": {}, @@ -34333,7 +37282,7 @@ } }, { - "id": 478, + "id": 493, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -34411,6 +37360,10 @@ "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -34439,7 +37392,7 @@ } }, { - "id": 803, + "id": 824, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -34447,7 +37400,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 646, + "line": 664, "character": 12 } ], @@ -34457,14 +37410,14 @@ { "type": "reflection", "declaration": { - "id": 804, + "id": 825, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 806, + "id": 827, "name": "email", "kind": 1024, "kindString": "Property", @@ -34472,7 +37425,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 649, + "line": 667, "character": 6 } ], @@ -34482,7 +37435,7 @@ } }, { - "id": 807, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -34492,21 +37445,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 650, + "line": 668, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 808, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -34519,7 +37472,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 654, + "line": 672, "character": 8 } ], @@ -34529,7 +37482,7 @@ } }, { - "id": 809, + "id": 830, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -34542,7 +37495,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 670, "character": 8 } ], @@ -34556,13 +37509,13 @@ { "title": "Properties", "kind": 1024, - "children": [810, 809] + "children": [831, 830] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 650, + "line": 668, "character": 16 } ] @@ -34570,7 +37523,7 @@ } }, { - "id": 805, + "id": 826, "name": "type", "kind": 1024, "kindString": "Property", @@ -34578,7 +37531,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 648, + "line": 666, "character": 6 } ], @@ -34587,7 +37540,7 @@ "typeArguments": [ { "type": "reference", - "id": 802, + "id": 823, "name": "EmailOtpType" }, { @@ -34614,13 +37567,13 @@ { "title": "Properties", "kind": 1024, - "children": [806, 807, 805] + "children": [827, 828, 826] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 647, + "line": 665, "character": 4 } ] @@ -34629,14 +37582,14 @@ { "type": "reflection", "declaration": { - "id": 811, + "id": 832, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 814, + "id": 835, "name": "options", "kind": 1024, "kindString": "Property", @@ -34646,21 +37599,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 660, + "line": 678, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 815, + "id": 836, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 816, + "id": 837, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -34673,7 +37626,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 662, + "line": 680, "character": 8 } ], @@ -34687,13 +37640,13 @@ { "title": "Properties", "kind": 1024, - "children": [816] + "children": [837] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 660, + "line": 678, "character": 16 } ] @@ -34701,7 +37654,7 @@ } }, { - "id": 813, + "id": 834, "name": "phone", "kind": 1024, "kindString": "Property", @@ -34709,7 +37662,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 659, + "line": 677, "character": 6 } ], @@ -34719,7 +37672,7 @@ } }, { - "id": 812, + "id": 833, "name": "type", "kind": 1024, "kindString": "Property", @@ -34727,7 +37680,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 658, + "line": 676, "character": 6 } ], @@ -34736,7 +37689,7 @@ "typeArguments": [ { "type": "reference", - "id": 801, + "id": 822, "name": "MobileOtpType" }, { @@ -34763,13 +37716,13 @@ { "title": "Properties", "kind": 1024, - "children": [814, 813, 812] + "children": [835, 834, 833] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 675, "character": 4 } ] @@ -34779,7 +37732,7 @@ } }, { - "id": 598, + "id": 615, "name": "SSOResponse", "kind": 4194304, "kindString": "Type alias", @@ -34787,7 +37740,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 189, + "line": 195, "character": 12 } ], @@ -34797,14 +37750,14 @@ { "type": "reflection", "declaration": { - "id": 599, + "id": 616, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 600, + "id": 617, "name": "data", "kind": 1024, "kindString": "Property", @@ -34812,21 +37765,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 191, + "line": 197, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 601, + "id": 618, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 602, + "id": 619, "name": "url", "kind": 1024, "kindString": "Property", @@ -34838,7 +37791,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 199, + "line": 205, "character": 8 } ], @@ -34852,13 +37805,13 @@ { "title": "Properties", "kind": 1024, - "children": [602] + "children": [619] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 191, + "line": 197, "character": 12 } ] @@ -34866,7 +37819,7 @@ } }, { - "id": 603, + "id": 620, "name": "error", "kind": 1024, "kindString": "Property", @@ -34874,7 +37827,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 201, + "line": 207, "character": 6 } ], @@ -34888,13 +37841,13 @@ { "title": "Properties", "kind": 1024, - "children": [600, 603] + "children": [617, 620] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 190, + "line": 196, "character": 4 } ] @@ -34903,14 +37856,14 @@ { "type": "reflection", "declaration": { - "id": 604, + "id": 621, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 605, + "id": 622, "name": "data", "kind": 1024, "kindString": "Property", @@ -34918,7 +37871,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 204, + "line": 210, "character": 6 } ], @@ -34928,7 +37881,7 @@ } }, { - "id": 606, + "id": 623, "name": "error", "kind": 1024, "kindString": "Property", @@ -34936,13 +37889,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 205, + "line": 211, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -34951,13 +37904,13 @@ { "title": "Properties", "kind": 1024, - "children": [605, 606] + "children": [622, 623] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 203, + "line": 209, "character": 4 } ] @@ -34967,7 +37920,7 @@ } }, { - "id": 706, + "id": 726, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -34975,21 +37928,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 473, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 707, + "id": 727, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 708, + "id": 728, "name": "options", "kind": 1024, "kindString": "Property", @@ -34999,21 +37952,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 456, + "line": 474, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 709, + "id": 729, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 711, + "id": 731, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -35026,7 +37979,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 482, "character": 4 } ], @@ -35036,7 +37989,7 @@ } }, { - "id": 710, + "id": 730, "name": "data", "kind": 1024, "kindString": "Property", @@ -35050,7 +38003,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 462, + "line": 480, "character": 4 } ], @@ -35064,13 +38017,13 @@ { "title": "Properties", "kind": 1024, - "children": [711, 710] + "children": [731, 730] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 456, + "line": 474, "character": 12 } ] @@ -35082,13 +38035,13 @@ { "title": "Properties", "kind": 1024, - "children": [708] + "children": [728] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 473, "character": 43 } ] @@ -35096,7 +38049,7 @@ } }, { - "id": 772, + "id": 792, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -35104,21 +38057,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 581, + "line": 599, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 773, + "id": 793, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 776, + "id": 797, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -35131,7 +38084,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 587, + "line": 605, "character": 2 } ], @@ -35141,7 +38094,7 @@ } }, { - "id": 777, + "id": 798, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -35154,7 +38107,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 589, + "line": 607, "character": 2 } ], @@ -35164,7 +38117,7 @@ } }, { - "id": 778, + "id": 799, "name": "options", "kind": 1024, "kindString": "Property", @@ -35174,21 +38127,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 608, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 779, + "id": 800, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 780, + "id": 801, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -35201,7 +38154,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 592, + "line": 610, "character": 4 } ], @@ -35215,13 +38168,13 @@ { "title": "Properties", "kind": 1024, - "children": [780] + "children": [801] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 608, "character": 12 } ] @@ -35229,18 +38182,18 @@ } }, { - "id": 774, + "id": 794, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "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`, `keycloak` (deprecated)." + "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`, `keycloak` (deprecated)." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 583, + "line": 601, "character": 2 } ], @@ -35264,14 +38217,40 @@ "value": "facebook" }, { - "type": "intrinsic", - "name": "string" + "type": "literal", + "value": "kakao" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 795, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 601, + "character": 76 + } + ] + } + } + ] } ] } }, { - "id": 775, + "id": 796, "name": "token", "kind": 1024, "kindString": "Property", @@ -35282,7 +38261,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 585, + "line": 603, "character": 2 } ], @@ -35296,13 +38275,13 @@ { "title": "Properties", "kind": 1024, - "children": [776, 777, 778, 774, 775] + "children": [797, 798, 799, 794, 796] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 581, + "line": 599, "character": 43 } ] @@ -35310,7 +38289,7 @@ } }, { - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -35318,21 +38297,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 761, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 763, + "id": 783, "name": "options", "kind": 1024, "kindString": "Property", @@ -35342,21 +38321,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 764, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 767, + "id": 787, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -35369,14 +38348,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 768, + "id": 788, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -35384,19 +38363,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 18 } ], "indexSignature": { - "id": 769, + "id": 789, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 770, + "id": 790, "name": "key", "kind": 32768, "flags": {}, @@ -35415,7 +38394,7 @@ } }, { - "id": 765, + "id": 785, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -35428,7 +38407,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 571, + "line": 589, "character": 4 } ], @@ -35438,7 +38417,7 @@ } }, { - "id": 766, + "id": 786, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -35451,7 +38430,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 573, + "line": 591, "character": 4 } ], @@ -35461,7 +38440,7 @@ } }, { - "id": 771, + "id": 791, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -35474,7 +38453,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 577, + "line": 595, "character": 4 } ], @@ -35488,13 +38467,13 @@ { "title": "Properties", "kind": 1024, - "children": [767, 765, 766, 771] + "children": [787, 785, 786, 791] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 12 } ] @@ -35502,7 +38481,7 @@ } }, { - "id": 762, + "id": 782, "name": "provider", "kind": 1024, "kindString": "Property", @@ -35513,16 +38492,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 568, + "line": 586, "character": 2 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider", "dereferenced": { - "id": 478, + "id": 493, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -35600,6 +38579,10 @@ "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -35634,13 +38617,13 @@ { "title": "Properties", "kind": 1024, - "children": [763, 762] + "children": [783, 782] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 41 } ] @@ -35648,7 +38631,7 @@ } }, { - "id": 729, + "id": 749, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -35656,7 +38639,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 523, "character": 12 } ], @@ -35666,14 +38649,14 @@ { "type": "reflection", "declaration": { - "id": 730, + "id": 750, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 731, + "id": 751, "name": "email", "kind": 1024, "kindString": "Property", @@ -35684,7 +38667,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 508, + "line": 526, "character": 6 } ], @@ -35694,7 +38677,7 @@ } }, { - "id": 733, + "id": 753, "name": "options", "kind": 1024, "kindString": "Property", @@ -35704,21 +38687,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 511, + "line": 529, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -35731,7 +38714,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 513, + "line": 531, "character": 8 } ], @@ -35745,13 +38728,13 @@ { "title": "Properties", "kind": 1024, - "children": [735] + "children": [755] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 511, + "line": 529, "character": 16 } ] @@ -35759,7 +38742,7 @@ } }, { - "id": 732, + "id": 752, "name": "password", "kind": 1024, "kindString": "Property", @@ -35770,7 +38753,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 510, + "line": 528, "character": 6 } ], @@ -35784,13 +38767,13 @@ { "title": "Properties", "kind": 1024, - "children": [731, 733, 732] + "children": [751, 753, 752] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 524, "character": 4 } ] @@ -35799,14 +38782,14 @@ { "type": "reflection", "declaration": { - "id": 736, + "id": 756, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 739, + "id": 759, "name": "options", "kind": 1024, "kindString": "Property", @@ -35816,21 +38799,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 521, + "line": 539, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 740, + "id": 760, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 741, + "id": 761, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -35840,203 +38823,6 @@ "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 523, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [741] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 521, - "character": 16 - } - ] - } - } - }, - { - "id": 738, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 520, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 737, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 518, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [739, 738, 737] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 516, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 742, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 527, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 743, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 744, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 530, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 745, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 531, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 746, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 750, - "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": 543, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 749, - "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.raw_user_meta_data` 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", @@ -36044,103 +38830,139 @@ "character": 8 } ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 747, - "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": 533, - "character": 8 - } - ], "type": { "type": "intrinsic", "name": "string" } - }, - { - "id": 748, - "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": 535, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [750, 749, 747, 748] + "children": [761] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 531, + "line": 539, "character": 16 } ] } } + }, + { + "id": 758, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 538, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 757, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 536, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [744, 745] + "children": [759, 758, 757] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 528, + "line": 534, "character": 4 } ] } - }, + } + ] + } + }, + { + "id": 762, + "name": "SignInWithPasswordlessCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 545, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ { "type": "reflection", "declaration": { - "id": 751, + "id": 763, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 753, + "id": 764, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 548, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 765, "name": "options", "kind": 1024, "kindString": "Property", @@ -36157,14 +38979,14 @@ "type": { "type": "reflection", "declaration": { - "id": 754, + "id": 766, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 757, + "id": 770, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -36177,7 +38999,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 559, + "line": 561, "character": 8 } ], @@ -36187,7 +39009,168 @@ } }, { - "id": 758, + "id": 769, + "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.raw_user_meta_data` 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": 559, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 767, + "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": 551, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 768, + "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": 553, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [770, 769, 767, 768] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 549, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [764, 765] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 546, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 771, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 773, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 567, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 774, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 777, + "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": 577, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 778, "name": "channel", "kind": 1024, "kindString": "Property", @@ -36200,7 +39183,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 579, "character": 8 } ], @@ -36219,7 +39202,7 @@ } }, { - "id": 756, + "id": 776, "name": "data", "kind": 1024, "kindString": "Property", @@ -36233,7 +39216,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 557, + "line": 575, "character": 8 } ], @@ -36243,7 +39226,7 @@ } }, { - "id": 755, + "id": 775, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -36256,7 +39239,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 551, + "line": 569, "character": 8 } ], @@ -36270,13 +39253,13 @@ { "title": "Properties", "kind": 1024, - "children": [757, 758, 756, 755] + "children": [777, 778, 776, 775] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 567, "character": 16 } ] @@ -36284,7 +39267,7 @@ } }, { - "id": 752, + "id": 772, "name": "phone", "kind": 1024, "kindString": "Property", @@ -36295,7 +39278,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 548, + "line": 566, "character": 6 } ], @@ -36309,13 +39292,13 @@ { "title": "Properties", "kind": 1024, - "children": [753, 752] + "children": [773, 772] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 564, "character": 4 } ] @@ -36325,7 +39308,7 @@ } }, { - "id": 817, + "id": 838, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -36333,7 +39316,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 666, + "line": 684, "character": 12 } ], @@ -36343,14 +39326,14 @@ { "type": "reflection", "declaration": { - "id": 818, + "id": 839, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 820, + "id": 841, "name": "options", "kind": 1024, "kindString": "Property", @@ -36360,21 +39343,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 671, + "line": 689, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 821, + "id": 842, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 823, + "id": 844, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -36387,7 +39370,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 675, + "line": 693, "character": 8 } ], @@ -36397,7 +39380,7 @@ } }, { - "id": 822, + "id": 843, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -36410,7 +39393,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 673, + "line": 691, "character": 8 } ], @@ -36424,13 +39407,13 @@ { "title": "Properties", "kind": 1024, - "children": [823, 822] + "children": [844, 843] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 671, + "line": 689, "character": 16 } ] @@ -36438,7 +39421,7 @@ } }, { - "id": 819, + "id": 840, "name": "providerId", "kind": 1024, "kindString": "Property", @@ -36449,7 +39432,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 669, + "line": 687, "character": 6 } ], @@ -36463,13 +39446,13 @@ { "title": "Properties", "kind": 1024, - "children": [820, 819] + "children": [841, 840] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 667, + "line": 685, "character": 4 } ] @@ -36478,14 +39461,14 @@ { "type": "reflection", "declaration": { - "id": 824, + "id": 845, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 825, + "id": 846, "name": "domain", "kind": 1024, "kindString": "Property", @@ -36496,7 +39479,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 680, + "line": 698, "character": 6 } ], @@ -36506,7 +39489,7 @@ } }, { - "id": 826, + "id": 847, "name": "options", "kind": 1024, "kindString": "Property", @@ -36516,21 +39499,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 682, + "line": 700, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 827, + "id": 848, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 829, + "id": 850, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -36543,7 +39526,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 686, + "line": 704, "character": 8 } ], @@ -36553,7 +39536,7 @@ } }, { - "id": 828, + "id": 849, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -36566,7 +39549,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 684, + "line": 702, "character": 8 } ], @@ -36580,13 +39563,13 @@ { "title": "Properties", "kind": 1024, - "children": [829, 828] + "children": [850, 849] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 682, + "line": 700, "character": 16 } ] @@ -36598,13 +39581,13 @@ { "title": "Properties", "kind": 1024, - "children": [825, 826] + "children": [846, 847] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 678, + "line": 696, "character": 4 } ] @@ -36614,7 +39597,7 @@ } }, { - "id": 1043, + "id": 1052, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -36622,21 +39605,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1128, + "line": 1115, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1044, + "id": 1053, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1045, + "id": 1054, "name": "scope", "kind": 1024, "kindString": "Property", @@ -36649,7 +39632,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1139, + "line": 1126, "character": 2 } ], @@ -36676,13 +39659,13 @@ { "title": "Properties", "kind": 1024, - "children": [1045] + "children": [1054] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1128, + "line": 1115, "character": 22 } ] @@ -36690,7 +39673,7 @@ } }, { - "id": 712, + "id": 732, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -36698,7 +39681,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 468, + "line": 486, "character": 12 } ], @@ -36708,14 +39691,14 @@ { "type": "reflection", "declaration": { - "id": 713, + "id": 733, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 714, + "id": 734, "name": "email", "kind": 1024, "kindString": "Property", @@ -36726,7 +39709,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 471, + "line": 489, "character": 6 } ], @@ -36736,166 +39719,7 @@ } }, { - "id": 716, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 474, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 717, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 720, - "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": 484, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 719, - "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.raw_user_meta_data` 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": 482, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 718, - "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": 476, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [720, 719, 718] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 474, - "character": 16 - } - ] - } - } - }, - { - "id": 715, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 473, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [714, 716, 715] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 469, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 721, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 724, + "id": 736, "name": "options", "kind": 1024, "kindString": "Property", @@ -36912,14 +39736,14 @@ "type": { "type": "reflection", "declaration": { - "id": 725, + "id": 737, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 727, + "id": 740, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -36927,30 +39751,7 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 500, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 728, - "name": "channel", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { @@ -36960,21 +39761,12 @@ } ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] + "type": "intrinsic", + "name": "string" } }, { - "id": 726, + "id": 739, "name": "data", "kind": 1024, "kindString": "Property", @@ -36988,7 +39780,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 498, + "line": 500, "character": 8 } ], @@ -36996,13 +39788,36 @@ "type": "intrinsic", "name": "object" } + }, + { + "id": 738, + "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": 494, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [727, 728, 726] + "children": [740, 739, 738] } ], "sources": [ @@ -37016,7 +39831,7 @@ } }, { - "id": 723, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -37035,9 +39850,177 @@ "type": "intrinsic", "name": "string" } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [734, 736, 735] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 487, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 741, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 744, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 510, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 745, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 747, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 518, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 748, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 746, + "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.raw_user_meta_data` 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": 516, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [747, 748, 746] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 510, + "character": 16 + } + ] + } + } }, { - "id": 722, + "id": 743, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 509, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 742, "name": "phone", "kind": 1024, "kindString": "Property", @@ -37048,7 +40031,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 489, + "line": 507, "character": 6 } ], @@ -37062,13 +40045,13 @@ { "title": "Properties", "kind": 1024, - "children": [724, 723, 722] + "children": [744, 743, 742] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 487, + "line": 505, "character": 4 } ] @@ -37078,7 +40061,7 @@ } }, { - "id": 1019, + "id": 1028, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -37086,7 +40069,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1089, + "line": 1076, "character": 12 } ], @@ -37133,14 +40116,14 @@ { "type": "reflection", "declaration": { - "id": 1020, + "id": 1029, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1021, + "id": 1030, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -37153,7 +40136,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1099, + "line": 1086, "character": 2 } ], @@ -37167,13 +40150,13 @@ { "title": "Properties", "kind": 1024, - "children": [1021] + "children": [1030] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1091, + "line": 1078, "character": 4 } ] @@ -37183,7 +40166,7 @@ } }, { - "id": 607, + "id": 624, "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", @@ -37191,7 +40174,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 208, + "line": 214, "character": 12 } ], @@ -37201,117 +40184,14 @@ { "type": "reflection", "declaration": { - "id": 608, + "id": 625, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 609, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 210, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 610, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 611, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 211, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 656, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [611] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 210, - "character": 12 - } - ] - } - } - }, - { - "id": 612, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 213, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [609, 612] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 209, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 613, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 614, + "id": 626, "name": "data", "kind": 1024, "kindString": "Property", @@ -37326,14 +40206,14 @@ "type": { "type": "reflection", "declaration": { - "id": 615, + "id": 627, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 616, + "id": 628, "name": "user", "kind": 1024, "kindString": "Property", @@ -37346,8 +40226,9 @@ } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 675, + "name": "User" } } ], @@ -37355,7 +40236,7 @@ { "title": "Properties", "kind": 1024, - "children": [616] + "children": [628] } ], "sources": [ @@ -37369,7 +40250,7 @@ } }, { - "id": 617, + "id": 629, "name": "error", "kind": 1024, "kindString": "Property", @@ -37382,9 +40263,8 @@ } ], "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" + "type": "literal", + "value": null } } ], @@ -37392,7 +40272,7 @@ { "title": "Properties", "kind": 1024, - "children": [614, 617] + "children": [626, 629] } ], "sources": [ @@ -37403,12 +40283,115 @@ } ] } + }, + { + "type": "reflection", + "declaration": { + "id": 630, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 631, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 632, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 633, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 223, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [633] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, + "character": 12 + } + ] + } + } + }, + { + "id": 634, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 225, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [631, 634] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 221, + "character": 4 + } + ] + } } ] } }, { - "id": 781, + "id": 802, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -37416,7 +40399,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 596, + "line": 614, "character": 12 } ], @@ -37424,14 +40407,14 @@ "type": "union", "types": [ { - "id": 782, + "id": 803, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 786, + "id": 807, "name": "options", "kind": 1024, "kindString": "Property", @@ -37441,243 +40424,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 604, + "line": 622, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 787, + "id": 808, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 789, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ - { - "tag": "deprecated", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 613, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 788, - "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": 606, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [789, 788] - } - ] - } - } - }, - { - "id": 783, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 599, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 784, - "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": 601, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 785, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 603, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 801, - "name": "MobileOtpType", - "dereferenced": { - "id": 801, - "name": "MobileOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 643, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [786, 783, 784, 785] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 597, - "character": 17 - } - ] - }, - { - "id": 790, - "name": "VerifyEmailOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 791, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 618, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 794, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 623, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 795, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 797, + "id": 810, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -37706,7 +40467,7 @@ } }, { - "id": 796, + "id": 809, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -37719,7 +40480,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 625, + "line": 624, "character": 4 } ], @@ -37733,25 +40494,25 @@ { "title": "Properties", "kind": 1024, - "children": [797, 796] + "children": [810, 809] } ] } } }, { - "id": 792, - "name": "token", + "id": 804, + "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's email address." + "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 620, + "line": 617, "character": 2 } ], @@ -37761,7 +40522,28 @@ } }, { - "id": 793, + "id": 805, + "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": 619, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 806, "name": "type", "kind": 1024, "kindString": "Property", @@ -37772,24 +40554,24 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 622, + "line": 621, "character": 2 } ], "type": { "type": "reference", - "id": 802, - "name": "EmailOtpType", + "id": 822, + "name": "MobileOtpType", "dereferenced": { - "id": 802, - "name": "EmailOtpType", + "id": 822, + "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 661, "character": 12 } ], @@ -37798,27 +40580,11 @@ "types": [ { "type": "literal", - "value": "signup" + "value": "sms" }, { "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" + "value": "phone_change" } ] } @@ -37830,37 +40596,37 @@ { "title": "Properties", "kind": 1024, - "children": [791, 794, 792, 793] + "children": [807, 804, 805, 806] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 616, + "line": 615, "character": 17 } ] }, { - "id": 798, - "name": "VerifyTokenHashParams", + "id": 811, + "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 799, - "name": "token_hash", + "id": 812, + "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The token hash used in an email link" + "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 637, + "line": 636, "character": 2 } ], @@ -37870,7 +40636,115 @@ } }, { - "id": 800, + "id": 815, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 641, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 816, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 818, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site.", + "tags": [ + { + "tag": "deprecated", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 649, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 817, + "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": 643, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [818, 817] + } + ] + } + } + }, + { + "id": 813, + "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": 638, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 814, "name": "type", "kind": 1024, "kindString": "Property", @@ -37887,10 +40761,10 @@ ], "type": { "type": "reference", - "id": 802, + "id": 823, "name": "EmailOtpType", "dereferenced": { - "id": 802, + "id": 823, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -37898,7 +40772,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 662, "character": 12 } ], @@ -37939,13 +40813,122 @@ { "title": "Properties", "kind": 1024, - "children": [799, 800] + "children": [812, 815, 813, 814] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 635, + "line": 634, + "character": 17 + } + ] + }, + { + "id": 819, + "name": "VerifyTokenHashParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 820, + "name": "token_hash", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The token hash used in an email link" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 655, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 821, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 658, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 823, + "name": "EmailOtpType", + "dereferenced": { + "id": 823, + "name": "EmailOtpType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 662, + "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" + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [820, 821] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 653, "character": 17 } ] @@ -37954,7 +40937,7 @@ } }, { - "id": 511, + "id": 528, "name": "WeakPassword", "kind": 4194304, "kindString": "Type alias", @@ -37962,21 +40945,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 92, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 512, + "id": 529, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 514, + "id": 531, "name": "message", "kind": 1024, "kindString": "Property", @@ -37984,7 +40967,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 88, + "line": 94, "character": 2 } ], @@ -37994,7 +40977,7 @@ } }, { - "id": 513, + "id": 530, "name": "reasons", "kind": 1024, "kindString": "Property", @@ -38002,7 +40985,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 87, + "line": 93, "character": 2 } ], @@ -38010,7 +40993,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 510, + "id": 526, "name": "WeakPasswordReasons" } } @@ -38020,13 +41003,13 @@ { "title": "Properties", "kind": 1024, - "children": [514, 513] + "children": [531, 530] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 92, "character": 27 } ] @@ -38034,7 +41017,7 @@ } }, { - "id": 510, + "id": 526, "name": "WeakPasswordReasons", "kind": 4194304, "kindString": "Type alias", @@ -38042,7 +41025,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 85, + "line": 91, "character": 12 } ], @@ -38062,14 +41045,36 @@ "value": "pwned" }, { - "type": "intrinsic", - "name": "string" + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 527, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 91, + "character": 80 + } + ] + } + } + ] } ] } }, { - "id": 460, + "id": 475, "name": "AuthAdminApi", "kind": 32, "kindString": "Variable", @@ -38094,7 +41099,7 @@ "defaultValue": "GoTrueAdminApi" }, { - "id": 461, + "id": 476, "name": "AuthClient", "kind": 32, "kindString": "Variable", @@ -38119,7 +41124,7 @@ "defaultValue": "GoTrueClient" }, { - "id": 475, + "id": 490, "name": "lockInternals", "kind": 32, "kindString": "Variable", @@ -38144,14 +41149,14 @@ "type": { "type": "reflection", "declaration": { - "id": 476, + "id": 491, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 477, + "id": 492, "name": "debug", "kind": 1024, "kindString": "Property", @@ -38182,7 +41187,7 @@ { "title": "Properties", "kind": 1024, - "children": [477] + "children": [492] } ] } @@ -38190,7 +41195,7 @@ "defaultValue": "..." }, { - "id": 1049, + "id": 1096, "name": "isAuthApiError", "kind": 64, "kindString": "Function", @@ -38198,20 +41203,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 36, + "line": 41, "character": 16 } ], "signatures": [ { - "id": 1050, + "id": 1097, "name": "isAuthApiError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1051, + "id": 1098, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -38228,7 +41233,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1065, + "id": 1121, "name": "AuthApiError" } } @@ -38236,7 +41241,7 @@ ] }, { - "id": 1046, + "id": 1093, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -38244,20 +41249,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 14, + "line": 26, "character": 16 } ], "signatures": [ { - "id": 1047, + "id": 1094, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1048, + "id": 1095, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -38274,7 +41279,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -38282,7 +41287,53 @@ ] }, { - "id": 1052, + "id": 1102, + "name": "isAuthImplicitGrantRedirectError", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 105, + "character": 16 + } + ], + "signatures": [ + { + "id": 1103, + "name": "isAuthImplicitGrantRedirectError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 1104, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 1178, + "name": "AuthImplicitGrantRedirectError" + } + } + } + ] + }, + { + "id": 1105, "name": "isAuthRetryableFetchError", "kind": 64, "kindString": "Function", @@ -38290,20 +41341,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 126, + "line": 135, "character": 16 } ], "signatures": [ { - "id": 1053, + "id": 1106, "name": "isAuthRetryableFetchError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1054, + "id": 1107, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -38320,7 +41371,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1188, + "id": 1232, "name": "AuthRetryableFetchError" } } @@ -38328,7 +41379,53 @@ ] }, { - "id": 1055, + "id": 1099, + "name": "isAuthSessionMissingError", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 72, + "character": 16 + } + ], + "signatures": [ + { + "id": 1100, + "name": "isAuthSessionMissingError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 1101, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 1153, + "name": "AuthSessionMissingError" + } + } + } + ] + }, + { + "id": 1108, "name": "isAuthWeakPasswordError", "kind": 64, "kindString": "Function", @@ -38336,20 +41433,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 148, + "line": 157, "character": 16 } ], "signatures": [ { - "id": 1056, + "id": 1109, "name": "isAuthWeakPasswordError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1057, + "id": 1110, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -38366,7 +41463,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1202, + "id": 1242, "name": "AuthWeakPasswordError" } } @@ -38374,7 +41471,7 @@ ] }, { - "id": 462, + "id": 477, "name": "navigatorLock", "kind": 64, "kindString": "Function", @@ -38382,13 +41479,13 @@ "sources": [ { "fileName": "src/lib/locks.ts", - "line": 58, + "line": 59, "character": 22 } ], "signatures": [ { - "id": 463, + "id": 478, "name": "navigatorLock", "kind": 4096, "kindString": "Call signature", @@ -38399,7 +41496,7 @@ }, "typeParameter": [ { - "id": 464, + "id": 479, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -38408,7 +41505,7 @@ ], "parameters": [ { - "id": 465, + "id": 480, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -38422,7 +41519,7 @@ } }, { - "id": 466, + "id": 481, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -38436,7 +41533,7 @@ } }, { - "id": 467, + "id": 482, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -38447,14 +41544,14 @@ "type": { "type": "reflection", "declaration": { - "id": 468, + "id": 483, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 469, + "id": 484, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -38464,7 +41561,7 @@ "typeArguments": [ { "type": "reference", - "id": 464, + "id": 479, "name": "R" } ], @@ -38483,7 +41580,7 @@ "typeArguments": [ { "type": "reference", - "id": 464, + "id": 479, "name": "R" } ], @@ -38499,34 +41596,34 @@ { "title": "Classes", "kind": 128, - "children": [1065, 1058, 1138, 1125, 1113, 1163, 1188, 1101, 1078, 1202, 1086, 1, 78, 470] + "children": [1121, 1111, 1178, 1169, 1161, 1205, 1232, 1153, 1131, 1242, 1141, 1, 78, 485] }, { "title": "Interfaces", "kind": 256, "children": [ - 627, 685, 642, 852, 1012, 967, 618, 696, 704, 656, 649, 679, 630, 653, 790, 782, 798 + 644, 705, 660, 873, 1021, 972, 635, 718, 675, 668, 699, 648, 672, 811, 803, 819 ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 480, 479, 759, 996, 987, 1009, 1000, 935, 910, 956, 945, 926, 897, 542, 515, 528, 557, - 570, 955, 1025, 802, 846, 836, 855, 869, 856, 876, 841, 830, 490, 1022, 481, 893, 890, - 877, 882, 885, 801, 585, 1039, 1032, 478, 803, 598, 706, 772, 760, 729, 742, 817, 1043, - 712, 1019, 607, 781, 511, 510 + 495, 494, 779, 1005, 996, 1018, 1009, 938, 1081, 928, 1065, 961, 949, 929, 915, 559, + 532, 545, 574, 587, 960, 1034, 823, 867, 857, 876, 890, 877, 897, 862, 851, 505, 1031, + 496, 911, 907, 898, 1060, 1055, 899, 902, 822, 602, 1048, 1041, 493, 824, 615, 726, 792, + 780, 749, 762, 838, 1052, 732, 1028, 624, 802, 528, 526 ] }, { "title": "Variables", "kind": 32, - "children": [460, 461, 475] + "children": [475, 476, 490] }, { "title": "Functions", "kind": 64, - "children": [1049, 1046, 1052, 1055, 462] + "children": [1096, 1093, 1102, 1105, 1099, 1108, 477] } ], "sources": [ @@ -38546,7 +41643,7 @@ "originalName": "", "children": [ { - "id": 609, + "id": 615, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -38555,7 +41652,7 @@ }, "children": [ { - "id": 610, + "id": 616, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -38563,46 +41660,65 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 23, "character": 2 } ], "signatures": [ { - "id": 611, + "id": 617, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 612, + "id": 618, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 619, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "parameters": [ { - "id": 613, + "id": 620, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default", "dereferenced": { - "id": 609, + "id": 615, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -38614,17 +41730,17 @@ { "title": "Constructors", "kind": 512, - "children": [610] + "children": [616] }, { "title": "Properties", "kind": 1024, - "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] + "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] }, { "title": "Methods", "kind": 2048, - "children": [629, 627] + "children": [636, 640, 634] } ], "sources": [ @@ -38636,17 +41752,32 @@ ], "typeParameter": [ { - "id": 641, + "id": 652, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 653, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "extendedBy": [ { "type": "reference", - "id": 489, + "id": 491, "name": "PostgrestTransformBuilder" } ], @@ -38655,16 +41786,40 @@ "type": "reference", "typeArguments": [ { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } ], "qualifiedName": "PromiseLike", @@ -38678,12 +41833,17 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" } ], "name": "default" @@ -38692,7 +41852,7 @@ ] }, { - "id": 618, + "id": 625, "name": "body", "kind": 1024, "kindString": "Property", @@ -38703,7 +41863,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -38713,7 +41873,7 @@ } }, { - "id": 621, + "id": 628, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -38723,28 +41883,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 622, + "id": 629, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 623, + "id": 630, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 624, + "id": 631, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -38768,7 +41928,7 @@ } }, { - "id": 625, + "id": 632, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -38803,7 +41963,7 @@ } }, { - "id": 616, + "id": 623, "name": "headers", "kind": 1024, "kindString": "Property", @@ -38813,7 +41973,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -38835,7 +41995,7 @@ } }, { - "id": 626, + "id": 633, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -38845,7 +42005,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -38855,7 +42015,7 @@ } }, { - "id": 614, + "id": 621, "name": "method", "kind": 1024, "kindString": "Property", @@ -38865,7 +42025,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -38896,7 +42056,7 @@ } }, { - "id": 617, + "id": 624, "name": "schema", "kind": 1024, "kindString": "Property", @@ -38904,48 +42064,6 @@ "isProtected": true, "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 619, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 620, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", @@ -38953,6 +42071,48 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 626, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 627, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -38961,7 +42121,7 @@ } }, { - "id": 615, + "id": 622, "name": "url", "kind": 1024, "kindString": "Property", @@ -38971,7 +42131,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -38983,7 +42143,74 @@ } }, { - "id": 629, + "id": 636, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 637, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 638, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 639, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 640, "name": "then", "kind": 2048, "kindString": "Method", @@ -38991,39 +42218,63 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 630, + "id": 641, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 631, + "id": 642, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } }, { - "id": 632, + "id": 643, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -39036,7 +42287,7 @@ ], "parameters": [ { - "id": 633, + "id": 644, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -39053,36 +42304,60 @@ { "type": "reflection", "declaration": { - "id": 634, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 635, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 636, + "id": 647, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } } ], @@ -39091,7 +42366,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -39099,7 +42374,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -39117,7 +42392,7 @@ } }, { - "id": 637, + "id": 648, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -39134,21 +42409,21 @@ { "type": "reflection", "declaration": { - "id": 638, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 639, + "id": 650, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 640, + "id": 651, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -39164,7 +42439,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -39172,7 +42447,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -39198,12 +42473,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -39225,7 +42500,7 @@ } }, { - "id": 627, + "id": 634, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -39233,13 +42508,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 628, + "id": 635, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -39249,16 +42524,42 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 609, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 612, - "name": "Result" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + }, + { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] } } ] @@ -39268,17 +42569,17 @@ { "title": "Constructors", "kind": 512, - "children": [610] + "children": [616] }, { "title": "Properties", "kind": 1024, - "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] + "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] }, { "title": "Methods", "kind": 2048, - "children": [629, 627] + "children": [636, 640, 634] } ], "sources": [ @@ -39290,17 +42591,32 @@ ], "typeParameter": [ { - "id": 641, + "id": 652, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 653, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "extendedBy": [ { "type": "reference", - "id": 489, + "id": 491, "name": "PostgrestTransformBuilder" } ], @@ -39309,16 +42625,40 @@ "type": "reference", "typeArguments": [ { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } ], "qualifiedName": "PromiseLike", @@ -39328,7 +42668,7 @@ ] }, { - "id": 1, + "id": 9, "name": "PostgrestClient", "kind": 128, "kindString": "Class", @@ -39338,7 +42678,7 @@ }, "children": [ { - "id": 2, + "id": 10, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -39352,7 +42692,7 @@ ], "signatures": [ { - "id": 3, + "id": 11, "name": "new PostgrestClient", "kind": 16384, "kindString": "Constructor signature", @@ -39362,7 +42702,7 @@ }, "typeParameter": [ { - "id": 4, + "id": 12, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -39373,7 +42713,7 @@ } }, { - "id": 5, + "id": 13, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -39393,7 +42733,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -39413,7 +42753,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } } @@ -39422,7 +42762,7 @@ } }, { - "id": 6, + "id": 14, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -39437,12 +42777,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -39470,7 +42810,7 @@ ], "parameters": [ { - "id": 7, + "id": 15, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -39484,7 +42824,7 @@ } }, { - "id": 8, + "id": 16, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -39496,14 +42836,14 @@ "type": { "type": "reflection", "declaration": { - "id": 9, + "id": 17, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 12, + "id": 20, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -39520,14 +42860,14 @@ "type": { "type": "reflection", "declaration": { - "id": 13, + "id": 21, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 14, + "id": 22, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -39537,7 +42877,7 @@ }, "parameters": [ { - "id": 15, + "id": 23, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -39561,7 +42901,7 @@ } }, { - "id": 16, + "id": 24, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -39596,7 +42936,7 @@ } }, { - "id": 10, + "id": 18, "name": "headers", "kind": 1024, "kindString": "Property", @@ -39631,7 +42971,7 @@ } }, { - "id": 11, + "id": 19, "name": "schema", "kind": 1024, "kindString": "Property", @@ -39650,7 +42990,7 @@ ], "type": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName", "dereferenced": {} } @@ -39660,7 +43000,7 @@ { "title": "Properties", "kind": 1024, - "children": [12, 10, 11] + "children": [20, 18, 19] } ] } @@ -39670,21 +43010,21 @@ ], "type": { "type": "reference", - "id": 1, + "id": 9, "typeArguments": [ { "type": "reference", - "id": 4, + "id": 12, "name": "Database" }, { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" }, { "type": "reference", - "id": 6, + "id": 14, "name": "Schema" } ], @@ -39694,7 +43034,7 @@ ] }, { - "id": 20, + "id": 28, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -39711,21 +43051,21 @@ "type": { "type": "reflection", "declaration": { - "id": 21, + "id": 29, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 22, + "id": 30, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 23, + "id": 31, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -39749,7 +43089,7 @@ } }, { - "id": 24, + "id": 32, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -39784,7 +43124,7 @@ } }, { - "id": 18, + "id": 26, "name": "headers", "kind": 1024, "kindString": "Property", @@ -39814,7 +43154,7 @@ } }, { - "id": 19, + "id": 27, "name": "schemaName", "kind": 1024, "kindString": "Property", @@ -39830,13 +43170,13 @@ ], "type": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName", "dereferenced": {} } }, { - "id": 17, + "id": 25, "name": "url", "kind": 1024, "kindString": "Property", @@ -39854,7 +43194,7 @@ } }, { - "id": 25, + "id": 33, "name": "from", "kind": 2048, "kindString": "Method", @@ -39868,7 +43208,7 @@ ], "signatures": [ { - "id": 26, + "id": 34, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -39878,7 +43218,7 @@ }, "typeParameter": [ { - "id": 27, + "id": 35, "name": "TableName", "kind": 131072, "kindString": "Type parameter", @@ -39889,7 +43229,7 @@ } }, { - "id": 28, + "id": 36, "name": "Table", "kind": 131072, "kindString": "Type parameter", @@ -39902,7 +43242,7 @@ ], "parameters": [ { - "id": 29, + "id": 37, "name": "relation", "kind": 32768, "kindString": "Parameter", @@ -39912,7 +43252,7 @@ }, "type": { "type": "reference", - "id": 27, + "id": 35, "name": "TableName", "dereferenced": {} } @@ -39920,41 +43260,41 @@ ], "type": { "type": "reference", - "id": 56, + "id": 64, "typeArguments": [ { "type": "reference", - "id": 6, + "id": 14, "name": "Schema" }, { "type": "reference", - "id": 28, + "id": 36, "name": "Table" }, { "type": "reference", - "id": 27, + "id": 35, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 28, + "id": 36, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { - "id": 30, + "id": 38, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 31, + "id": 39, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -39976,7 +43316,7 @@ { "title": "Properties", "kind": 1024, - "children": [31] + "children": [39] } ] } @@ -39995,7 +43335,7 @@ } }, { - "id": 32, + "id": 40, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -40005,7 +43345,7 @@ }, "typeParameter": [ { - "id": 33, + "id": 41, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", @@ -40016,7 +43356,7 @@ } }, { - "id": 34, + "id": 42, "name": "View", "kind": 131072, "kindString": "Type parameter", @@ -40029,7 +43369,7 @@ ], "parameters": [ { - "id": 35, + "id": 43, "name": "relation", "kind": 32768, "kindString": "Parameter", @@ -40039,7 +43379,7 @@ }, "type": { "type": "reference", - "id": 33, + "id": 41, "name": "ViewName", "dereferenced": {} } @@ -40047,41 +43387,41 @@ ], "type": { "type": "reference", - "id": 56, + "id": 64, "typeArguments": [ { "type": "reference", - "id": 6, + "id": 14, "name": "Schema" }, { "type": "reference", - "id": 34, + "id": 42, "name": "View" }, { "type": "reference", - "id": 33, + "id": 41, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 34, + "id": 42, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { - "id": 36, + "id": 44, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 37, + "id": 45, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -40103,7 +43443,7 @@ { "title": "Properties", "kind": 1024, - "children": [37] + "children": [45] } ] } @@ -40124,7 +43464,7 @@ ] }, { - "id": 42, + "id": 50, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -40138,7 +43478,7 @@ ], "signatures": [ { - "id": 43, + "id": 51, "name": "rpc", "kind": 4096, "kindString": "Call signature", @@ -40148,7 +43488,7 @@ }, "typeParameter": [ { - "id": 44, + "id": 52, "name": "FnName", "kind": 131072, "kindString": "Type parameter", @@ -40159,7 +43499,7 @@ } }, { - "id": 45, + "id": 53, "name": "Fn", "kind": 131072, "kindString": "Type parameter", @@ -40172,7 +43512,7 @@ ], "parameters": [ { - "id": 46, + "id": 54, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -40182,13 +43522,13 @@ }, "type": { "type": "reference", - "id": 44, + "id": 52, "name": "FnName", "dereferenced": {} } }, { - "id": 47, + "id": 55, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -40204,14 +43544,14 @@ }, "objectType": { "type": "reference", - "id": 45, + "id": 53, "name": "Fn" } }, "defaultValue": "{}" }, { - "id": 48, + "id": 56, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -40223,14 +43563,14 @@ "type": { "type": "reflection", "declaration": { - "id": 49, + "id": 57, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 52, + "id": 60, "name": "count", "kind": 1024, "kindString": "Property", @@ -40266,7 +43606,7 @@ } }, { - "id": 51, + "id": 59, "name": "get", "kind": 1024, "kindString": "Property", @@ -40289,7 +43629,7 @@ } }, { - "id": 50, + "id": 58, "name": "head", "kind": 1024, "kindString": "Property", @@ -40316,7 +43656,7 @@ { "title": "Properties", "kind": 1024, - "children": [52, 51, 50] + "children": [60, 59, 58] } ] } @@ -40326,11 +43666,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 6, + "id": 14, "name": "Schema" }, { @@ -40343,7 +43683,7 @@ }, "objectType": { "type": "reference", - "id": 45, + "id": 53, "name": "Fn" } }, @@ -40419,17 +43759,18 @@ }, "objectType": { "type": "reference", - "id": 45, + "id": 53, "name": "Fn" } }, { - "type": "intrinsic", - "name": "unknown" + "type": "reference", + "id": 52, + "name": "FnName" }, { - "type": "intrinsic", - "name": "unknown" + "type": "literal", + "value": null } ], "name": "default" @@ -40438,7 +43779,7 @@ ] }, { - "id": 38, + "id": 46, "name": "schema", "kind": 2048, "kindString": "Method", @@ -40452,7 +43793,7 @@ ], "signatures": [ { - "id": 39, + "id": 47, "name": "schema", "kind": 4096, "kindString": "Call signature", @@ -40463,7 +43804,7 @@ }, "typeParameter": [ { - "id": 40, + "id": 48, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", @@ -40476,7 +43817,7 @@ ], "parameters": [ { - "id": 41, + "id": 49, "name": "schema", "kind": 32768, "kindString": "Parameter", @@ -40486,7 +43827,7 @@ }, "type": { "type": "reference", - "id": 40, + "id": 48, "name": "DynamicSchema", "dereferenced": {} } @@ -40494,16 +43835,16 @@ ], "type": { "type": "reference", - "id": 1, + "id": 9, "typeArguments": [ { "type": "reference", - "id": 4, + "id": 12, "name": "Database" }, { "type": "reference", - "id": 40, + "id": 48, "name": "DynamicSchema" }, { @@ -40512,12 +43853,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 40, + "id": 48, "name": "DynamicSchema" }, "objectType": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -40552,17 +43893,17 @@ { "title": "Constructors", "kind": 512, - "children": [2] + "children": [10] }, { "title": "Properties", "kind": 1024, - "children": [20, 18, 19, 17] + "children": [28, 26, 27, 25] }, { "title": "Methods", "kind": 2048, - "children": [25, 42, 38] + "children": [33, 50, 46] } ], "sources": [ @@ -40574,7 +43915,7 @@ ], "typeParameter": [ { - "id": 53, + "id": 61, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -40588,7 +43929,7 @@ } }, { - "id": 54, + "id": 62, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -40608,7 +43949,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } } @@ -40625,7 +43966,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -40645,7 +43986,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } } @@ -40654,7 +43995,7 @@ } }, { - "id": 55, + "id": 63, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -40669,12 +44010,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -40686,12 +44027,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -40704,28 +44045,258 @@ ] }, { - "id": 143, + "id": 654, + "name": "PostgrestError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "Error format", + "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" + }, + "children": [ + { + "id": 655, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 2 + } + ], + "signatures": [ + { + "id": 656, + "name": "new PostgrestError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 657, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 658, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 662, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 73 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 660, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 661, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 659, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 25 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [662, 660, 661, 659] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 654, + "name": "default" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + }, + { + "id": 665, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 9, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 663, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 7, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 664, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 8, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [655] + }, + { + "title": "Properties", + "kind": 1024, + "children": [665, 663, 664] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 6, + "character": 21 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ] + }, + { + "id": 151, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 144, + "id": 152, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 145, + "id": 153, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 146, + "id": 154, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -40736,7 +44307,7 @@ } }, { - "id": 147, + "id": 155, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -40759,14 +44330,14 @@ } }, { - "id": 148, + "id": 156, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 149, + "id": 157, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -40777,7 +44348,7 @@ } }, { - "id": 150, + "id": 158, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -40790,24 +44361,28 @@ ], "parameters": [ { - "id": 151, + "id": 159, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 156, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default", "dereferenced": { - "id": 609, + "id": 615, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -40816,7 +44391,7 @@ }, "children": [ { - "id": 610, + "id": 616, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -40824,56 +44399,80 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 23, "character": 2 } ], "signatures": [ { - "id": 611, + "id": 617, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 612, + "id": 618, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 619, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "parameters": [ { - "id": 613, + "id": 620, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default", - "dereferenced": "[Circular ~.children.2.children.0.signatures.0.parameters.0.type.dereferenced]" + "dereferenced": "[Circular ~.children.3.children.0.signatures.0.parameters.0.type.dereferenced]" } } ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" } ], "name": "default" @@ -40882,7 +44481,7 @@ ] }, { - "id": 618, + "id": 625, "name": "body", "kind": 1024, "kindString": "Property", @@ -40893,7 +44492,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -40903,7 +44502,7 @@ } }, { - "id": 621, + "id": 628, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -40913,28 +44512,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 622, + "id": 629, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 623, + "id": 630, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 624, + "id": 631, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -40958,7 +44557,7 @@ } }, { - "id": 625, + "id": 632, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -40993,7 +44592,7 @@ } }, { - "id": 616, + "id": 623, "name": "headers", "kind": 1024, "kindString": "Property", @@ -41003,7 +44602,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -41025,7 +44624,7 @@ } }, { - "id": 626, + "id": 633, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -41035,7 +44634,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -41045,7 +44644,7 @@ } }, { - "id": 614, + "id": 621, "name": "method", "kind": 1024, "kindString": "Property", @@ -41055,7 +44654,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -41086,7 +44685,7 @@ } }, { - "id": 617, + "id": 624, "name": "schema", "kind": 1024, "kindString": "Property", @@ -41094,48 +44693,6 @@ "isProtected": true, "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 619, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 620, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", @@ -41143,6 +44700,48 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 626, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 627, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -41151,7 +44750,7 @@ } }, { - "id": 615, + "id": 622, "name": "url", "kind": 1024, "kindString": "Property", @@ -41161,7 +44760,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -41173,7 +44772,74 @@ } }, { - "id": 629, + "id": 636, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 637, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 638, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 639, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 640, "name": "then", "kind": 2048, "kindString": "Method", @@ -41181,39 +44847,63 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 630, + "id": 641, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 631, + "id": 642, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } }, { - "id": 632, + "id": 643, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -41226,7 +44916,7 @@ ], "parameters": [ { - "id": 633, + "id": 644, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -41243,36 +44933,60 @@ { "type": "reflection", "declaration": { - "id": 634, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 635, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 636, + "id": 647, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } } ], @@ -41281,7 +44995,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -41289,7 +45003,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -41307,7 +45021,7 @@ } }, { - "id": 637, + "id": 648, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -41324,21 +45038,21 @@ { "type": "reflection", "declaration": { - "id": 638, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 639, + "id": 650, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 640, + "id": 651, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -41354,7 +45068,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -41362,7 +45076,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -41388,12 +45102,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -41415,7 +45129,7 @@ } }, { - "id": 627, + "id": 634, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -41423,13 +45137,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 628, + "id": 635, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -41439,16 +45153,42 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 609, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 612, - "name": "Result" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + }, + { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] } } ] @@ -41458,17 +45198,17 @@ { "title": "Constructors", "kind": 512, - "children": [610] + "children": [616] }, { "title": "Properties", "kind": 1024, - "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] + "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] }, { "title": "Methods", "kind": 2048, - "children": [629, 627] + "children": [636, 640, 634] } ], "sources": [ @@ -41480,17 +45220,32 @@ ], "typeParameter": [ { - "id": 641, + "id": 652, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 653, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "extendedBy": [ { "type": "reference", - "id": 489, + "id": 491, "name": "PostgrestTransformBuilder" } ], @@ -41499,16 +45254,40 @@ "type": "reference", "typeArguments": [ { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } ], "qualifiedName": "PromiseLike", @@ -41522,31 +45301,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -41554,19 +45333,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 491, + "id": 493, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 490, + "id": 492, "name": "default.constructor" } }, { - "id": 461, + "id": 459, "name": "body", "kind": 1024, "kindString": "Property", @@ -41577,7 +45356,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -41587,12 +45366,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 583, "name": "default.body" } }, { - "id": 464, + "id": 462, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -41602,28 +45381,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 465, + "id": 463, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 466, + "id": 464, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 467, + "id": 465, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -41647,7 +45426,7 @@ } }, { - "id": 468, + "id": 466, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -41682,12 +45461,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 584, + "id": 586, "name": "default.fetch" } }, { - "id": 459, + "id": 457, "name": "headers", "kind": 1024, "kindString": "Property", @@ -41697,7 +45476,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -41719,12 +45498,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 581, "name": "default.headers" } }, { - "id": 469, + "id": 467, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -41734,7 +45513,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -41744,12 +45523,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 589, + "id": 591, "name": "default.isMaybeSingle" } }, { - "id": 457, + "id": 455, "name": "method", "kind": 1024, "kindString": "Property", @@ -41759,7 +45538,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -41790,12 +45569,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 579, "name": "default.method" } }, { - "id": 460, + "id": 458, "name": "schema", "kind": 1024, "kindString": "Property", @@ -41803,58 +45582,6 @@ "isProtected": true, "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 580, - "name": "default.schema" - } - }, - { - "id": 462, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 582, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 463, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", @@ -41862,6 +45589,58 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 582, + "name": "default.schema" + } + }, + { + "id": 460, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false", + "inheritedFrom": { + "type": "reference", + "id": 584, + "name": "default.shouldThrowOnError" + } + }, + { + "id": 461, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -41870,12 +45649,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 583, + "id": 585, "name": "default.signal" } }, { - "id": 458, + "id": 456, "name": "url", "kind": 1024, "kindString": "Property", @@ -41885,7 +45664,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -41897,12 +45676,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 578, + "id": 580, "name": "default.url" } }, { - "id": 429, + "id": 427, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -41916,7 +45695,7 @@ ], "signatures": [ { - "id": 430, + "id": 428, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", @@ -41926,7 +45705,7 @@ }, "parameters": [ { - "id": 431, + "id": 429, "name": "signal", "kind": 32768, "kindString": "Parameter", @@ -41944,31 +45723,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -41976,19 +45755,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 550, + "id": 552, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", - "id": 549, + "id": 551, "name": "default.abortSignal" } }, { - "id": 273, + "id": 271, "name": "containedBy", "kind": 2048, "kindString": "Method", @@ -41996,13 +45775,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 281, + "line": 342, "character": 2 } ], "signatures": [ { - "id": 274, + "id": 272, "name": "containedBy", "kind": 4096, "kindString": "Call signature", @@ -42012,7 +45791,7 @@ }, "typeParameter": [ { - "id": 275, + "id": 273, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -42025,7 +45804,7 @@ ], "parameters": [ { - "id": 276, + "id": 274, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -42035,13 +45814,13 @@ }, "type": { "type": "reference", - "id": 275, + "id": 273, "name": "ColumnName", "dereferenced": {} } }, { - "id": 277, + "id": 275, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -42081,12 +45860,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 275, + "id": 273, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -42098,31 +45877,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -42130,7 +45909,7 @@ } }, { - "id": 278, + "id": 276, "name": "containedBy", "kind": 4096, "kindString": "Call signature", @@ -42140,7 +45919,7 @@ }, "parameters": [ { - "id": 279, + "id": 277, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -42154,7 +45933,7 @@ } }, { - "id": 280, + "id": 278, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -42202,31 +45981,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -42236,7 +46015,7 @@ ] }, { - "id": 265, + "id": 263, "name": "contains", "kind": 2048, "kindString": "Method", @@ -42244,13 +46023,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 254, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 266, + "id": 264, "name": "contains", "kind": 4096, "kindString": "Call signature", @@ -42260,7 +46039,7 @@ }, "typeParameter": [ { - "id": 267, + "id": 265, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -42273,7 +46052,7 @@ ], "parameters": [ { - "id": 268, + "id": 266, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -42283,13 +46062,13 @@ }, "type": { "type": "reference", - "id": 267, + "id": 265, "name": "ColumnName", "dereferenced": {} } }, { - "id": 269, + "id": 267, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -42329,12 +46108,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 267, + "id": 265, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -42346,31 +46125,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -42378,7 +46157,7 @@ } }, { - "id": 270, + "id": 268, "name": "contains", "kind": 4096, "kindString": "Call signature", @@ -42388,7 +46167,7 @@ }, "parameters": [ { - "id": 271, + "id": 269, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -42402,7 +46181,7 @@ } }, { - "id": 272, + "id": 270, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -42450,31 +46229,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -42484,7 +46263,7 @@ ] }, { - "id": 438, + "id": 436, "name": "csv", "kind": 2048, "kindString": "Method", @@ -42498,7 +46277,7 @@ ], "signatures": [ { - "id": 439, + "id": 437, "name": "csv", "kind": 4096, "kindString": "Call signature", @@ -42508,30 +46287,34 @@ }, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "intrinsic", "name": "string" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 559, + "id": 561, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", - "id": 558, + "id": 560, "name": "default.csv" } }, { - "id": 152, + "id": 160, "name": "eq", "kind": 2048, "kindString": "Method", @@ -42539,13 +46322,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 35, + "line": 87, "character": 2 } ], "signatures": [ { - "id": 153, + "id": 161, "name": "eq", "kind": 4096, "kindString": "Call signature", @@ -42556,7 +46339,7 @@ }, "typeParameter": [ { - "id": 154, + "id": 162, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -42569,7 +46352,7 @@ ], "parameters": [ { - "id": 155, + "id": 163, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -42579,13 +46362,13 @@ }, "type": { "type": "reference", - "id": 154, + "id": 162, "name": "ColumnName", "dereferenced": {} } }, { - "id": 156, + "id": 164, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -42594,150 +46377,110 @@ "shortText": "The value to filter with\n" }, "type": { - "type": "reference", - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { "type": "reference", "id": 154, - "name": "ColumnName" + "name": "Schema" }, - "objectType": { + { "type": "reference", - "id": 147, + "id": 155, "name": "Row" + }, + { + "type": "reference", + "id": 162, + "name": "ColumnName" } - } - ], - "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 157, - "name": "eq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is equal to `value`.", - "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" - }, - "typeParameter": [ - { - "id": 158, - "name": "Value", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 159, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 160, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "intrinsic", + "name": "never" + }, + "trueType": { + "type": "intrinsic", + "name": "unknown" + }, + "falseType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 158, - "name": "Value" + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 162, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ResolvedFilterValue" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + "falseType": { + "type": "intrinsic", + "name": "never" } - ], - "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + } } } ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -42747,7 +46490,7 @@ ] }, { - "id": 442, + "id": 440, "name": "explain", "kind": 2048, "kindString": "Method", @@ -42761,7 +46504,7 @@ ], "signatures": [ { - "id": 443, + "id": 441, "name": "explain", "kind": 4096, "kindString": "Call signature", @@ -42772,7 +46515,7 @@ }, "parameters": [ { - "id": 444, + "id": 442, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -42784,14 +46527,14 @@ "type": { "type": "reflection", "declaration": { - "id": 445, + "id": 443, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 446, + "id": 444, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -42814,7 +46557,7 @@ } }, { - "id": 449, + "id": 447, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -42837,7 +46580,7 @@ } }, { - "id": 451, + "id": 449, "name": "format", "kind": 1024, "kindString": "Property", @@ -42869,7 +46612,7 @@ } }, { - "id": 448, + "id": 446, "name": "settings", "kind": 1024, "kindString": "Property", @@ -42892,7 +46635,7 @@ } }, { - "id": 447, + "id": 445, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -42915,7 +46658,7 @@ } }, { - "id": 450, + "id": 448, "name": "wal", "kind": 1024, "kindString": "Property", @@ -42942,7 +46685,7 @@ { "title": "Properties", "kind": 1024, - "children": [446, 449, 451, 448, 447, 450] + "children": [444, 447, 449, 446, 445, 448] } ] } @@ -42955,18 +46698,22 @@ "types": [ { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "intrinsic", "name": "string" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "array", @@ -42986,6 +46733,10 @@ "package": "typescript", "name": "Record" } + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -42994,19 +46745,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 563, + "id": 565, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", - "id": 562, + "id": 564, "name": "default.explain" } }, { - "id": 368, + "id": 366, "name": "filter", "kind": 2048, "kindString": "Method", @@ -43014,13 +46765,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 508, + "line": 569, "character": 2 } ], "signatures": [ { - "id": 369, + "id": 367, "name": "filter", "kind": 4096, "kindString": "Call signature", @@ -43031,7 +46782,7 @@ }, "typeParameter": [ { - "id": 370, + "id": 368, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -43044,7 +46795,7 @@ ], "parameters": [ { - "id": 371, + "id": 369, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -43054,13 +46805,13 @@ }, "type": { "type": "reference", - "id": 370, + "id": 368, "name": "ColumnName", "dereferenced": {} } }, { - "id": 372, + "id": 370, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -43167,7 +46918,7 @@ } }, { - "id": 373, + "id": 371, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -43183,31 +46934,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -43215,7 +46966,7 @@ } }, { - "id": 374, + "id": 372, "name": "filter", "kind": 4096, "kindString": "Call signature", @@ -43226,7 +46977,7 @@ }, "parameters": [ { - "id": 375, + "id": 373, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -43240,7 +46991,7 @@ } }, { - "id": 376, + "id": 374, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -43254,7 +47005,7 @@ } }, { - "id": 377, + "id": 375, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -43270,31 +47021,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -43304,7 +47055,7 @@ ] }, { - "id": 440, + "id": 438, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -43318,7 +47069,7 @@ ], "signatures": [ { - "id": 441, + "id": 439, "name": "geojson", "kind": 4096, "kindString": "Call signature", @@ -43328,7 +47079,7 @@ }, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", @@ -43345,25 +47096,29 @@ "qualifiedName": "Record", "package": "typescript", "name": "Record" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 561, + "id": 563, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", - "id": 560, + "id": 562, "name": "default.geojson" } }, { - "id": 169, + "id": 170, "name": "gt", "kind": 2048, "kindString": "Method", @@ -43371,13 +47126,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 66, + "line": 120, "character": 2 } ], "signatures": [ { - "id": 170, + "id": 171, "name": "gt", "kind": 4096, "kindString": "Call signature", @@ -43387,7 +47142,7 @@ }, "typeParameter": [ { - "id": 171, + "id": 172, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -43400,7 +47155,7 @@ ], "parameters": [ { - "id": 172, + "id": 173, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -43410,13 +47165,13 @@ }, "type": { "type": "reference", - "id": 171, + "id": 172, "name": "ColumnName", "dereferenced": {} } }, { - "id": 173, + "id": 174, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -43428,12 +47183,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 171, + "id": 172, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -43441,31 +47196,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -43473,7 +47228,7 @@ } }, { - "id": 174, + "id": 175, "name": "gt", "kind": 4096, "kindString": "Call signature", @@ -43483,7 +47238,7 @@ }, "parameters": [ { - "id": 175, + "id": 176, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -43497,7 +47252,7 @@ } }, { - "id": 176, + "id": 177, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -43513,31 +47268,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -43547,7 +47302,7 @@ ] }, { - "id": 177, + "id": 178, "name": "gte", "kind": 2048, "kindString": "Method", @@ -43555,13 +47310,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 79, + "line": 133, "character": 2 } ], "signatures": [ { - "id": 178, + "id": 179, "name": "gte", "kind": 4096, "kindString": "Call signature", @@ -43571,7 +47326,7 @@ }, "typeParameter": [ { - "id": 179, + "id": 180, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -43584,7 +47339,7 @@ ], "parameters": [ { - "id": 180, + "id": 181, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -43594,13 +47349,13 @@ }, "type": { "type": "reference", - "id": 179, + "id": 180, "name": "ColumnName", "dereferenced": {} } }, { - "id": 181, + "id": 182, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -43612,12 +47367,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 179, + "id": 180, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -43625,31 +47380,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -43657,7 +47412,7 @@ } }, { - "id": 182, + "id": 183, "name": "gte", "kind": 4096, "kindString": "Call signature", @@ -43667,7 +47422,7 @@ }, "parameters": [ { - "id": 183, + "id": 184, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -43681,7 +47436,7 @@ } }, { - "id": 184, + "id": 185, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -43697,31 +47452,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -43731,7 +47486,7 @@ ] }, { - "id": 225, + "id": 226, "name": "ilike", "kind": 2048, "kindString": "Method", @@ -43739,13 +47494,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 163, + "line": 217, "character": 2 } ], "signatures": [ { - "id": 226, + "id": 227, "name": "ilike", "kind": 4096, "kindString": "Call signature", @@ -43754,21 +47509,21 @@ "shortText": "Match only rows where `column` matches `pattern` case-insensitively." }, "typeParameter": [ - { - "id": 227, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ { "id": 228, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 229, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -43778,13 +47533,13 @@ }, "type": { "type": "reference", - "id": 227, + "id": 228, "name": "ColumnName", "dereferenced": {} } }, { - "id": 229, + "id": 230, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -43800,31 +47555,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -43832,7 +47587,7 @@ } }, { - "id": 230, + "id": 231, "name": "ilike", "kind": 4096, "kindString": "Call signature", @@ -43842,7 +47597,7 @@ }, "parameters": [ { - "id": 231, + "id": 232, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -43856,7 +47611,7 @@ } }, { - "id": 232, + "id": 233, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -43872,31 +47627,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -43906,389 +47661,11 @@ ] }, { - "id": 233, + "id": 234, "name": "ilikeAllOf", "kind": 2048, "kindString": "Method", "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 176, - "character": 2 - } - ], - "signatures": [ - { - "id": 234, - "name": "ilikeAllOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." - }, - "typeParameter": [ - { - "id": 235, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 236, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 235, - "name": "ColumnName", - "dereferenced": {} - } - }, - { - "id": 237, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 238, - "name": "ilikeAllOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." - }, - "parameters": [ - { - "id": 239, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 240, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 241, - "name": "ilikeAnyOf", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 192, - "character": 2 - } - ], - "signatures": [ - { - "id": 242, - "name": "ilikeAnyOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." - }, - "typeParameter": [ - { - "id": 243, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 244, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 243, - "name": "ColumnName", - "dereferenced": {} - } - }, - { - "id": 245, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 246, - "name": "ilikeAnyOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." - }, - "parameters": [ - { - "id": 247, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 248, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 257, - "name": "in", - "kind": 2048, - "kindString": "Method", - "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", @@ -44298,17 +47675,17 @@ ], "signatures": [ { - "id": 258, - "name": "in", + "id": 235, + "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." + "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." }, "typeParameter": [ { - "id": 259, + "id": 236, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -44321,7 +47698,7 @@ ], "parameters": [ { - "id": 260, + "id": 237, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -44331,19 +47708,19 @@ }, "type": { "type": "reference", - "id": 259, + "id": 236, "name": "ColumnName", "dereferenced": {} } }, { - "id": 261, - "name": "values", + "id": 238, + "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values array to filter with\n" + "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", @@ -44351,17 +47728,8 @@ "target": { "type": "array", "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 259, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 147, - "name": "Row" - } + "type": "intrinsic", + "name": "string" } } } @@ -44369,31 +47737,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -44401,17 +47769,17 @@ } }, { - "id": 262, - "name": "in", + "id": 239, + "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." + "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." }, "parameters": [ { - "id": 263, + "id": 240, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -44425,7 +47793,306 @@ } }, { - "id": 264, + "id": 241, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 242, + "name": "ilikeAnyOf", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 246, + "character": 2 + } + ], + "signatures": [ + { + "id": 243, + "name": "ilikeAnyOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + }, + "typeParameter": [ + { + "id": 244, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 245, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 244, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 246, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 247, + "name": "ilikeAnyOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + }, + "parameters": [ + { + "id": 248, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 249, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 258, + "name": "in", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 290, + "character": 2 + } + ], + "signatures": [ + { + "id": 259, + "name": "in", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is included in the `values` array." + }, + "typeParameter": [ + { + "id": 260, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 261, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 260, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 262, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -44439,8 +48106,72 @@ "target": { "type": "array", "elementType": { - "type": "intrinsic", - "name": "unknown" + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 260, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "intrinsic", + "name": "never" + }, + "trueType": { + "type": "intrinsic", + "name": "unknown" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 260, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "trueType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } } } } @@ -44448,31 +48179,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -44482,7 +48213,7 @@ ] }, { - "id": 249, + "id": 250, "name": "is", "kind": 2048, "kindString": "Method", @@ -44490,13 +48221,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 208, + "line": 262, "character": 2 } ], "signatures": [ { - "id": 250, + "id": 251, "name": "is", "kind": 4096, "kindString": "Call signature", @@ -44507,7 +48238,7 @@ }, "typeParameter": [ { - "id": 251, + "id": 252, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -44520,7 +48251,7 @@ ], "parameters": [ { - "id": 252, + "id": 253, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -44530,13 +48261,13 @@ }, "type": { "type": "reference", - "id": 251, + "id": 252, "name": "ColumnName", "dereferenced": {} } }, { - "id": 253, + "id": 254, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -44554,12 +48285,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 251, + "id": 252, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } }, @@ -44576,12 +48307,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 251, + "id": 252, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } }, @@ -44598,12 +48329,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 251, + "id": 252, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } }, @@ -44619,31 +48350,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -44651,7 +48382,7 @@ } }, { - "id": 254, + "id": 255, "name": "is", "kind": 4096, "kindString": "Call signature", @@ -44662,7 +48393,7 @@ }, "parameters": [ { - "id": 255, + "id": 256, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -44676,7 +48407,7 @@ } }, { - "id": 256, + "id": 257, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -44701,31 +48432,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -44735,7 +48466,7 @@ ] }, { - "id": 201, + "id": 202, "name": "like", "kind": 2048, "kindString": "Method", @@ -44743,13 +48474,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 118, + "line": 172, "character": 2 } ], "signatures": [ { - "id": 202, + "id": 203, "name": "like", "kind": 4096, "kindString": "Call signature", @@ -44759,7 +48490,7 @@ }, "typeParameter": [ { - "id": 203, + "id": 204, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -44772,7 +48503,7 @@ ], "parameters": [ { - "id": 204, + "id": 205, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -44782,13 +48513,13 @@ }, "type": { "type": "reference", - "id": 203, + "id": 204, "name": "ColumnName", "dereferenced": {} } }, { - "id": 205, + "id": 206, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -44804,31 +48535,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -44836,7 +48567,7 @@ } }, { - "id": 206, + "id": 207, "name": "like", "kind": 4096, "kindString": "Call signature", @@ -44846,7 +48577,7 @@ }, "parameters": [ { - "id": 207, + "id": 208, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -44860,7 +48591,7 @@ } }, { - "id": 208, + "id": 209, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -44876,31 +48607,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -44910,7 +48641,7 @@ ] }, { - "id": 209, + "id": 210, "name": "likeAllOf", "kind": 2048, "kindString": "Method", @@ -44918,13 +48649,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 131, + "line": 185, "character": 2 } ], "signatures": [ { - "id": 210, + "id": 211, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", @@ -44934,7 +48665,7 @@ }, "typeParameter": [ { - "id": 211, + "id": 212, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -44947,7 +48678,7 @@ ], "parameters": [ { - "id": 212, + "id": 213, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -44957,13 +48688,13 @@ }, "type": { "type": "reference", - "id": 211, + "id": 212, "name": "ColumnName", "dereferenced": {} } }, { - "id": 213, + "id": 214, "name": "patterns", "kind": 32768, "kindString": "Parameter", @@ -44986,31 +48717,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -45018,7 +48749,7 @@ } }, { - "id": 214, + "id": 215, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", @@ -45028,7 +48759,7 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -45042,7 +48773,7 @@ } }, { - "id": 216, + "id": 217, "name": "patterns", "kind": 32768, "kindString": "Parameter", @@ -45065,31 +48796,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -45099,7 +48830,7 @@ ] }, { - "id": 217, + "id": 218, "name": "likeAnyOf", "kind": 2048, "kindString": "Method", @@ -45107,13 +48838,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 147, + "line": 201, "character": 2 } ], "signatures": [ { - "id": 218, + "id": 219, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", @@ -45123,7 +48854,7 @@ }, "typeParameter": [ { - "id": 219, + "id": 220, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -45136,7 +48867,7 @@ ], "parameters": [ { - "id": 220, + "id": 221, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -45146,13 +48877,13 @@ }, "type": { "type": "reference", - "id": 219, + "id": 220, "name": "ColumnName", "dereferenced": {} } }, { - "id": 221, + "id": 222, "name": "patterns", "kind": 32768, "kindString": "Parameter", @@ -45175,31 +48906,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -45207,7 +48938,7 @@ } }, { - "id": 222, + "id": 223, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", @@ -45217,7 +48948,7 @@ }, "parameters": [ { - "id": 223, + "id": 224, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -45231,7 +48962,7 @@ } }, { - "id": 224, + "id": 225, "name": "patterns", "kind": 32768, "kindString": "Parameter", @@ -45254,31 +48985,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -45288,7 +49019,7 @@ ] }, { - "id": 414, + "id": 412, "name": "limit", "kind": 2048, "kindString": "Method", @@ -45302,7 +49033,7 @@ ], "signatures": [ { - "id": 415, + "id": 413, "name": "limit", "kind": 4096, "kindString": "Call signature", @@ -45312,7 +49043,7 @@ }, "parameters": [ { - "id": 416, + "id": 414, "name": "count", "kind": 32768, "kindString": "Parameter", @@ -45326,7 +49057,7 @@ } }, { - "id": 417, + "id": 415, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -45338,14 +49069,14 @@ "type": { "type": "reflection", "declaration": { - "id": 418, + "id": 416, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 419, + "id": 417, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -45368,7 +49099,7 @@ } }, { - "id": 420, + "id": 418, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -45395,7 +49126,7 @@ { "title": "Properties", "kind": 1024, - "children": [419, 420] + "children": [417, 418] } ] } @@ -45405,31 +49136,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -45437,19 +49168,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 535, + "id": 537, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", - "id": 534, + "id": 536, "name": "default.limit" } }, { - "id": 185, + "id": 186, "name": "lt", "kind": 2048, "kindString": "Method", @@ -45457,13 +49188,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 92, + "line": 146, "character": 2 } ], "signatures": [ { - "id": 186, + "id": 187, "name": "lt", "kind": 4096, "kindString": "Call signature", @@ -45473,7 +49204,7 @@ }, "typeParameter": [ { - "id": 187, + "id": 188, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -45486,7 +49217,7 @@ ], "parameters": [ { - "id": 188, + "id": 189, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -45496,13 +49227,13 @@ }, "type": { "type": "reference", - "id": 187, + "id": 188, "name": "ColumnName", "dereferenced": {} } }, { - "id": 189, + "id": 190, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -45514,12 +49245,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 187, + "id": 188, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -45527,31 +49258,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -45559,7 +49290,7 @@ } }, { - "id": 190, + "id": 191, "name": "lt", "kind": 4096, "kindString": "Call signature", @@ -45569,7 +49300,7 @@ }, "parameters": [ { - "id": 191, + "id": 192, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -45583,7 +49314,7 @@ } }, { - "id": 192, + "id": 193, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -45599,31 +49330,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -45633,7 +49364,7 @@ ] }, { - "id": 193, + "id": 194, "name": "lte", "kind": 2048, "kindString": "Method", @@ -45641,13 +49372,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 105, + "line": 159, "character": 2 } ], "signatures": [ { - "id": 194, + "id": 195, "name": "lte", "kind": 4096, "kindString": "Call signature", @@ -45657,7 +49388,7 @@ }, "typeParameter": [ { - "id": 195, + "id": 196, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -45670,7 +49401,7 @@ ], "parameters": [ { - "id": 196, + "id": 197, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -45680,13 +49411,13 @@ }, "type": { "type": "reference", - "id": 195, + "id": 196, "name": "ColumnName", "dereferenced": {} } }, { - "id": 197, + "id": 198, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -45698,12 +49429,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 195, + "id": 196, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -45711,31 +49442,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -45743,7 +49474,7 @@ } }, { - "id": 198, + "id": 199, "name": "lte", "kind": 4096, "kindString": "Call signature", @@ -45753,7 +49484,7 @@ }, "parameters": [ { - "id": 199, + "id": 200, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -45767,7 +49498,7 @@ } }, { - "id": 200, + "id": 201, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -45783,31 +49514,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -45817,7 +49548,7 @@ ] }, { - "id": 345, + "id": 343, "name": "match", "kind": 2048, "kindString": "Method", @@ -45825,13 +49556,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 441, + "line": 502, "character": 2 } ], "signatures": [ { - "id": 346, + "id": 344, "name": "match", "kind": 4096, "kindString": "Call signature", @@ -45841,7 +49572,7 @@ }, "typeParameter": [ { - "id": 347, + "id": 345, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -45854,7 +49585,7 @@ ], "parameters": [ { - "id": 348, + "id": 346, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -45867,19 +49598,19 @@ "typeArguments": [ { "type": "reference", - "id": 347, + "id": 345, "name": "ColumnName" }, { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 347, + "id": 345, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -45892,31 +49623,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -45924,7 +49655,7 @@ } }, { - "id": 349, + "id": 347, "name": "match", "kind": 4096, "kindString": "Call signature", @@ -45934,7 +49665,7 @@ }, "parameters": [ { - "id": 350, + "id": 348, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -45962,31 +49693,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -45996,7 +49727,7 @@ ] }, { - "id": 435, + "id": 433, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -46010,7 +49741,7 @@ ], "signatures": [ { - "id": 436, + "id": 434, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", @@ -46021,7 +49752,7 @@ }, "typeParameter": [ { - "id": 437, + "id": 435, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -46030,7 +49761,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, "extendsType": { @@ -46053,7 +49784,7 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "union", @@ -46064,29 +49795,33 @@ }, { "type": "reference", - "id": 437, + "id": 435, "name": "ResultOne" } ] + }, + { + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 556, + "id": 558, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", - "id": 555, + "id": 557, "name": "default.maybeSingle" } }, { - "id": 161, + "id": 165, "name": "neq", "kind": 2048, "kindString": "Method", @@ -46094,13 +49829,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 53, + "line": 108, "character": 2 } ], "signatures": [ { - "id": 162, + "id": 166, "name": "neq", "kind": 4096, "kindString": "Call signature", @@ -46110,7 +49845,7 @@ }, "typeParameter": [ { - "id": 163, + "id": 167, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -46123,7 +49858,7 @@ ], "parameters": [ { - "id": 164, + "id": 168, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -46133,13 +49868,13 @@ }, "type": { "type": "reference", - "id": 163, + "id": 167, "name": "ColumnName", "dereferenced": {} } }, { - "id": 165, + "id": 169, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -46148,119 +49883,102 @@ "shortText": "The value to filter with\n" }, "type": { - "type": "indexedAccess", - "indexType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 163, - "name": "ColumnName" + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 167, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" }, - "objectType": { - "type": "reference", - "id": 147, - "name": "Row" + "extendsType": { + "type": "intrinsic", + "name": "never" + }, + "trueType": { + "type": "intrinsic", + "name": "unknown" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 167, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "trueType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } } } } ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 166, - "name": "neq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is not equal to `value`." - }, - "parameters": [ - { - "id": 167, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 168, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -46270,7 +49988,7 @@ ] }, { - "id": 351, + "id": 349, "name": "not", "kind": 2048, "kindString": "Method", @@ -46278,13 +49996,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 457, + "line": 518, "character": 2 } ], "signatures": [ { - "id": 352, + "id": 350, "name": "not", "kind": 4096, "kindString": "Call signature", @@ -46295,7 +50013,7 @@ }, "typeParameter": [ { - "id": 353, + "id": 351, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -46308,7 +50026,7 @@ ], "parameters": [ { - "id": 354, + "id": 352, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -46318,13 +50036,13 @@ }, "type": { "type": "reference", - "id": 353, + "id": 351, "name": "ColumnName", "dereferenced": {} } }, { - "id": 355, + "id": 353, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -46338,7 +50056,7 @@ } }, { - "id": 356, + "id": 354, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -46350,12 +50068,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 353, + "id": 351, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -46363,31 +50081,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -46395,7 +50113,7 @@ } }, { - "id": 357, + "id": 355, "name": "not", "kind": 4096, "kindString": "Call signature", @@ -46406,7 +50124,7 @@ }, "parameters": [ { - "id": 358, + "id": 356, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -46420,7 +50138,7 @@ } }, { - "id": 359, + "id": 357, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -46434,7 +50152,7 @@ } }, { - "id": 360, + "id": 358, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -46450,31 +50168,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -46484,7 +50202,7 @@ ] }, { - "id": 361, + "id": 359, "name": "or", "kind": 2048, "kindString": "Method", @@ -46492,13 +50210,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 496, + "line": 557, "character": 2 } ], "signatures": [ { - "id": 362, + "id": 360, "name": "or", "kind": 4096, "kindString": "Call signature", @@ -46509,7 +50227,7 @@ }, "parameters": [ { - "id": 363, + "id": 361, "name": "filters", "kind": 32768, "kindString": "Parameter", @@ -46523,7 +50241,7 @@ } }, { - "id": 364, + "id": 362, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -46535,14 +50253,14 @@ "type": { "type": "reflection", "declaration": { - "id": 365, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 366, + "id": 364, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -46555,7 +50273,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 501, + "line": 562, "character": 9 } ], @@ -46565,7 +50283,7 @@ } }, { - "id": 367, + "id": 365, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -46578,7 +50296,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 501, + "line": 562, "character": 32 } ], @@ -46592,7 +50310,7 @@ { "title": "Properties", "kind": 1024, - "children": [366, 367] + "children": [364, 365] } ] } @@ -46602,31 +50320,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -46636,7 +50354,7 @@ ] }, { - "id": 383, + "id": 381, "name": "order", "kind": 2048, "kindString": "Method", @@ -46650,7 +50368,7 @@ ], "signatures": [ { - "id": 384, + "id": 382, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -46660,37 +50378,37 @@ "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "typeParameter": [ + { + "id": 383, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 384, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 383, + "name": "ColumnName", + "dereferenced": {} + } + }, { "id": 385, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 386, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 385, - "name": "ColumnName", - "dereferenced": {} - } - }, - { - "id": 387, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -46703,14 +50421,14 @@ "type": { "type": "reflection", "declaration": { - "id": 388, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 389, + "id": 387, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -46733,7 +50451,7 @@ } }, { - "id": 390, + "id": 388, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -46756,7 +50474,7 @@ } }, { - "id": 391, + "id": 389, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -46783,7 +50501,7 @@ { "title": "Properties", "kind": 1024, - "children": [389, 390, 391] + "children": [387, 388, 389] } ] } @@ -46792,31 +50510,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -46824,12 +50542,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 504, + "id": 506, "name": "default.order" } }, { - "id": 392, + "id": 390, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -46840,7 +50558,7 @@ }, "parameters": [ { - "id": 393, + "id": 391, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -46854,7 +50572,7 @@ } }, { - "id": 394, + "id": 392, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -46867,14 +50585,14 @@ "type": { "type": "reflection", "declaration": { - "id": 395, + "id": 393, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 396, + "id": 394, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -46897,7 +50615,7 @@ } }, { - "id": 397, + "id": 395, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -46920,7 +50638,7 @@ } }, { - "id": 398, + "id": 396, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -46947,7 +50665,7 @@ { "title": "Properties", "kind": 1024, - "children": [396, 397, 398] + "children": [394, 395, 396] } ] } @@ -46956,31 +50674,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -46988,12 +50706,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 512, + "id": 514, "name": "default.order" } }, { - "id": 399, + "id": 397, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -47010,7 +50728,7 @@ }, "typeParameter": [ { - "id": 400, + "id": 398, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -47023,7 +50741,7 @@ ], "parameters": [ { - "id": 401, + "id": 399, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -47033,13 +50751,13 @@ }, "type": { "type": "reference", - "id": 400, + "id": 398, "name": "ColumnName", "dereferenced": {} } }, { - "id": 402, + "id": 400, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -47052,14 +50770,14 @@ "type": { "type": "reflection", "declaration": { - "id": 403, + "id": 401, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 404, + "id": 402, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -47079,7 +50797,7 @@ } }, { - "id": 406, + "id": 404, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -47099,7 +50817,7 @@ } }, { - "id": 405, + "id": 403, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -47123,7 +50841,7 @@ { "title": "Properties", "kind": 1024, - "children": [404, 406, 405] + "children": [402, 404, 403] } ] } @@ -47132,31 +50850,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -47164,12 +50882,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 519, + "id": 521, "name": "default.order" } }, { - "id": 407, + "id": 405, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -47186,7 +50904,7 @@ }, "parameters": [ { - "id": 408, + "id": 406, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -47200,7 +50918,7 @@ } }, { - "id": 409, + "id": 407, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -47213,14 +50931,14 @@ "type": { "type": "reflection", "declaration": { - "id": 410, + "id": 408, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 411, + "id": 409, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -47240,7 +50958,7 @@ } }, { - "id": 413, + "id": 411, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -47260,7 +50978,7 @@ } }, { - "id": 412, + "id": 410, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -47284,7 +51002,7 @@ { "title": "Properties", "kind": 1024, - "children": [411, 413, 412] + "children": [409, 411, 410] } ] } @@ -47293,31 +51011,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -47325,19 +51043,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 527, + "id": 529, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", - "id": 503, + "id": 505, "name": "default.order" } }, { - "id": 321, + "id": 319, "name": "overlaps", "kind": 2048, "kindString": "Method", @@ -47345,13 +51063,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 380, + "line": 441, "character": 2 } ], "signatures": [ { - "id": 322, + "id": 320, "name": "overlaps", "kind": 4096, "kindString": "Call signature", @@ -47361,7 +51079,7 @@ }, "typeParameter": [ { - "id": 323, + "id": 321, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -47374,7 +51092,7 @@ ], "parameters": [ { - "id": 324, + "id": 322, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -47384,13 +51102,13 @@ }, "type": { "type": "reference", - "id": 323, + "id": 321, "name": "ColumnName", "dereferenced": {} } }, { - "id": 325, + "id": 323, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -47414,12 +51132,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 323, + "id": 321, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -47431,31 +51149,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -47463,7 +51181,7 @@ } }, { - "id": 326, + "id": 324, "name": "overlaps", "kind": 4096, "kindString": "Call signature", @@ -47473,7 +51191,7 @@ }, "parameters": [ { - "id": 327, + "id": 325, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -47487,7 +51205,7 @@ } }, { - "id": 328, + "id": 326, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -47519,31 +51237,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -47553,7 +51271,7 @@ ] }, { - "id": 421, + "id": 419, "name": "range", "kind": 2048, "kindString": "Method", @@ -47567,17 +51285,17 @@ ], "signatures": [ { - "id": 422, + "id": 420, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by starting at an offset (`from`) and ending at the offset (`from + 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." + "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." }, "parameters": [ { - "id": 423, + "id": 421, "name": "from", "kind": 32768, "kindString": "Parameter", @@ -47591,7 +51309,7 @@ } }, { - "id": 424, + "id": 422, "name": "to", "kind": 32768, "kindString": "Parameter", @@ -47605,7 +51323,7 @@ } }, { - "id": 425, + "id": 423, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -47617,14 +51335,14 @@ "type": { "type": "reflection", "declaration": { - "id": 426, + "id": 424, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 427, + "id": 425, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -47647,7 +51365,7 @@ } }, { - "id": 428, + "id": 426, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -47674,7 +51392,7 @@ { "title": "Properties", "kind": 1024, - "children": [427, 428] + "children": [425, 426] } ] } @@ -47684,31 +51402,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -47716,19 +51434,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 542, + "id": 544, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", - "id": 541, + "id": 543, "name": "default.range" } }, { - "id": 313, + "id": 311, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", @@ -47736,13 +51454,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 365, + "line": 426, "character": 2 } ], "signatures": [ { - "id": 314, + "id": 312, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", @@ -47752,7 +51470,7 @@ }, "typeParameter": [ { - "id": 315, + "id": 313, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -47765,7 +51483,7 @@ ], "parameters": [ { - "id": 316, + "id": 314, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -47775,13 +51493,13 @@ }, "type": { "type": "reference", - "id": 315, + "id": 313, "name": "ColumnName", "dereferenced": {} } }, { - "id": 317, + "id": 315, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -47797,31 +51515,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -47829,7 +51547,7 @@ } }, { - "id": 318, + "id": 316, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", @@ -47839,7 +51557,7 @@ }, "parameters": [ { - "id": 319, + "id": 317, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -47853,7 +51571,7 @@ } }, { - "id": 320, + "id": 318, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -47869,31 +51587,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -47903,7 +51621,7 @@ ] }, { - "id": 281, + "id": 279, "name": "rangeGt", "kind": 2048, "kindString": "Method", @@ -47911,13 +51629,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 307, + "line": 368, "character": 2 } ], "signatures": [ { - "id": 282, + "id": 280, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", @@ -47927,7 +51645,7 @@ }, "typeParameter": [ { - "id": 283, + "id": 281, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -47940,7 +51658,7 @@ ], "parameters": [ { - "id": 284, + "id": 282, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -47950,13 +51668,13 @@ }, "type": { "type": "reference", - "id": 283, + "id": 281, "name": "ColumnName", "dereferenced": {} } }, { - "id": 285, + "id": 283, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -47972,31 +51690,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -48004,7 +51722,7 @@ } }, { - "id": 286, + "id": 284, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", @@ -48014,7 +51732,7 @@ }, "parameters": [ { - "id": 287, + "id": 285, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -48028,7 +51746,7 @@ } }, { - "id": 288, + "id": 286, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -48044,31 +51762,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -48078,7 +51796,7 @@ ] }, { - "id": 289, + "id": 287, "name": "rangeGte", "kind": 2048, "kindString": "Method", @@ -48086,13 +51804,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 321, + "line": 382, "character": 2 } ], "signatures": [ { - "id": 290, + "id": 288, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", @@ -48102,7 +51820,7 @@ }, "typeParameter": [ { - "id": 291, + "id": 289, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -48115,7 +51833,7 @@ ], "parameters": [ { - "id": 292, + "id": 290, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -48125,13 +51843,13 @@ }, "type": { "type": "reference", - "id": 291, + "id": 289, "name": "ColumnName", "dereferenced": {} } }, { - "id": 293, + "id": 291, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -48147,31 +51865,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -48179,7 +51897,7 @@ } }, { - "id": 294, + "id": 292, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", @@ -48189,7 +51907,7 @@ }, "parameters": [ { - "id": 295, + "id": 293, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -48203,7 +51921,7 @@ } }, { - "id": 296, + "id": 294, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -48219,31 +51937,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -48253,7 +51971,7 @@ ] }, { - "id": 297, + "id": 295, "name": "rangeLt", "kind": 2048, "kindString": "Method", @@ -48261,13 +51979,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 336, + "line": 397, "character": 2 } ], "signatures": [ { - "id": 298, + "id": 296, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", @@ -48277,7 +51995,7 @@ }, "typeParameter": [ { - "id": 299, + "id": 297, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -48290,7 +52008,7 @@ ], "parameters": [ { - "id": 300, + "id": 298, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -48300,13 +52018,13 @@ }, "type": { "type": "reference", - "id": 299, + "id": 297, "name": "ColumnName", "dereferenced": {} } }, { - "id": 301, + "id": 299, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -48322,31 +52040,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -48354,7 +52072,7 @@ } }, { - "id": 302, + "id": 300, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", @@ -48364,7 +52082,7 @@ }, "parameters": [ { - "id": 303, + "id": 301, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -48378,7 +52096,7 @@ } }, { - "id": 304, + "id": 302, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -48394,31 +52112,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -48428,7 +52146,7 @@ ] }, { - "id": 305, + "id": 303, "name": "rangeLte", "kind": 2048, "kindString": "Method", @@ -48436,13 +52154,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 350, + "line": 411, "character": 2 } ], "signatures": [ { - "id": 306, + "id": 304, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", @@ -48452,7 +52170,7 @@ }, "typeParameter": [ { - "id": 307, + "id": 305, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -48465,7 +52183,7 @@ ], "parameters": [ { - "id": 308, + "id": 306, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -48475,13 +52193,13 @@ }, "type": { "type": "reference", - "id": 307, + "id": 305, "name": "ColumnName", "dereferenced": {} } }, { - "id": 309, + "id": 307, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -48497,31 +52215,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -48529,7 +52247,7 @@ } }, { - "id": 310, + "id": 308, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", @@ -48539,7 +52257,7 @@ }, "parameters": [ { - "id": 311, + "id": 309, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -48553,7 +52271,7 @@ } }, { - "id": 312, + "id": 310, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -48569,31 +52287,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -48603,7 +52321,7 @@ ] }, { - "id": 454, + "id": 452, "name": "returns", "kind": 2048, "kindString": "Method", @@ -48617,7 +52335,7 @@ ], "signatures": [ { - "id": 455, + "id": 453, "name": "returns", "kind": 4096, "kindString": "Call signature", @@ -48627,7 +52345,7 @@ }, "typeParameter": [ { - "id": 456, + "id": 454, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", @@ -48639,31 +52357,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 456, + "id": 454, "name": "NewResult" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -48671,19 +52389,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 575, + "id": 577, "name": "default.returns" } } ], "inheritedFrom": { "type": "reference", - "id": 574, + "id": 576, "name": "default.returns" } }, { - "id": 452, + "id": 450, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -48697,7 +52415,7 @@ ], "signatures": [ { - "id": 453, + "id": 451, "name": "rollback", "kind": 4096, "kindString": "Call signature", @@ -48708,31 +52426,31 @@ }, "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -48740,19 +52458,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 573, + "id": 575, "name": "default.rollback" } } ], "inheritedFrom": { "type": "reference", - "id": 572, + "id": 574, "name": "default.rollback" } }, { - "id": 378, + "id": 376, "name": "select", "kind": 2048, "kindString": "Method", @@ -48766,7 +52484,7 @@ ], "signatures": [ { - "id": 379, + "id": 377, "name": "select", "kind": 4096, "kindString": "Call signature", @@ -48777,7 +52495,7 @@ }, "typeParameter": [ { - "id": 380, + "id": 378, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -48792,37 +52510,38 @@ } }, { - "id": 381, + "id": 379, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", + "id": 685, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" }, { "type": "reference", - "id": 380, + "id": 378, "name": "Query" } ], @@ -48832,7 +52551,7 @@ ], "parameters": [ { - "id": 382, + "id": 380, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -48844,7 +52563,7 @@ }, "type": { "type": "reference", - "id": 380, + "id": 378, "name": "Query", "dereferenced": {} } @@ -48852,34 +52571,34 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 381, + "id": 379, "name": "NewResultOne" } }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -48887,19 +52606,111 @@ }, "inheritedFrom": { "type": "reference", - "id": 499, + "id": 501, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", - "id": 498, + "id": 500, "name": "default.select" } }, { - "id": 432, + "id": 470, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 471, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 472, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 473, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 595, + "name": "default.setHeader" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 594, + "name": "default.setHeader" + } + }, + { + "id": 430, "name": "single", "kind": 2048, "kindString": "Method", @@ -48913,7 +52724,7 @@ ], "signatures": [ { - "id": 433, + "id": 431, "name": "single", "kind": 4096, "kindString": "Call signature", @@ -48924,7 +52735,7 @@ }, "typeParameter": [ { - "id": 434, + "id": 432, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -48933,7 +52744,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, "extendsType": { @@ -48956,31 +52767,35 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 434, + "id": 432, "name": "ResultOne" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 553, + "id": 555, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", - "id": 552, + "id": 554, "name": "default.single" } }, { - "id": 329, + "id": 327, "name": "textSearch", "kind": 2048, "kindString": "Method", @@ -48988,13 +52803,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 403, + "line": 464, "character": 2 } ], "signatures": [ { - "id": 330, + "id": 328, "name": "textSearch", "kind": 4096, "kindString": "Call signature", @@ -49004,7 +52819,7 @@ }, "typeParameter": [ { - "id": 331, + "id": 329, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -49017,7 +52832,7 @@ ], "parameters": [ { - "id": 332, + "id": 330, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -49027,13 +52842,13 @@ }, "type": { "type": "reference", - "id": 331, + "id": 329, "name": "ColumnName", "dereferenced": {} } }, { - "id": 333, + "id": 331, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -49047,7 +52862,7 @@ } }, { - "id": 334, + "id": 332, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -49060,14 +52875,14 @@ "type": { "type": "reflection", "declaration": { - "id": 335, + "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 336, + "id": 334, "name": "config", "kind": 1024, "kindString": "Property", @@ -49080,7 +52895,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 406, + "line": 467, "character": 16 } ], @@ -49090,7 +52905,7 @@ } }, { - "id": 337, + "id": 335, "name": "type", "kind": 1024, "kindString": "Property", @@ -49103,7 +52918,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 406, + "line": 467, "character": 33 } ], @@ -49130,7 +52945,7 @@ { "title": "Properties", "kind": 1024, - "children": [336, 337] + "children": [334, 335] } ] } @@ -49139,31 +52954,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -49171,7 +52986,7 @@ } }, { - "id": 338, + "id": 336, "name": "textSearch", "kind": 4096, "kindString": "Call signature", @@ -49181,7 +52996,7 @@ }, "parameters": [ { - "id": 339, + "id": 337, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -49195,7 +53010,7 @@ } }, { - "id": 340, + "id": 338, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -49209,7 +53024,7 @@ } }, { - "id": 341, + "id": 339, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -49222,14 +53037,14 @@ "type": { "type": "reflection", "declaration": { - "id": 342, + "id": 340, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 343, + "id": 341, "name": "config", "kind": 1024, "kindString": "Property", @@ -49242,7 +53057,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 411, + "line": 472, "character": 16 } ], @@ -49252,7 +53067,7 @@ } }, { - "id": 344, + "id": 342, "name": "type", "kind": 1024, "kindString": "Property", @@ -49265,7 +53080,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 411, + "line": 472, "character": 33 } ], @@ -49292,7 +53107,7 @@ { "title": "Properties", "kind": 1024, - "children": [343, 344] + "children": [341, 342] } ] } @@ -49301,31 +53116,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -49335,7 +53150,7 @@ ] }, { - "id": 472, + "id": 474, "name": "then", "kind": 2048, "kindString": "Method", @@ -49343,31 +53158,31 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 473, + "id": 475, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 474, + "id": 476, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 156, "name": "Result" } ], @@ -49375,7 +53190,7 @@ } }, { - "id": 475, + "id": 477, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -49388,7 +53203,7 @@ ], "parameters": [ { - "id": 476, + "id": 478, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -49405,32 +53220,32 @@ { "type": "reflection", "declaration": { - "id": 477, + "id": 479, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 478, + "id": 480, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 479, + "id": 481, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 156, "name": "Result" } ], @@ -49443,7 +53258,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -49451,7 +53266,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -49469,7 +53284,7 @@ } }, { - "id": 480, + "id": 482, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -49486,21 +53301,21 @@ { "type": "reflection", "declaration": { - "id": 481, + "id": 483, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 482, + "id": 484, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 483, + "id": 485, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -49516,7 +53331,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -49524,7 +53339,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -49550,12 +53365,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -49567,19 +53382,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 593, + "id": 599, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 592, + "id": 598, "name": "default.then" } }, { - "id": 470, + "id": 468, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -49587,13 +53402,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 471, + "id": 469, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -49603,47 +53418,68 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 143, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 146, - "name": "Schema" + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" }, { "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] }, "inheritedFrom": { "type": "reference", - "id": 591, + "id": 593, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 590, + "id": 592, "name": "default.throwOnError" } } @@ -49652,33 +53488,33 @@ { "title": "Constructors", "kind": 512, - "children": [144] + "children": [152] }, { "title": "Properties", "kind": 1024, - "children": [461, 464, 459, 469, 457, 460, 462, 463, 458] + "children": [459, 462, 457, 467, 455, 458, 460, 461, 456] }, { "title": "Methods", "kind": 2048, "children": [ - 429, 273, 265, 438, 152, 442, 368, 440, 169, 177, 225, 233, 241, 257, 249, 201, 209, - 217, 414, 185, 193, 345, 435, 161, 351, 361, 383, 321, 421, 313, 281, 289, 297, 305, - 454, 452, 378, 432, 329, 472, 470 + 427, 271, 263, 436, 160, 440, 366, 438, 170, 178, 226, 234, 242, 258, 250, 202, 210, + 218, 412, 186, 194, 343, 433, 165, 349, 359, 381, 319, 419, 311, 279, 287, 295, 303, + 452, 450, 376, 470, 430, 327, 474, 468 ] } ], "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 28, + "line": 72, "character": 21 } ], "typeParameter": [ { - "id": 484, + "id": 486, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -49689,7 +53525,7 @@ } }, { - "id": 485, + "id": 487, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -49712,14 +53548,14 @@ } }, { - "id": 486, + "id": 488, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 487, + "id": 489, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -49730,7 +53566,7 @@ } }, { - "id": 488, + "id": 490, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -49744,31 +53580,31 @@ "extendedTypes": [ { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -49777,14 +53613,14 @@ ] }, { - "id": 56, + "id": 64, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 57, + "id": 65, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -49798,14 +53634,14 @@ ], "signatures": [ { - "id": 58, + "id": 66, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 59, + "id": 67, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -49816,7 +53652,7 @@ } }, { - "id": 60, + "id": 68, "name": "Relation", "kind": 131072, "kindString": "Type parameter", @@ -49836,7 +53672,7 @@ } }, { - "id": 61, + "id": 69, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -49847,7 +53683,7 @@ } }, { - "id": 64, + "id": 72, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -49856,20 +53692,20 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { - "id": 62, + "id": 70, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 63, + "id": 71, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -49891,7 +53727,7 @@ { "title": "Properties", "kind": 1024, - "children": [63] + "children": [71] } ] } @@ -49909,7 +53745,7 @@ ], "parameters": [ { - "id": 65, + "id": 73, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -49922,7 +53758,7 @@ } }, { - "id": 66, + "id": 74, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -49930,14 +53766,14 @@ "type": { "type": "reflection", "declaration": { - "id": 67, + "id": 75, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 70, + "id": 78, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -49954,21 +53790,21 @@ "type": { "type": "reflection", "declaration": { - "id": 71, + "id": 79, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 72, + "id": 80, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 73, + "id": 81, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -49992,7 +53828,7 @@ } }, { - "id": 74, + "id": 82, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -50027,7 +53863,7 @@ } }, { - "id": 68, + "id": 76, "name": "headers", "kind": 1024, "kindString": "Property", @@ -50059,7 +53895,7 @@ } }, { - "id": 69, + "id": 77, "name": "schema", "kind": 1024, "kindString": "Property", @@ -50083,7 +53919,7 @@ { "title": "Properties", "kind": 1024, - "children": [70, 68, 69] + "children": [78, 76, 77] } ] } @@ -50092,26 +53928,26 @@ ], "type": { "type": "reference", - "id": 56, + "id": 64, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -50121,7 +53957,7 @@ ] }, { - "id": 79, + "id": 87, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -50138,21 +53974,21 @@ "type": { "type": "reflection", "declaration": { - "id": 80, + "id": 88, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 81, + "id": 89, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 82, + "id": 90, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -50176,7 +54012,7 @@ } }, { - "id": 83, + "id": 91, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -50211,7 +54047,7 @@ } }, { - "id": 76, + "id": 84, "name": "headers", "kind": 1024, "kindString": "Property", @@ -50241,7 +54077,7 @@ } }, { - "id": 77, + "id": 85, "name": "schema", "kind": 1024, "kindString": "Property", @@ -50261,7 +54097,7 @@ } }, { - "id": 78, + "id": 86, "name": "signal", "kind": 1024, "kindString": "Property", @@ -50283,7 +54119,7 @@ } }, { - "id": 75, + "id": 83, "name": "url", "kind": 1024, "kindString": "Property", @@ -50303,7 +54139,7 @@ } }, { - "id": 132, + "id": 140, "name": "delete", "kind": 2048, "kindString": "Method", @@ -50317,7 +54153,7 @@ ], "signatures": [ { - "id": 133, + "id": 141, "name": "delete", "kind": 4096, "kindString": "Call signature", @@ -50328,7 +54164,7 @@ }, "parameters": [ { - "id": 134, + "id": 142, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -50340,14 +54176,14 @@ "type": { "type": "reflection", "declaration": { - "id": 135, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 136, + "id": 144, "name": "count", "kind": 1024, "kindString": "Property", @@ -50387,7 +54223,7 @@ { "title": "Properties", "kind": 1024, - "children": [136] + "children": [144] } ] } @@ -50397,11 +54233,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -50412,7 +54248,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -50422,12 +54258,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -50437,7 +54273,7 @@ ] }, { - "id": 93, + "id": 101, "name": "insert", "kind": 2048, "kindString": "Method", @@ -50451,7 +54287,7 @@ ], "signatures": [ { - "id": 94, + "id": 102, "name": "insert", "kind": 4096, "kindString": "Call signature", @@ -50462,7 +54298,7 @@ }, "typeParameter": [ { - "id": 95, + "id": 103, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -50487,7 +54323,7 @@ ], "parameters": [ { - "id": 96, + "id": 104, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -50497,13 +54333,13 @@ }, "type": { "type": "reference", - "id": 95, + "id": 103, "name": "Row", "dereferenced": {} } }, { - "id": 97, + "id": 105, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -50516,14 +54352,14 @@ "type": { "type": "reflection", "declaration": { - "id": 98, + "id": 106, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 99, + "id": 107, "name": "count", "kind": 1024, "kindString": "Property", @@ -50563,7 +54399,7 @@ { "title": "Properties", "kind": 1024, - "children": [99] + "children": [107] } ] } @@ -50572,11 +54408,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -50587,7 +54423,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -50597,12 +54433,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -50610,7 +54446,7 @@ } }, { - "id": 100, + "id": 108, "name": "insert", "kind": 4096, "kindString": "Call signature", @@ -50621,7 +54457,7 @@ }, "typeParameter": [ { - "id": 101, + "id": 109, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -50646,7 +54482,7 @@ ], "parameters": [ { - "id": 102, + "id": 110, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -50658,13 +54494,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 101, + "id": 109, "name": "Row" } } }, { - "id": 103, + "id": 111, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -50677,14 +54513,14 @@ "type": { "type": "reflection", "declaration": { - "id": 104, + "id": 112, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 105, + "id": 113, "name": "count", "kind": 1024, "kindString": "Property", @@ -50720,7 +54556,7 @@ } }, { - "id": 106, + "id": 114, "name": "defaultToNull", "kind": 1024, "kindString": "Property", @@ -50747,7 +54583,7 @@ { "title": "Properties", "kind": 1024, - "children": [105, 106] + "children": [113, 114] } ] } @@ -50756,11 +54592,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -50771,7 +54607,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -50781,12 +54617,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -50796,7 +54632,7 @@ ] }, { - "id": 84, + "id": 92, "name": "select", "kind": 2048, "kindString": "Method", @@ -50810,7 +54646,7 @@ ], "signatures": [ { - "id": 85, + "id": 93, "name": "select", "kind": 4096, "kindString": "Call signature", @@ -50820,7 +54656,7 @@ }, "typeParameter": [ { - "id": 86, + "id": 94, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -50835,17 +54671,18 @@ } }, { - "id": 87, + "id": 95, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", + "id": 685, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -50856,23 +54693,23 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" }, { "type": "reference", - "id": 86, + "id": 94, "name": "Query" } ], @@ -50882,7 +54719,7 @@ ], "parameters": [ { - "id": 88, + "id": 96, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -50894,13 +54731,13 @@ }, "type": { "type": "reference", - "id": 86, + "id": 94, "name": "Query", "dereferenced": {} } }, { - "id": 89, + "id": 97, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -50912,14 +54749,14 @@ "type": { "type": "reflection", "declaration": { - "id": 90, + "id": 98, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 92, + "id": 100, "name": "count", "kind": 1024, "kindString": "Property", @@ -50955,7 +54792,7 @@ } }, { - "id": 91, + "id": 99, "name": "head", "kind": 1024, "kindString": "Property", @@ -50982,7 +54819,7 @@ { "title": "Properties", "kind": 1024, - "children": [92, 91] + "children": [100, 99] } ] } @@ -50992,11 +54829,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -51007,7 +54844,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -51015,18 +54852,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 87, + "id": 95, "name": "ResultOne" } }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -51036,7 +54873,7 @@ ] }, { - "id": 125, + "id": 133, "name": "update", "kind": 2048, "kindString": "Method", @@ -51050,7 +54887,7 @@ ], "signatures": [ { - "id": 126, + "id": 134, "name": "update", "kind": 4096, "kindString": "Call signature", @@ -51061,7 +54898,7 @@ }, "typeParameter": [ { - "id": 127, + "id": 135, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -51086,7 +54923,7 @@ ], "parameters": [ { - "id": 128, + "id": 136, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -51096,13 +54933,13 @@ }, "type": { "type": "reference", - "id": 127, + "id": 135, "name": "Row", "dereferenced": {} } }, { - "id": 129, + "id": 137, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -51114,14 +54951,14 @@ "type": { "type": "reflection", "declaration": { - "id": 130, + "id": 138, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 131, + "id": 139, "name": "count", "kind": 1024, "kindString": "Property", @@ -51161,7 +54998,7 @@ { "title": "Properties", "kind": 1024, - "children": [131] + "children": [139] } ] } @@ -51171,11 +55008,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -51186,7 +55023,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -51196,12 +55033,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -51211,7 +55048,7 @@ ] }, { - "id": 107, + "id": 115, "name": "upsert", "kind": 2048, "kindString": "Method", @@ -51224,211 +55061,6 @@ } ], "signatures": [ - { - "id": 108, - "name": "upsert", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "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`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" - }, - "typeParameter": [ - { - "id": 109, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "parameters": [ - { - "id": 110, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" - }, - "type": { - "type": "reference", - "id": 109, - "name": "Row", - "dereferenced": {} - } - }, - { - "id": 111, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 112, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 115, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "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.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 189, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 114, - "name": "ignoreDuplicates", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 188, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 113, - "name": "onConflict", - "kind": 1024, - "kindString": "Property", - "flags": { - "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.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 187, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [115, 114, 113] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 59, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 60, - "name": "Relation" - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 61, - "name": "RelationName" - }, - { - "type": "reference", - "id": 64, - "name": "Relationships" - } - ], - "name": "default" - } - }, { "id": 116, "name": "upsert", @@ -51475,12 +55107,10 @@ "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 117, - "name": "Row" - } + "type": "reference", + "id": 117, + "name": "Row", + "dereferenced": {} } }, { @@ -51514,6 +55144,213 @@ "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.\n" }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 189, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 122, + "name": "ignoreDuplicates", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 188, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 121, + "name": "onConflict", + "kind": 1024, + "kindString": "Property", + "flags": { + "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.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 187, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [123, 122, 121] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 67, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 68, + "name": "Relation" + } + }, + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 69, + "name": "RelationName" + }, + { + "type": "reference", + "id": 72, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 124, + "name": "upsert", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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`.", + "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + }, + "typeParameter": [ + { + "id": 125, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "parameters": [ + { + "id": 126, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 125, + "name": "Row" + } + } + }, + { + "id": 127, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters\n" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 128, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 131, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "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.\n" + }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", @@ -51540,7 +55377,7 @@ } }, { - "id": 124, + "id": 132, "name": "defaultToNull", "kind": 1024, "kindString": "Property", @@ -51563,7 +55400,7 @@ } }, { - "id": 122, + "id": 130, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", @@ -51586,7 +55423,7 @@ } }, { - "id": 121, + "id": 129, "name": "onConflict", "kind": 1024, "kindString": "Property", @@ -51613,7 +55450,7 @@ { "title": "Properties", "kind": 1024, - "children": [123, 124, 122, 121] + "children": [131, 132, 130, 129] } ] } @@ -51622,11 +55459,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -51637,7 +55474,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -51647,12 +55484,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -51666,17 +55503,17 @@ { "title": "Constructors", "kind": 512, - "children": [57] + "children": [65] }, { "title": "Properties", "kind": 1024, - "children": [79, 76, 77, 78, 75] + "children": [87, 84, 85, 86, 83] }, { "title": "Methods", "kind": 2048, - "children": [132, 93, 84, 125, 107] + "children": [140, 101, 92, 133, 115] } ], "sources": [ @@ -51688,7 +55525,7 @@ ], "typeParameter": [ { - "id": 137, + "id": 145, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -51699,7 +55536,7 @@ } }, { - "id": 138, + "id": 146, "name": "Relation", "kind": 131072, "kindString": "Type parameter", @@ -51719,7 +55556,7 @@ } }, { - "id": 139, + "id": 147, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -51730,7 +55567,7 @@ } }, { - "id": 142, + "id": 150, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -51739,20 +55576,20 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { - "id": 140, + "id": 148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 141, + "id": 149, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -51774,7 +55611,7 @@ { "title": "Properties", "kind": 1024, - "children": [141] + "children": [149] } ], "sources": [ @@ -51799,28 +55636,28 @@ ] }, { - "id": 489, + "id": 491, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 490, + "id": 492, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 491, + "id": 493, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 492, + "id": 494, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -51831,7 +55668,7 @@ } }, { - "id": 493, + "id": 495, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -51854,14 +55691,14 @@ } }, { - "id": 494, + "id": 496, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 495, + "id": 497, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -51872,7 +55709,7 @@ } }, { - "id": 496, + "id": 498, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -51885,24 +55722,28 @@ ], "parameters": [ { - "id": 497, + "id": 499, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 496, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default", "dereferenced": { - "id": 609, + "id": 615, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -51911,7 +55752,7 @@ }, "children": [ { - "id": 610, + "id": 616, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -51919,56 +55760,80 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 23, "character": 2 } ], "signatures": [ { - "id": 611, + "id": 617, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 612, + "id": 618, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 619, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "parameters": [ { - "id": 613, + "id": 620, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default", - "dereferenced": "[Circular ~.children.4.children.0.signatures.0.parameters.0.type.dereferenced]" + "dereferenced": "[Circular ~.children.5.children.0.signatures.0.parameters.0.type.dereferenced]" } } ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" } ], "name": "default" @@ -51977,7 +55842,7 @@ ] }, { - "id": 618, + "id": 625, "name": "body", "kind": 1024, "kindString": "Property", @@ -51988,7 +55853,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -51998,7 +55863,7 @@ } }, { - "id": 621, + "id": 628, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -52008,28 +55873,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 622, + "id": 629, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 623, + "id": 630, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 624, + "id": 631, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -52053,7 +55918,7 @@ } }, { - "id": 625, + "id": 632, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -52088,7 +55953,7 @@ } }, { - "id": 616, + "id": 623, "name": "headers", "kind": 1024, "kindString": "Property", @@ -52098,7 +55963,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -52120,7 +55985,7 @@ } }, { - "id": 626, + "id": 633, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -52130,7 +55995,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -52140,7 +56005,7 @@ } }, { - "id": 614, + "id": 621, "name": "method", "kind": 1024, "kindString": "Property", @@ -52150,7 +56015,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -52181,7 +56046,7 @@ } }, { - "id": 617, + "id": 624, "name": "schema", "kind": 1024, "kindString": "Property", @@ -52189,48 +56054,6 @@ "isProtected": true, "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 619, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 620, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", @@ -52238,6 +56061,48 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 626, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 627, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -52246,7 +56111,7 @@ } }, { - "id": 615, + "id": 622, "name": "url", "kind": 1024, "kindString": "Property", @@ -52256,7 +56121,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -52268,7 +56133,74 @@ } }, { - "id": 629, + "id": 636, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 637, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 638, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 639, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 640, "name": "then", "kind": 2048, "kindString": "Method", @@ -52276,39 +56208,63 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 630, + "id": 641, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 631, + "id": 642, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } }, { - "id": 632, + "id": 643, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -52321,7 +56277,7 @@ ], "parameters": [ { - "id": 633, + "id": 644, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -52338,36 +56294,60 @@ { "type": "reflection", "declaration": { - "id": 634, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 635, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 636, + "id": 647, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } } ], @@ -52376,7 +56356,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -52384,7 +56364,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -52402,7 +56382,7 @@ } }, { - "id": 637, + "id": 648, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -52419,21 +56399,21 @@ { "type": "reflection", "declaration": { - "id": 638, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 639, + "id": 650, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 640, + "id": 651, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -52449,7 +56429,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -52457,7 +56437,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -52483,12 +56463,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -52510,7 +56490,7 @@ } }, { - "id": 627, + "id": 634, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -52518,13 +56498,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 628, + "id": 635, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -52534,16 +56514,42 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 609, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 612, - "name": "Result" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + }, + { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] } } ] @@ -52553,17 +56559,17 @@ { "title": "Constructors", "kind": 512, - "children": [610] + "children": [616] }, { "title": "Properties", "kind": 1024, - "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] + "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] }, { "title": "Methods", "kind": 2048, - "children": [629, 627] + "children": [636, 640, 634] } ], "sources": [ @@ -52575,17 +56581,32 @@ ], "typeParameter": [ { - "id": 641, + "id": 652, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 653, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "extendedBy": [ { "type": "reference", - "id": 489, + "id": 491, "name": "PostgrestTransformBuilder" } ], @@ -52594,16 +56615,40 @@ "type": "reference", "typeArguments": [ { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } ], "qualifiedName": "PromiseLike", @@ -52617,31 +56662,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -52649,19 +56694,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 611, + "id": 617, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 610, + "id": 616, "name": "default.constructor" } }, { - "id": 581, + "id": 583, "name": "body", "kind": 1024, "kindString": "Property", @@ -52672,7 +56717,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -52682,12 +56727,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 618, + "id": 625, "name": "default.body" } }, { - "id": 584, + "id": 586, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -52697,28 +56742,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 585, + "id": 587, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 586, + "id": 588, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 587, + "id": 589, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -52742,7 +56787,7 @@ } }, { - "id": 588, + "id": 590, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -52777,12 +56822,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 621, + "id": 628, "name": "default.fetch" } }, { - "id": 579, + "id": 581, "name": "headers", "kind": 1024, "kindString": "Property", @@ -52792,7 +56837,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -52814,12 +56859,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 616, + "id": 623, "name": "default.headers" } }, { - "id": 589, + "id": 591, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -52829,7 +56874,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -52839,12 +56884,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 626, + "id": 633, "name": "default.isMaybeSingle" } }, { - "id": 577, + "id": 579, "name": "method", "kind": 1024, "kindString": "Property", @@ -52854,7 +56899,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -52885,65 +56930,13 @@ }, "inheritedFrom": { "type": "reference", - "id": 614, + "id": 621, "name": "default.method" } }, - { - "id": 580, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 617, - "name": "default.schema" - } - }, { "id": 582, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 619, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 583, - "name": "signal", + "name": "schema", "kind": 1024, "kindString": "Property", "flags": { @@ -52957,6 +56950,58 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 624, + "name": "default.schema" + } + }, + { + "id": 584, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false", + "inheritedFrom": { + "type": "reference", + "id": 626, + "name": "default.shouldThrowOnError" + } + }, + { + "id": 585, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -52965,12 +57010,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 620, + "id": 627, "name": "default.signal" } }, { - "id": 578, + "id": 580, "name": "url", "kind": 1024, "kindString": "Property", @@ -52980,7 +57025,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -52992,12 +57037,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 615, + "id": 622, "name": "default.url" } }, { - "id": 549, + "id": 551, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -53011,7 +57056,7 @@ ], "signatures": [ { - "id": 550, + "id": 552, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", @@ -53021,7 +57066,7 @@ }, "parameters": [ { - "id": 551, + "id": 553, "name": "signal", "kind": 32768, "kindString": "Parameter", @@ -53039,31 +57084,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -53073,7 +57118,7 @@ ] }, { - "id": 558, + "id": 560, "name": "csv", "kind": 2048, "kindString": "Method", @@ -53087,7 +57132,7 @@ ], "signatures": [ { - "id": 559, + "id": 561, "name": "csv", "kind": 4096, "kindString": "Call signature", @@ -53097,11 +57142,15 @@ }, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "intrinsic", "name": "string" + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -53110,7 +57159,7 @@ ] }, { - "id": 562, + "id": 564, "name": "explain", "kind": 2048, "kindString": "Method", @@ -53124,7 +57173,7 @@ ], "signatures": [ { - "id": 563, + "id": 565, "name": "explain", "kind": 4096, "kindString": "Call signature", @@ -53135,7 +57184,7 @@ }, "parameters": [ { - "id": 564, + "id": 566, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -53147,14 +57196,14 @@ "type": { "type": "reflection", "declaration": { - "id": 565, + "id": 567, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 566, + "id": 568, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -53177,7 +57226,7 @@ } }, { - "id": 569, + "id": 571, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -53200,7 +57249,7 @@ } }, { - "id": 571, + "id": 573, "name": "format", "kind": 1024, "kindString": "Property", @@ -53232,7 +57281,7 @@ } }, { - "id": 568, + "id": 570, "name": "settings", "kind": 1024, "kindString": "Property", @@ -53255,7 +57304,7 @@ } }, { - "id": 567, + "id": 569, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -53278,7 +57327,7 @@ } }, { - "id": 570, + "id": 572, "name": "wal", "kind": 1024, "kindString": "Property", @@ -53305,7 +57354,7 @@ { "title": "Properties", "kind": 1024, - "children": [566, 569, 571, 568, 567, 570] + "children": [568, 571, 573, 570, 569, 572] } ] } @@ -53318,18 +57367,22 @@ "types": [ { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "intrinsic", "name": "string" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "array", @@ -53349,6 +57402,10 @@ "package": "typescript", "name": "Record" } + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -53359,7 +57416,7 @@ ] }, { - "id": 560, + "id": 562, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -53373,7 +57430,7 @@ ], "signatures": [ { - "id": 561, + "id": 563, "name": "geojson", "kind": 4096, "kindString": "Call signature", @@ -53383,7 +57440,7 @@ }, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", @@ -53400,6 +57457,10 @@ "qualifiedName": "Record", "package": "typescript", "name": "Record" + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -53408,7 +57469,7 @@ ] }, { - "id": 534, + "id": 536, "name": "limit", "kind": 2048, "kindString": "Method", @@ -53422,7 +57483,7 @@ ], "signatures": [ { - "id": 535, + "id": 537, "name": "limit", "kind": 4096, "kindString": "Call signature", @@ -53432,7 +57493,7 @@ }, "parameters": [ { - "id": 536, + "id": 538, "name": "count", "kind": 32768, "kindString": "Parameter", @@ -53446,7 +57507,7 @@ } }, { - "id": 537, + "id": 539, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -53458,14 +57519,14 @@ "type": { "type": "reflection", "declaration": { - "id": 538, + "id": 540, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 539, + "id": 541, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -53488,7 +57549,7 @@ } }, { - "id": 540, + "id": 542, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -53515,7 +57576,7 @@ { "title": "Properties", "kind": 1024, - "children": [539, 540] + "children": [541, 542] } ] } @@ -53525,31 +57586,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -53559,7 +57620,7 @@ ] }, { - "id": 555, + "id": 557, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -53573,7 +57634,7 @@ ], "signatures": [ { - "id": 556, + "id": 558, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", @@ -53584,7 +57645,7 @@ }, "typeParameter": [ { - "id": 557, + "id": 559, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -53593,7 +57654,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, "extendsType": { @@ -53616,7 +57677,7 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "union", @@ -53627,10 +57688,14 @@ }, { "type": "reference", - "id": 437, + "id": 435, "name": "ResultOne" } ] + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -53639,7 +57704,7 @@ ] }, { - "id": 503, + "id": 505, "name": "order", "kind": 2048, "kindString": "Method", @@ -53653,7 +57718,7 @@ ], "signatures": [ { - "id": 504, + "id": 506, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -53663,37 +57728,37 @@ "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "typeParameter": [ - { - "id": 505, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 506, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 385, - "name": "ColumnName", - "dereferenced": {} - } - }, { "id": 507, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 508, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 383, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 509, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -53706,14 +57771,14 @@ "type": { "type": "reflection", "declaration": { - "id": 508, + "id": 510, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 509, + "id": 511, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -53736,7 +57801,7 @@ } }, { - "id": 510, + "id": 512, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -53759,7 +57824,7 @@ } }, { - "id": 511, + "id": 513, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -53786,7 +57851,7 @@ { "title": "Properties", "kind": 1024, - "children": [509, 510, 511] + "children": [511, 512, 513] } ] } @@ -53795,31 +57860,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -53827,7 +57892,7 @@ } }, { - "id": 512, + "id": 514, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -53838,7 +57903,7 @@ }, "parameters": [ { - "id": 513, + "id": 515, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -53852,7 +57917,7 @@ } }, { - "id": 514, + "id": 516, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -53865,14 +57930,14 @@ "type": { "type": "reflection", "declaration": { - "id": 515, + "id": 517, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 516, + "id": 518, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -53895,7 +57960,7 @@ } }, { - "id": 517, + "id": 519, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -53918,7 +57983,7 @@ } }, { - "id": 518, + "id": 520, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -53945,7 +58010,7 @@ { "title": "Properties", "kind": 1024, - "children": [516, 517, 518] + "children": [518, 519, 520] } ] } @@ -53954,31 +58019,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -53986,7 +58051,7 @@ } }, { - "id": 519, + "id": 521, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -54003,7 +58068,7 @@ }, "typeParameter": [ { - "id": 520, + "id": 522, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -54016,7 +58081,7 @@ ], "parameters": [ { - "id": 521, + "id": 523, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -54026,13 +58091,13 @@ }, "type": { "type": "reference", - "id": 400, + "id": 398, "name": "ColumnName", "dereferenced": {} } }, { - "id": 522, + "id": 524, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -54045,14 +58110,14 @@ "type": { "type": "reflection", "declaration": { - "id": 523, + "id": 525, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 524, + "id": 526, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -54072,7 +58137,7 @@ } }, { - "id": 526, + "id": 528, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -54092,7 +58157,7 @@ } }, { - "id": 525, + "id": 527, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -54116,7 +58181,7 @@ { "title": "Properties", "kind": 1024, - "children": [524, 526, 525] + "children": [526, 528, 527] } ] } @@ -54125,31 +58190,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -54157,7 +58222,7 @@ } }, { - "id": 527, + "id": 529, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -54174,7 +58239,7 @@ }, "parameters": [ { - "id": 528, + "id": 530, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -54188,7 +58253,7 @@ } }, { - "id": 529, + "id": 531, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -54201,14 +58266,14 @@ "type": { "type": "reflection", "declaration": { - "id": 530, + "id": 532, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 531, + "id": 533, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -54228,7 +58293,7 @@ } }, { - "id": 533, + "id": 535, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -54248,7 +58313,7 @@ } }, { - "id": 532, + "id": 534, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -54272,7 +58337,7 @@ { "title": "Properties", "kind": 1024, - "children": [531, 533, 532] + "children": [533, 535, 534] } ] } @@ -54281,31 +58346,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -54315,7 +58380,7 @@ ] }, { - "id": 541, + "id": 543, "name": "range", "kind": 2048, "kindString": "Method", @@ -54329,17 +58394,17 @@ ], "signatures": [ { - "id": 542, + "id": 544, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by starting at an offset (`from`) and ending at the offset (`from + 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." + "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." }, "parameters": [ { - "id": 543, + "id": 545, "name": "from", "kind": 32768, "kindString": "Parameter", @@ -54353,7 +58418,7 @@ } }, { - "id": 544, + "id": 546, "name": "to", "kind": 32768, "kindString": "Parameter", @@ -54367,7 +58432,7 @@ } }, { - "id": 545, + "id": 547, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -54379,14 +58444,14 @@ "type": { "type": "reflection", "declaration": { - "id": 546, + "id": 548, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 547, + "id": 549, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -54409,7 +58474,7 @@ } }, { - "id": 548, + "id": 550, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -54436,7 +58501,7 @@ { "title": "Properties", "kind": 1024, - "children": [547, 548] + "children": [549, 550] } ] } @@ -54446,31 +58511,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -54480,7 +58545,7 @@ ] }, { - "id": 574, + "id": 576, "name": "returns", "kind": 2048, "kindString": "Method", @@ -54494,7 +58559,7 @@ ], "signatures": [ { - "id": 575, + "id": 577, "name": "returns", "kind": 4096, "kindString": "Call signature", @@ -54504,7 +58569,7 @@ }, "typeParameter": [ { - "id": 576, + "id": 578, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", @@ -54516,31 +58581,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 456, + "id": 454, "name": "NewResult" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -54550,7 +58615,7 @@ ] }, { - "id": 572, + "id": 574, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -54564,7 +58629,7 @@ ], "signatures": [ { - "id": 573, + "id": 575, "name": "rollback", "kind": 4096, "kindString": "Call signature", @@ -54575,31 +58640,31 @@ }, "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -54609,7 +58674,7 @@ ] }, { - "id": 498, + "id": 500, "name": "select", "kind": 2048, "kindString": "Method", @@ -54623,7 +58688,7 @@ ], "signatures": [ { - "id": 499, + "id": 501, "name": "select", "kind": 4096, "kindString": "Call signature", @@ -54634,7 +58699,7 @@ }, "typeParameter": [ { - "id": 500, + "id": 502, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -54649,37 +58714,38 @@ } }, { - "id": 501, + "id": 503, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", + "id": 685, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" }, { "type": "reference", - "id": 380, + "id": 378, "name": "Query" } ], @@ -54689,7 +58755,7 @@ ], "parameters": [ { - "id": 502, + "id": 504, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -54701,7 +58767,7 @@ }, "type": { "type": "reference", - "id": 380, + "id": 378, "name": "Query", "dereferenced": {} } @@ -54709,34 +58775,34 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 381, + "id": 379, "name": "NewResultOne" } }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -54746,7 +58812,99 @@ ] }, { - "id": 552, + "id": 594, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 595, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 596, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 597, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 491, + "typeArguments": [ + { + "type": "reference", + "id": 494, + "name": "Schema" + }, + { + "type": "reference", + "id": 495, + "name": "Row" + }, + { + "type": "reference", + "id": 496, + "name": "Result" + }, + { + "type": "reference", + "id": 497, + "name": "RelationName" + }, + { + "type": "reference", + "id": 498, + "name": "Relationships" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 637, + "name": "default.setHeader" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 636, + "name": "default.setHeader" + } + }, + { + "id": 554, "name": "single", "kind": 2048, "kindString": "Method", @@ -54760,7 +58918,7 @@ ], "signatures": [ { - "id": 553, + "id": 555, "name": "single", "kind": 4096, "kindString": "Call signature", @@ -54771,7 +58929,7 @@ }, "typeParameter": [ { - "id": 554, + "id": 556, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -54780,7 +58938,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, "extendsType": { @@ -54803,12 +58961,16 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 434, + "id": 432, "name": "ResultOne" + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -54817,7 +58979,7 @@ ] }, { - "id": 592, + "id": 598, "name": "then", "kind": 2048, "kindString": "Method", @@ -54825,31 +58987,31 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 593, + "id": 599, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 594, + "id": 600, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 496, "name": "Result" } ], @@ -54857,7 +59019,7 @@ } }, { - "id": 595, + "id": 601, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -54870,7 +59032,7 @@ ], "parameters": [ { - "id": 596, + "id": 602, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -54887,32 +59049,32 @@ { "type": "reflection", "declaration": { - "id": 597, + "id": 603, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 598, + "id": 604, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 599, + "id": 605, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 496, "name": "Result" } ], @@ -54925,7 +59087,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -54933,7 +59095,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -54951,7 +59113,7 @@ } }, { - "id": 600, + "id": 606, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -54968,21 +59130,21 @@ { "type": "reflection", "declaration": { - "id": 601, + "id": 607, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 602, + "id": 608, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 603, + "id": 609, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -54998,7 +59160,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -55006,7 +59168,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -55032,12 +59194,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -55049,19 +59211,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 630, + "id": 641, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 629, + "id": 640, "name": "default.then" } }, { - "id": 590, + "id": 592, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -55069,13 +59231,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 591, + "id": 593, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -55085,47 +59247,68 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 489, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 492, - "name": "Schema" + "id": 491, + "typeArguments": [ + { + "type": "reference", + "id": 494, + "name": "Schema" + }, + { + "type": "reference", + "id": 495, + "name": "Row" + }, + { + "type": "reference", + "id": 496, + "name": "Result" + }, + { + "type": "reference", + "id": 497, + "name": "RelationName" + }, + { + "type": "reference", + "id": 498, + "name": "Relationships" + } + ], + "name": "default" }, { "type": "reference", - "id": 493, - "name": "Row" - }, - { - "type": "reference", - "id": 494, - "name": "Result" - }, - { - "type": "reference", - "id": 495, - "name": "RelationName" - }, - { - "type": "reference", - "id": 496, - "name": "Relationships" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 496, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] }, "inheritedFrom": { "type": "reference", - "id": 628, + "id": 635, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 627, + "id": 634, "name": "default.throwOnError" } } @@ -55134,17 +59317,19 @@ { "title": "Constructors", "kind": 512, - "children": [490] + "children": [492] }, { "title": "Properties", "kind": 1024, - "children": [581, 584, 579, 589, 577, 580, 582, 583, 578] + "children": [583, 586, 581, 591, 579, 582, 584, 585, 580] }, { "title": "Methods", "kind": 2048, - "children": [549, 558, 562, 560, 534, 555, 503, 541, 574, 572, 498, 552, 592, 590] + "children": [ + 551, 560, 564, 562, 536, 557, 505, 543, 576, 574, 500, 594, 554, 598, 592 + ] } ], "sources": [ @@ -55156,7 +59341,7 @@ ], "typeParameter": [ { - "id": 604, + "id": 610, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -55167,7 +59352,7 @@ } }, { - "id": 605, + "id": 611, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -55190,14 +59375,14 @@ } }, { - "id": 606, + "id": 612, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 607, + "id": 613, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -55208,7 +59393,7 @@ } }, { - "id": 608, + "id": 614, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -55222,11 +59407,11 @@ "extendedTypes": [ { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 496, "name": "Result" } ], @@ -55236,20 +59421,20 @@ "extendedBy": [ { "type": "reference", - "id": 143, + "id": 151, "name": "PostgrestFilterBuilder" } ] }, { - "id": 644, + "id": 668, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 647, + "id": 671, "name": "count", "kind": 1024, "kindString": "Property", @@ -55257,7 +59442,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 32, + "line": 22, "character": 2 } ], @@ -55267,7 +59452,7 @@ } }, { - "id": 646, + "id": 670, "name": "data", "kind": 1024, "kindString": "Property", @@ -55275,7 +59460,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 31, + "line": 21, "character": 2 } ], @@ -55285,7 +59470,7 @@ } }, { - "id": 645, + "id": 669, "name": "error", "kind": 1024, "kindString": "Property", @@ -55293,134 +59478,248 @@ "sources": [ { "fileName": "src/types.ts", - "line": 30, + "line": 20, "character": 2 } ], "type": { "type": "reference", - "id": 661, - "name": "PostgrestError", + "id": 654, + "name": "default", "dereferenced": { - "id": 661, + "id": 654, "name": "PostgrestError", - "kind": 4194304, - "kindString": "Type alias", + "kind": 128, + "kindString": "Class", "flags": {}, "comment": { "shortText": "Error format", "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" }, - "sources": [ + "children": [ { - "fileName": "src/types.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 662, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 655, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, - "children": [ - { - "id": 666, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 10, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 663, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 9, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [666, 664, 665, 663] - } - ], "sources": [ { - "fileName": "src/types.ts", - "line": 8, - "character": 29 + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 2 } - ] + ], + "signatures": [ + { + "id": 656, + "name": "new PostgrestError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 657, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 658, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 662, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 73 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 660, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 661, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 659, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 25 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [662, 660, 661, 659] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 654, + "name": "default" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + }, + { + "id": 665, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 9, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 663, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 7, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 664, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 8, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } - } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [655] + }, + { + "title": "Properties", + "kind": 1024, + "children": [665, 663, 664] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 6, + "character": 21 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ] } } }, { - "id": 648, + "id": 672, "name": "status", "kind": 1024, "kindString": "Property", @@ -55428,7 +59727,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 21, + "line": 11, "character": 2 } ], @@ -55442,7 +59741,7 @@ } }, { - "id": 649, + "id": 673, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -55450,7 +59749,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 22, + "line": 12, "character": 2 } ], @@ -55468,13 +59767,13 @@ { "title": "Properties", "kind": 1024, - "children": [647, 646, 645, 648, 649] + "children": [671, 670, 669, 672, 673] } ], "sources": [ { "fileName": "src/types.ts", - "line": 29, + "line": 19, "character": 17 } ], @@ -55486,14 +59785,14 @@ ] }, { - "id": 650, + "id": 674, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 653, + "id": 677, "name": "count", "kind": 1024, "kindString": "Property", @@ -55501,7 +59800,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 27, + "line": 17, "character": 2 } ], @@ -55520,7 +59819,7 @@ } }, { - "id": 652, + "id": 676, "name": "data", "kind": 1024, "kindString": "Property", @@ -55528,19 +59827,19 @@ "sources": [ { "fileName": "src/types.ts", - "line": 26, + "line": 16, "character": 2 } ], "type": { "type": "reference", - "id": 656, + "id": 680, "name": "T", "dereferenced": {} } }, { - "id": 651, + "id": 675, "name": "error", "kind": 1024, "kindString": "Property", @@ -55548,7 +59847,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 25, + "line": 15, "character": 2 } ], @@ -55558,7 +59857,7 @@ } }, { - "id": 654, + "id": 678, "name": "status", "kind": 1024, "kindString": "Property", @@ -55566,7 +59865,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 21, + "line": 11, "character": 2 } ], @@ -55580,7 +59879,7 @@ } }, { - "id": 655, + "id": 679, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -55588,7 +59887,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 22, + "line": 12, "character": 2 } ], @@ -55606,19 +59905,19 @@ { "title": "Properties", "kind": 1024, - "children": [653, 652, 651, 654, 655] + "children": [677, 676, 675, 678, 679] } ], "sources": [ { "fileName": "src/types.ts", - "line": 24, + "line": 14, "character": 17 } ], "typeParameter": [ { - "id": 656, + "id": 680, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -55633,123 +59932,7 @@ ] }, { - "id": 661, - "name": "PostgrestError", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "Error format", - "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" - }, - "sources": [ - { - "fileName": "src/types.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 662, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 666, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 10, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 663, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 9, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [666, 664, 665, 663] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 8, - "character": 29 - } - ] - } - } - }, - { - "id": 659, + "id": 683, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -55757,13 +59940,13 @@ "sources": [ { "fileName": "src/types.ts", - "line": 39, + "line": 29, "character": 12 } ], "typeParameter": [ { - "id": 660, + "id": 684, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -55772,14 +59955,14 @@ ], "type": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", - "id": 660, + "id": 684, "name": "T" }, { @@ -55793,7 +59976,7 @@ } }, { - "id": 642, + "id": 666, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", @@ -55801,13 +59984,13 @@ "sources": [ { "fileName": "src/types.ts", - "line": 40, + "line": 30, "character": 12 } ], "typeParameter": [ { - "id": 643, + "id": 667, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -55816,13 +59999,13 @@ ], "type": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", - "id": 643, + "id": 667, "name": "T" } } @@ -55831,7 +60014,7 @@ } }, { - "id": 657, + "id": 681, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -55839,13 +60022,13 @@ "sources": [ { "fileName": "src/types.ts", - "line": 38, + "line": 28, "character": 12 } ], "typeParameter": [ { - "id": 658, + "id": 682, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -55856,14 +60039,14 @@ "type": "union", "types": [ { - "id": 650, + "id": 674, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 653, + "id": 677, "name": "count", "kind": 1024, "kindString": "Property", @@ -55871,7 +60054,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 27, + "line": 17, "character": 2 } ], @@ -55890,7 +60073,7 @@ } }, { - "id": 652, + "id": 676, "name": "data", "kind": 1024, "kindString": "Property", @@ -55898,19 +60081,19 @@ "sources": [ { "fileName": "src/types.ts", - "line": 26, + "line": 16, "character": 2 } ], "type": { "type": "reference", - "id": 656, + "id": 680, "name": "T", "dereferenced": {} } }, { - "id": 651, + "id": 675, "name": "error", "kind": 1024, "kindString": "Property", @@ -55918,7 +60101,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 25, + "line": 15, "character": 2 } ], @@ -55928,7 +60111,7 @@ } }, { - "id": 654, + "id": 678, "name": "status", "kind": 1024, "kindString": "Property", @@ -55936,7 +60119,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 21, + "line": 11, "character": 2 } ], @@ -55950,7 +60133,7 @@ } }, { - "id": 655, + "id": 679, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -55958,7 +60141,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 22, + "line": 12, "character": 2 } ], @@ -55976,19 +60159,19 @@ { "title": "Properties", "kind": 1024, - "children": [653, 652, 651, 654, 655] + "children": [677, 676, 675, 678, 679] } ], "sources": [ { "fileName": "src/types.ts", - "line": 24, + "line": 14, "character": 17 } ], "typeParameter": [ { - "id": 656, + "id": 680, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -56003,14 +60186,14 @@ ] }, { - "id": 644, + "id": 668, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 647, + "id": 671, "name": "count", "kind": 1024, "kindString": "Property", @@ -56018,7 +60201,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 32, + "line": 22, "character": 2 } ], @@ -56028,7 +60211,7 @@ } }, { - "id": 646, + "id": 670, "name": "data", "kind": 1024, "kindString": "Property", @@ -56036,7 +60219,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 31, + "line": 21, "character": 2 } ], @@ -56046,7 +60229,7 @@ } }, { - "id": 645, + "id": 669, "name": "error", "kind": 1024, "kindString": "Property", @@ -56054,134 +60237,248 @@ "sources": [ { "fileName": "src/types.ts", - "line": 30, + "line": 20, "character": 2 } ], "type": { "type": "reference", - "id": 661, - "name": "PostgrestError", + "id": 654, + "name": "default", "dereferenced": { - "id": 661, + "id": 654, "name": "PostgrestError", - "kind": 4194304, - "kindString": "Type alias", + "kind": 128, + "kindString": "Class", "flags": {}, "comment": { "shortText": "Error format", "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" }, - "sources": [ + "children": [ { - "fileName": "src/types.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 662, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 655, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, - "children": [ - { - "id": 666, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 10, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 663, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 9, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [666, 664, 665, 663] - } - ], "sources": [ { - "fileName": "src/types.ts", - "line": 8, - "character": 29 + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 2 } - ] + ], + "signatures": [ + { + "id": 656, + "name": "new PostgrestError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 657, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 658, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 662, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 73 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 660, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 661, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 659, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 25 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [662, 660, 661, 659] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 654, + "name": "default" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + }, + { + "id": 665, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 9, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 663, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 7, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 664, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 8, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } - } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [655] + }, + { + "title": "Properties", + "kind": 1024, + "children": [665, 663, 664] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 6, + "character": 21 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ] } } }, { - "id": 648, + "id": 672, "name": "status", "kind": 1024, "kindString": "Property", @@ -56189,7 +60486,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 21, + "line": 11, "character": 2 } ], @@ -56203,7 +60500,7 @@ } }, { - "id": 649, + "id": 673, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -56211,7 +60508,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 22, + "line": 12, "character": 2 } ], @@ -56229,13 +60526,13 @@ { "title": "Properties", "kind": 1024, - "children": [647, 646, 645, 648, 649] + "children": [671, 670, 669, 672, 673] } ], "sources": [ { "fileName": "src/types.ts", - "line": 29, + "line": 19, "character": 17 } ], @@ -56248,29 +60545,540 @@ } ] } + }, + { + "id": 685, + "name": "UnstableGetResult", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "Main entry point for constructing the result type of a PostgREST query." + }, + "sources": [ + { + "fileName": "src/select-query-parser/result.ts", + "line": 33, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 686, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Database schema." + }, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 687, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The type of a row in the current table." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 688, + "name": "RelationName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The name of the current table or view." + } + }, + { + "id": 689, + "name": "Relationships", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Relationships of the current table." + } + }, + { + "id": 690, + "name": "Query", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The select query string literal to parse.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 686, + "name": "Schema" + } + ], + "name": "IsAny" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 690, + "name": "Query" + } + ], + "name": "ParseQuery" + }, + "extendsType": { + "type": "inferred", + "name": "ParsedQuery" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "ParsedQuery" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Ast.Node" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ParsedQuery" + } + ], + "name": "ProcessNodesWithoutSchema" + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "reference", + "name": "ParsedQuery" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 689, + "name": "Relationships" + }, + "extendsType": { + "type": "literal", + "value": null + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 690, + "name": "Query" + } + ], + "name": "ParseQuery" + }, + "extendsType": { + "type": "inferred", + "name": "ParsedQuery" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "ParsedQuery" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Ast.Node" + } + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ParsedQuery" + }, + { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + "falseType": { + "type": "literal", + "value": "rpc_call" + } + }, + { + "type": "reference", + "id": 687, + "name": "Row" + } + ], + "name": "RPCCallNodes" + }, + "falseType": { + "type": "reference", + "name": "ParsedQuery" + } + }, + "falseType": { + "type": "reference", + "id": 687, + "name": "Row" + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 690, + "name": "Query" + } + ], + "name": "ParseQuery" + }, + "extendsType": { + "type": "inferred", + "name": "ParsedQuery" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "ParsedQuery" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Ast.Node" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 689, + "name": "Relationships" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "GenericRelationship" + } + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 686, + "name": "Schema" + }, + { + "type": "reference", + "id": 687, + "name": "Row" + }, + { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + { + "type": "reference", + "id": 689, + "name": "Relationships" + }, + { + "type": "reference", + "name": "ParsedQuery" + } + ], + "name": "ProcessNodes" + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "Invalid Relationships cannot infer result type" + } + ], + "name": "SelectQueryError" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "Invalid RelationName cannot infer result type" + } + ], + "name": "SelectQueryError" + } + }, + "falseType": { + "type": "reference", + "name": "ParsedQuery" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + } + }, + { + "id": 1, + "name": "default", + "kind": 32, + "kindString": "Variable", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 17, + "character": 0 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 2, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 7, + "name": "PostgrestBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 615, + "name": "default" + } + } + }, + { + "id": 3, + "name": "PostgrestClient", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 9, + "name": "default" + } + } + }, + { + "id": 8, + "name": "PostgrestError", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 654, + "name": "default" + } + } + }, + { + "id": 5, + "name": "PostgrestFilterBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 151, + "name": "default" + } + } + }, + { + "id": 4, + "name": "PostgrestQueryBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 64, + "name": "default" + } + } + }, + { + "id": 6, + "name": "PostgrestTransformBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 491, + "name": "default" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [7, 3, 8, 5, 4, 6] + } + ] + } + } } ], "groups": [ { "title": "Classes", "kind": 128, - "children": [609, 1, 143, 56, 489] + "children": [615, 9, 654, 151, 64, 491] }, { "title": "Interfaces", "kind": 256, - "children": [644, 650] + "children": [668, 674] }, { "title": "Type Aliases", "kind": 4194304, - "children": [661, 659, 642, 657] + "children": [683, 666, 681, 685] + }, + { + "title": "Variables", + "kind": 32, + "children": [1] } ], "sources": [ { "fileName": "src/index.ts", - "line": 1, + "line": 2, "character": 0 } ] @@ -56284,14 +61092,14 @@ "originalName": "", "children": [ { - "id": 588, + "id": 614, "name": "REALTIME_LISTEN_TYPES", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 589, + "id": 615, "name": "BROADCAST", "kind": 16, "kindString": "Enumeration Member", @@ -56299,7 +61107,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 93, + "line": 98, "character": 2 } ], @@ -56310,18 +61118,15 @@ "defaultValue": "\"broadcast\"" }, { - "id": 591, + "id": 617, "name": "POSTGRES_CHANGES", "kind": 16, "kindString": "Enumeration Member", "flags": {}, - "comment": { - "shortText": "listen to Postgres changes." - }, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 98, + "line": 100, "character": 2 } ], @@ -56332,11 +61137,91 @@ "defaultValue": "\"postgres_changes\"" }, { - "id": 590, + "id": 616, "name": "PRESENCE", "kind": 16, "kindString": "Enumeration Member", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 99, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "presence" + }, + "defaultValue": "\"presence\"" + }, + { + "id": 618, + "name": "SYSTEM", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 101, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "system" + }, + "defaultValue": "\"system\"" + } + ], + "groups": [ + { + "title": "Enumeration Members", + "kind": 16, + "children": [615, 617, 616, 618] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 97, + "character": 12 + } + ] + }, + { + "id": 619, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 620, + "name": "ALL", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 91, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "*" + }, + "defaultValue": "\"*\"" + }, + { + "id": 623, + "name": "DELETE", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -56344,67 +61229,6 @@ "character": 2 } ], - "type": { - "type": "literal", - "value": "presence" - }, - "defaultValue": "\"presence\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [589, 591, 590] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 92, - "character": 12 - } - ] - }, - { - "id": 592, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 593, - "name": "ALL", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "*" - }, - "defaultValue": "\"*\"" - }, - { - "id": 596, - "name": "DELETE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 89, - "character": 2 - } - ], "type": { "type": "literal", "value": "DELETE" @@ -56412,7 +61236,7 @@ "defaultValue": "\"DELETE\"" }, { - "id": 594, + "id": 621, "name": "INSERT", "kind": 16, "kindString": "Enumeration Member", @@ -56420,7 +61244,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 87, + "line": 92, "character": 2 } ], @@ -56431,7 +61255,7 @@ "defaultValue": "\"INSERT\"" }, { - "id": 595, + "id": 622, "name": "UPDATE", "kind": 16, "kindString": "Enumeration Member", @@ -56439,7 +61263,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 88, + "line": 93, "character": 2 } ], @@ -56454,26 +61278,26 @@ { "title": "Enumeration Members", "kind": 16, - "children": [593, 596, 594, 595] + "children": [620, 623, 621, 622] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 85, + "line": 90, "character": 12 } ] }, { - "id": 597, + "id": 624, "name": "REALTIME_PRESENCE_LISTEN_EVENTS", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 599, + "id": 626, "name": "JOIN", "kind": 16, "kindString": "Enumeration Member", @@ -56492,7 +61316,7 @@ "defaultValue": "\"join\"" }, { - "id": 600, + "id": 627, "name": "LEAVE", "kind": 16, "kindString": "Enumeration Member", @@ -56511,7 +61335,7 @@ "defaultValue": "\"leave\"" }, { - "id": 598, + "id": 625, "name": "SYNC", "kind": 16, "kindString": "Enumeration Member", @@ -56534,7 +61358,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [599, 600, 598] + "children": [626, 627, 625] } ], "sources": [ @@ -56546,18 +61370,56 @@ ] }, { - "id": 601, + "id": 628, "name": "REALTIME_SUBSCRIBE_STATES", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 605, + "id": 632, "name": "CHANNEL_ERROR", "kind": 16, "kindString": "Enumeration Member", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 108, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "CHANNEL_ERROR" + }, + "defaultValue": "\"CHANNEL_ERROR\"" + }, + { + "id": 631, + "name": "CLOSED", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 107, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "CLOSED" + }, + "defaultValue": "\"CLOSED\"" + }, + { + "id": 629, + "name": "SUBSCRIBED", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -56565,44 +61427,6 @@ "character": 2 } ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - }, - "defaultValue": "\"CHANNEL_ERROR\"" - }, - { - "id": 604, - "name": "CLOSED", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 104, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - }, - "defaultValue": "\"CLOSED\"" - }, - { - "id": 602, - "name": "SUBSCRIBED", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 102, - "character": 2 - } - ], "type": { "type": "literal", "value": "SUBSCRIBED" @@ -56610,7 +61434,7 @@ "defaultValue": "\"SUBSCRIBED\"" }, { - "id": 603, + "id": 630, "name": "TIMED_OUT", "kind": 16, "kindString": "Enumeration Member", @@ -56618,7 +61442,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 103, + "line": 106, "character": 2 } ], @@ -56633,13 +61457,13 @@ { "title": "Enumeration Members", "kind": 16, - "children": [605, 604, 602, 603] + "children": [632, 631, 629, 630] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 101, + "line": 104, "character": 12 } ] @@ -56663,7 +61487,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 134, + "line": 147, "character": 2 } ], @@ -56694,10 +61518,10 @@ "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -56705,21 +61529,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -56727,21 +61551,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -56754,21 +61578,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -56778,7 +61602,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -56788,7 +61612,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -56798,7 +61622,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -56812,13 +61636,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -56826,7 +61650,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -56839,21 +61663,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -56863,7 +61687,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -56877,31 +61701,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -56913,13 +61760,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -56937,17 +61784,17 @@ "flags": {}, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -56955,13 +61802,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -56971,7 +61818,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -56985,7 +61832,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -56994,10 +61841,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -57005,21 +61852,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -57029,7 +61876,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -57041,7 +61888,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -57051,7 +61898,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -57063,7 +61910,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -57073,7 +61920,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -57083,7 +61930,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -57093,14 +61940,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -57108,19 +61955,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -57139,7 +61986,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -57149,7 +61996,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -57159,7 +62006,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -57169,7 +62016,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -57196,7 +62043,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -57206,7 +62053,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -57218,7 +62065,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -57228,14 +62075,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -57243,19 +62090,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -57274,7 +62121,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -57284,7 +62131,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -57296,7 +62143,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -57306,7 +62153,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -57316,7 +62163,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -57326,7 +62173,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -57334,6 +62181,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -57341,15 +62274,20 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, 496, 504, 499, - 494, 493 + 520, 519, 531, 522, 517, 530, 518, 526, 521, + 516, 515, 532, 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -57361,14 +62299,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -57376,7 +62314,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -57396,7 +62398,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -57404,7 +62406,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -57424,7 +62426,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -57432,7 +62434,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -57447,7 +62449,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -57455,7 +62457,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -57475,7 +62477,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -57483,7 +62485,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -57495,7 +62497,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -57503,7 +62505,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -57515,7 +62517,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -57523,7 +62525,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -57534,7 +62536,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -57542,28 +62544,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -57587,7 +62589,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -57618,14 +62620,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -57653,7 +62655,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -57688,7 +62690,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -57698,27 +62700,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -57738,7 +62740,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -57746,7 +62748,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -57757,7 +62759,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -57765,7 +62767,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -57787,7 +62789,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -57795,7 +62816,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -57808,7 +62829,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -57818,27 +62839,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -57858,7 +62879,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -57866,7 +62887,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -57886,7 +62907,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -57894,7 +62915,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -57906,7 +62927,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -57914,7 +62935,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -57924,7 +62945,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -57932,7 +62953,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -57943,7 +62964,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -57951,7 +62972,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -57967,7 +62988,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -57975,7 +62996,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -57986,7 +63007,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -57994,21 +63015,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -58016,7 +63037,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -58031,7 +63052,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -58039,7 +63060,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -58054,7 +63075,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -58062,7 +63083,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -58077,7 +63098,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -58085,7 +63106,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -58104,7 +63125,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -58112,7 +63133,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -58120,7 +63141,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -58131,7 +63152,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -58139,7 +63160,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -58158,7 +63179,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -58166,20 +63300,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -58190,17 +63324,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -58208,21 +63342,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -58230,21 +63364,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -58257,21 +63391,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -58281,7 +63415,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -58291,7 +63425,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -58301,7 +63435,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -58315,13 +63449,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -58329,7 +63463,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -58342,21 +63476,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -58366,7 +63500,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -58380,31 +63514,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -58416,13 +63573,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -58442,7 +63599,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -58450,13 +63607,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -58472,7 +63629,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -58480,13 +63637,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -58502,7 +63659,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -58510,13 +63667,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -58526,7 +63683,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -58542,7 +63699,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -58566,7 +63723,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -58574,13 +63792,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -58600,7 +63818,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -58608,13 +63826,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -58630,7 +63848,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -58638,13 +63856,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -58655,7 +63873,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -58666,7 +63884,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -58677,7 +63895,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -58698,7 +63916,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -58706,13 +63924,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -58723,17 +63941,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -58741,21 +63959,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -58763,7 +63981,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -58773,7 +63991,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -58783,7 +64001,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -58793,7 +64011,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -58801,7 +64019,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -58811,7 +64029,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -58819,7 +64037,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -58829,7 +64047,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -58837,7 +64055,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -58851,13 +64069,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -58875,7 +64093,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -58883,13 +64101,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -58904,7 +64122,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -58917,7 +64135,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -58925,13 +64143,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -58941,7 +64159,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -58973,22 +64191,20 @@ "title": "Properties", "kind": 1024, "children": [ - 80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, - 101 + 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, + 92, 102 ] }, { "title": "Methods", "kind": 2048, - "children": [ - 269, 135, 112, 245, 104, 119, 264, 129, 258 - ] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -59001,7 +64217,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -59013,7 +64229,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -59021,29 +64275,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -59057,12 +64312,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -59072,26 +64336,29 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, - 380, 386, 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, + 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, - "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] + "children": [ + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, + 457, 454 + ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -59116,7 +64383,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 116, + "line": 128, "character": 2 } ], @@ -59166,7 +64433,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 120, + "line": 132, "character": 6 } ], @@ -59186,7 +64453,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 6 } ], @@ -59201,7 +64468,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 14 } ], @@ -59242,7 +64509,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 121, + "line": 133, "character": 6 } ], @@ -59260,7 +64527,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 118, + "line": 130, "character": 6 } ], @@ -59280,7 +64547,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 117, + "line": 129, "character": 19 } ] @@ -59301,7 +64568,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 143, "character": 2 } ], @@ -59319,7 +64586,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 127, + "line": 139, "character": 2 } ], @@ -59337,7 +64604,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 126, + "line": 138, "character": 2 } ], @@ -59348,7 +64615,7 @@ "defaultValue": "false" }, { - "id": 102, + "id": 103, "name": "params", "kind": 1024, "kindString": "Property", @@ -59357,10 +64624,10 @@ }, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -59368,21 +64635,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -59390,21 +64657,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -59417,21 +64684,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -59441,7 +64708,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -59451,7 +64718,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -59461,7 +64728,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -59475,13 +64742,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -59489,7 +64756,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -59502,21 +64769,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -59526,7 +64793,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -59540,31 +64807,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -59576,13 +64866,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -59601,7 +64891,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 130, + "line": 142, "character": 2 } ], @@ -59673,19 +64963,19 @@ "title": "Properties", "kind": 1024, "children": [ - 80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101 + 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 ] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -59856,18 +65146,20 @@ { "title": "Properties", "kind": 1024, - "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] + "children": [ + 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 + ] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -59939,7 +65231,7 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reflection", @@ -59954,7 +65246,7 @@ ], "name": "RealtimePresenceState", "dereferenced": { - "id": 578, + "id": 604, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", @@ -59968,7 +65260,7 @@ ], "typeParameter": [ { - "id": 586, + "id": 612, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -59976,7 +65268,7 @@ "type": { "type": "reflection", "declaration": { - "id": 582, + "id": 608, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -59989,14 +65281,14 @@ } ], "indexSignature": { - "id": 583, + "id": 609, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 584, + "id": 610, "name": "key", "kind": 32768, "flags": {}, @@ -60016,7 +65308,7 @@ "default": { "type": "reflection", "declaration": { - "id": 585, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -60035,7 +65327,7 @@ "type": { "type": "reflection", "declaration": { - "id": 579, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -60048,14 +65340,14 @@ } ], "indexSignature": { - "id": 580, + "id": 606, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 581, + "id": 607, "name": "key", "kind": 32768, "flags": {}, @@ -60072,7 +65364,7 @@ "typeArguments": [ { "type": "reference", - "id": 586, + "id": 612, "name": "T" } ], @@ -60109,6 +65401,24 @@ } } }, + { + "id": 101, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 97, "name": "pushBuffer", @@ -60118,7 +65428,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 141, "character": 2 } ], @@ -60140,7 +65450,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 140, "character": 2 } ], @@ -60150,7 +65460,7 @@ } }, { - "id": 103, + "id": 104, "name": "socket", "kind": 1024, "kindString": "Property", @@ -60159,17 +65469,17 @@ }, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -60177,13 +65487,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -60193,7 +65503,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -60207,7 +65517,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -60216,10 +65526,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -60227,21 +65537,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -60251,7 +65561,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -60263,7 +65573,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -60273,7 +65583,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -60285,7 +65595,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -60295,7 +65605,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -60305,7 +65615,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -60315,14 +65625,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -60330,19 +65640,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -60361,7 +65671,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -60371,7 +65681,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -60381,7 +65691,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -60391,7 +65701,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -60418,7 +65728,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -60428,7 +65738,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -60440,7 +65750,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -60450,14 +65760,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -60465,19 +65775,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -60496,7 +65806,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -60506,7 +65816,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -60518,7 +65828,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -60528,7 +65838,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -60538,7 +65848,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -60548,7 +65858,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -60556,6 +65866,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -60563,14 +65959,20 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493 + 520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, + 532, 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -60582,14 +65984,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -60597,7 +65999,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -60617,7 +66083,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -60625,7 +66091,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -60645,7 +66111,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -60653,7 +66119,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -60668,7 +66134,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -60676,7 +66142,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -60696,7 +66162,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -60704,7 +66170,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -60716,7 +66182,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -60724,7 +66190,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -60736,7 +66202,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -60744,7 +66210,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -60755,7 +66221,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -60763,28 +66229,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -60808,7 +66274,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -60839,14 +66305,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -60874,7 +66340,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -60909,7 +66375,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -60919,27 +66385,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -60959,7 +66425,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -60967,7 +66433,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -60978,7 +66444,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -60986,7 +66452,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -61008,7 +66474,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -61016,7 +66501,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -61029,7 +66514,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -61039,27 +66524,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -61079,7 +66564,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -61087,7 +66572,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -61107,7 +66592,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -61115,7 +66600,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -61127,7 +66612,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -61135,7 +66620,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -61145,7 +66630,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -61153,7 +66638,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -61164,7 +66649,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -61172,7 +66657,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -61188,7 +66673,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -61196,7 +66681,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -61207,7 +66692,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -61215,21 +66700,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -61237,7 +66722,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -61252,7 +66737,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -61260,7 +66745,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -61275,7 +66760,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -61283,7 +66768,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -61298,7 +66783,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -61306,7 +66791,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -61325,7 +66810,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -61333,7 +66818,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -61341,7 +66826,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -61352,7 +66837,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -61360,7 +66845,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -61379,7 +66864,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -61387,20 +66985,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -61411,17 +67009,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -61429,21 +67027,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -61451,21 +67049,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -61478,21 +67076,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -61502,7 +67100,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -61512,7 +67110,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -61522,7 +67120,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -61536,13 +67134,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -61550,7 +67148,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -61563,21 +67161,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -61587,7 +67185,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -61601,31 +67199,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -61637,13 +67258,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -61663,7 +67284,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -61671,13 +67292,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -61693,7 +67314,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -61701,13 +67322,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -61723,7 +67344,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -61731,13 +67352,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -61747,7 +67368,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -61763,7 +67384,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -61787,7 +67408,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -61795,13 +67477,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -61821,7 +67503,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -61829,13 +67511,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -61851,7 +67533,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -61859,13 +67541,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -61876,7 +67558,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -61887,7 +67569,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -61898,7 +67580,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -61919,7 +67601,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -61927,13 +67609,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -61944,17 +67626,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -61962,21 +67644,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -61984,7 +67666,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -61994,7 +67676,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -62004,7 +67686,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -62014,7 +67696,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -62022,7 +67704,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -62032,7 +67714,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -62040,7 +67722,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -62050,7 +67732,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -62058,7 +67740,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -62072,13 +67754,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -62096,7 +67778,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -62104,13 +67786,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -62125,7 +67807,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -62138,7 +67820,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -62146,13 +67828,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -62162,7 +67844,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -62194,19 +67876,19 @@ "title": "Properties", "kind": 1024, "children": [ - 80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101 + 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 ] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -62219,7 +67901,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -62231,7 +67913,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -62239,29 +67959,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -62275,12 +67996,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -62290,26 +68020,28 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, - 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, 385, + 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, - "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] + "children": [ + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, 454 + ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -62325,7 +68057,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 125, + "line": 137, "character": 2 } ], @@ -62344,7 +68076,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 132, + "line": 144, "character": 2 } ], @@ -62362,7 +68094,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 124, + "line": 136, "character": 2 } ], @@ -62372,7 +68104,7 @@ } }, { - "id": 101, + "id": 102, "name": "topic", "kind": 1024, "kindString": "Property", @@ -62385,108 +68117,7 @@ } }, { - "id": 269, - "name": "_fetchWithTimeout", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 538, - "character": 8 - } - ], - "signatures": [ - { - "id": 270, - "name": "_fetchWithTimeout", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 271, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 272, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 273, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 274, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 275, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 276, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 135, + "id": 136, "name": "on", "kind": 2048, "kindString": "Method", @@ -62500,7 +68131,7 @@ ], "signatures": [ { - "id": 136, + "id": 137, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -62510,7 +68141,7 @@ }, "parameters": [ { - "id": 137, + "id": 138, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -62521,7 +68152,7 @@ } }, { - "id": 138, + "id": 139, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -62529,14 +68160,14 @@ "type": { "type": "reflection", "declaration": { - "id": 139, + "id": 140, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 140, + "id": 141, "name": "event", "kind": 1024, "kindString": "Property", @@ -62558,14 +68189,14 @@ { "title": "Properties", "kind": 1024, - "children": [140] + "children": [141] } ] } } }, { - "id": 141, + "id": 142, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -62573,14 +68204,14 @@ "type": { "type": "reflection", "declaration": { - "id": 142, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 143, + "id": 144, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -62602,14 +68233,14 @@ } }, { - "id": 144, + "id": 145, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 148, + "id": 149, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -62617,20 +68248,20 @@ "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 146, + "id": 147, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 147, + "id": 148, "name": "key", "kind": 32768, "flags": {}, @@ -62651,7 +68282,7 @@ ], "parameters": [ { - "id": 149, + "id": 150, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -62662,7 +68293,7 @@ } }, { - "id": 150, + "id": 151, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -62670,14 +68301,14 @@ "type": { "type": "reflection", "declaration": { - "id": 151, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 153, "name": "event", "kind": 1024, "kindString": "Property", @@ -62699,14 +68330,14 @@ { "title": "Properties", "kind": 1024, - "children": [152] + "children": [153] } ] } } }, { - "id": 153, + "id": 154, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -62714,32 +68345,32 @@ "type": { "type": "reflection", "declaration": { - "id": 154, + "id": 155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 155, + "id": 156, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 156, + "id": 157, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 558, + "id": 584, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 149, "name": "T" } ], @@ -62764,14 +68395,14 @@ } }, { - "id": 157, + "id": 158, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 161, + "id": 162, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -62779,20 +68410,20 @@ "type": { "type": "reflection", "declaration": { - "id": 158, + "id": 159, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 159, + "id": 160, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 160, + "id": 161, "name": "key", "kind": 32768, "flags": {}, @@ -62813,7 +68444,7 @@ ], "parameters": [ { - "id": 162, + "id": 163, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -62824,7 +68455,7 @@ } }, { - "id": 163, + "id": 164, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -62832,14 +68463,14 @@ "type": { "type": "reflection", "declaration": { - "id": 164, + "id": 165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 165, + "id": 166, "name": "event", "kind": 1024, "kindString": "Property", @@ -62861,14 +68492,14 @@ { "title": "Properties", "kind": 1024, - "children": [165] + "children": [166] } ] } } }, { - "id": 166, + "id": 167, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -62876,32 +68507,32 @@ "type": { "type": "reflection", "declaration": { - "id": 167, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 168, + "id": 169, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 169, + "id": 170, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 568, + "id": 594, "typeArguments": [ { "type": "reference", - "id": 161, + "id": 162, "name": "T" } ], @@ -62926,14 +68557,14 @@ } }, { - "id": 170, + "id": 171, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 174, + "id": 175, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -62941,20 +68572,20 @@ "type": { "type": "reflection", "declaration": { - "id": 171, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 172, + "id": 173, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 173, + "id": 174, "name": "key", "kind": 32768, "flags": {}, @@ -62975,7 +68606,7 @@ ], "parameters": [ { - "id": 175, + "id": 176, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -62986,14 +68617,14 @@ } }, { - "id": 176, + "id": 177, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -63002,7 +68633,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -63010,13 +68641,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -63028,7 +68659,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -63040,14 +68671,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -63058,19 +68689,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -63083,7 +68714,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -63093,7 +68724,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -63104,7 +68735,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -63114,7 +68745,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -63127,7 +68758,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -63141,13 +68772,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -63157,7 +68788,7 @@ } }, { - "id": 177, + "id": 178, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -63165,32 +68796,32 @@ "type": { "type": "reflection", "declaration": { - "id": 178, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 179, + "id": 180, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 180, + "id": 181, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 524, + "id": 550, "typeArguments": [ { "type": "reference", - "id": 174, + "id": 175, "name": "T" } ], @@ -63215,14 +68846,14 @@ } }, { - "id": 181, + "id": 182, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 185, + "id": 186, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -63230,20 +68861,20 @@ "type": { "type": "reflection", "declaration": { - "id": 182, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 183, + "id": 184, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 184, + "id": 185, "name": "key", "kind": 32768, "flags": {}, @@ -63264,7 +68895,7 @@ ], "parameters": [ { - "id": 186, + "id": 187, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -63275,14 +68906,14 @@ } }, { - "id": 187, + "id": 188, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -63291,7 +68922,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -63299,13 +68930,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -63317,7 +68948,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -63329,14 +68960,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -63347,19 +68978,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -63372,7 +69003,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -63382,7 +69013,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -63393,7 +69024,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -63403,7 +69034,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -63416,7 +69047,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -63430,13 +69061,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -63446,7 +69077,7 @@ } }, { - "id": 188, + "id": 189, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -63454,32 +69085,32 @@ "type": { "type": "reflection", "declaration": { - "id": 189, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 190, + "id": 191, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 191, + "id": 192, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 529, + "id": 555, "typeArguments": [ { "type": "reference", - "id": 185, + "id": 186, "name": "T" } ], @@ -63504,14 +69135,14 @@ } }, { - "id": 192, + "id": 193, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 196, + "id": 197, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -63519,20 +69150,20 @@ "type": { "type": "reflection", "declaration": { - "id": 193, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 194, + "id": 195, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 196, "name": "key", "kind": 32768, "flags": {}, @@ -63553,7 +69184,7 @@ ], "parameters": [ { - "id": 197, + "id": 198, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -63564,14 +69195,14 @@ } }, { - "id": 198, + "id": 199, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -63580,7 +69211,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -63588,13 +69219,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -63606,7 +69237,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -63618,14 +69249,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -63636,19 +69267,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -63661,7 +69292,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -63671,7 +69302,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -63682,7 +69313,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -63692,7 +69323,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -63705,7 +69336,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -63719,13 +69350,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -63735,7 +69366,7 @@ } }, { - "id": 199, + "id": 200, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -63743,32 +69374,32 @@ "type": { "type": "reflection", "declaration": { - "id": 200, + "id": 201, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 201, + "id": 202, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 202, + "id": 203, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 539, + "id": 565, "typeArguments": [ { "type": "reference", - "id": 196, + "id": 197, "name": "T" } ], @@ -63793,14 +69424,14 @@ } }, { - "id": 203, + "id": 204, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 207, + "id": 208, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -63808,20 +69439,20 @@ "type": { "type": "reflection", "declaration": { - "id": 204, + "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 205, + "id": 206, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 206, + "id": 207, "name": "key", "kind": 32768, "flags": {}, @@ -63842,7 +69473,7 @@ ], "parameters": [ { - "id": 208, + "id": 209, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -63853,14 +69484,14 @@ } }, { - "id": 209, + "id": 210, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -63869,7 +69500,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -63877,13 +69508,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -63895,7 +69526,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -63907,14 +69538,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -63925,19 +69556,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -63950,7 +69581,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -63960,7 +69591,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -63971,7 +69602,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -63981,7 +69612,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -63994,7 +69625,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -64008,13 +69639,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -64024,7 +69655,7 @@ } }, { - "id": 210, + "id": 211, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -64032,32 +69663,32 @@ "type": { "type": "reflection", "declaration": { - "id": 211, + "id": 212, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 212, + "id": 213, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 213, + "id": 214, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 548, + "id": 574, "typeArguments": [ { "type": "reference", - "id": 207, + "id": 208, "name": "T" } ], @@ -64082,7 +69713,7 @@ } }, { - "id": 214, + "id": 215, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -64092,7 +69723,7 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -64106,7 +69737,7 @@ } }, { - "id": 216, + "id": 217, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -64117,14 +69748,14 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 218, + "id": 219, "name": "event", "kind": 1024, "kindString": "Property", @@ -64146,14 +69777,14 @@ { "title": "Properties", "kind": 1024, - "children": [218] + "children": [219] } ] } } }, { - "id": 219, + "id": 220, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -64164,21 +69795,21 @@ "type": { "type": "reflection", "declaration": { - "id": 220, + "id": 221, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 221, + "id": 222, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 222, + "id": 223, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -64186,14 +69817,14 @@ "type": { "type": "reflection", "declaration": { - "id": 223, + "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 226, "name": "event", "kind": 1024, "kindString": "Property", @@ -64211,7 +69842,7 @@ } }, { - "id": 224, + "id": 225, "name": "type", "kind": 1024, "kindString": "Property", @@ -64233,18 +69864,18 @@ { "title": "Properties", "kind": 1024, - "children": [225, 224] + "children": [226, 225] } ], "indexSignature": { - "id": 226, + "id": 227, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 227, + "id": 228, "name": "key", "kind": 32768, "flags": {}, @@ -64280,14 +69911,14 @@ } }, { - "id": 228, + "id": 229, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 232, + "id": 233, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -64295,20 +69926,20 @@ "type": { "type": "reflection", "declaration": { - "id": 229, + "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 230, + "id": 231, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 231, + "id": 232, "name": "key", "kind": 32768, "flags": {}, @@ -64329,7 +69960,7 @@ ], "parameters": [ { - "id": 233, + "id": 234, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -64340,7 +69971,7 @@ } }, { - "id": 234, + "id": 235, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -64348,14 +69979,14 @@ "type": { "type": "reflection", "declaration": { - "id": 235, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 236, + "id": 237, "name": "event", "kind": 1024, "kindString": "Property", @@ -64377,14 +70008,14 @@ { "title": "Properties", "kind": 1024, - "children": [236] + "children": [237] } ] } } }, { - "id": 237, + "id": 238, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -64392,21 +70023,21 @@ "type": { "type": "reflection", "declaration": { - "id": 238, + "id": 239, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 239, + "id": 240, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 240, + "id": 241, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -64414,14 +70045,14 @@ "type": { "type": "reflection", "declaration": { - "id": 241, + "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 243, + "id": 244, "name": "event", "kind": 1024, "kindString": "Property", @@ -64439,7 +70070,7 @@ } }, { - "id": 244, + "id": 245, "name": "payload", "kind": 1024, "kindString": "Property", @@ -64453,12 +70084,12 @@ ], "type": { "type": "reference", - "id": 232, + "id": 233, "name": "T" } }, { - "id": 242, + "id": 243, "name": "type", "kind": 1024, "kindString": "Property", @@ -64480,7 +70111,7 @@ { "title": "Properties", "kind": 1024, - "children": [243, 244, 242] + "children": [244, 245, 243] } ] } @@ -64502,11 +70133,138 @@ "id": 64, "name": "default" } + }, + { + "id": 246, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 250, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 247, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 248, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 249, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 251, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "system" + } + }, + { + "id": 252, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 253, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 254, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 255, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 256, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 257, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } } ] }, { - "id": 112, + "id": 113, "name": "presenceState", "kind": 2048, "kindString": "Method", @@ -64520,14 +70278,14 @@ ], "signatures": [ { - "id": 113, + "id": 114, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 118, + "id": 119, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -64535,20 +70293,20 @@ "type": { "type": "reflection", "declaration": { - "id": 114, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 115, + "id": 116, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 116, + "id": 117, "name": "key", "kind": 32768, "flags": {}, @@ -64568,7 +70326,7 @@ "default": { "type": "reflection", "declaration": { - "id": 117, + "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -64579,11 +70337,11 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reference", - "id": 118, + "id": 119, "name": "T" } ], @@ -64593,7 +70351,7 @@ ] }, { - "id": 245, + "id": 258, "name": "send", "kind": 2048, "kindString": "Method", @@ -64601,13 +70359,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 425, + "line": 430, "character": 8 } ], "signatures": [ { - "id": 246, + "id": 259, "name": "send", "kind": 4096, "kindString": "Call signature", @@ -64617,7 +70375,7 @@ }, "parameters": [ { - "id": 247, + "id": 260, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -64628,14 +70386,14 @@ "type": { "type": "reflection", "declaration": { - "id": 248, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 263, "name": "event", "kind": 1024, "kindString": "Property", @@ -64646,7 +70404,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 428, + "line": 433, "character": 6 } ], @@ -64656,7 +70414,7 @@ } }, { - "id": 251, + "id": 264, "name": "payload", "kind": 1024, "kindString": "Property", @@ -64669,7 +70427,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 429, + "line": 434, "character": 6 } ], @@ -64679,7 +70437,7 @@ } }, { - "id": 249, + "id": 262, "name": "type", "kind": 1024, "kindString": "Property", @@ -64690,7 +70448,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 427, + "line": 432, "character": 6 } ], @@ -64717,18 +70475,18 @@ { "title": "Properties", "kind": 1024, - "children": [250, 251, 249] + "children": [263, 264, 262] } ], "indexSignature": { - "id": 252, + "id": 265, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 253, + "id": 266, "name": "key", "kind": 32768, "flags": {}, @@ -64747,7 +70505,7 @@ } }, { - "id": 254, + "id": 267, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -64758,20 +70516,20 @@ "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 256, + "id": 269, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 257, + "id": 270, "name": "key", "kind": 32768, "flags": {}, @@ -64796,7 +70554,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -64808,7 +70566,7 @@ ] }, { - "id": 104, + "id": 105, "name": "subscribe", "kind": 2048, "kindString": "Method", @@ -64816,13 +70574,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 198, + "line": 213, "character": 2 } ], "signatures": [ { - "id": 105, + "id": 106, "name": "subscribe", "kind": 4096, "kindString": "Call signature", @@ -64832,7 +70590,7 @@ }, "parameters": [ { - "id": 106, + "id": 107, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -64842,49 +70600,33 @@ "type": { "type": "reflection", "declaration": { - "id": 107, + "id": 108, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 108, + "id": 109, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 109, + "id": 110, "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" - } - ] + "type": "reference", + "id": 628, + "name": "REALTIME_SUBSCRIBE_STATES" } }, { - "id": 110, + "id": 111, "name": "err", "kind": 32768, "kindString": "Parameter", @@ -64909,7 +70651,7 @@ } }, { - "id": 111, + "id": 112, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -64930,7 +70672,7 @@ ] }, { - "id": 119, + "id": 120, "name": "track", "kind": 2048, "kindString": "Method", @@ -64944,14 +70686,14 @@ ], "signatures": [ { - "id": 120, + "id": 121, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 121, + "id": 122, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -64959,20 +70701,20 @@ "type": { "type": "reflection", "declaration": { - "id": 122, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 123, + "id": 124, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 124, + "id": 125, "name": "key", "kind": 32768, "flags": {}, @@ -64991,7 +70733,7 @@ } }, { - "id": 125, + "id": 126, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -64999,20 +70741,20 @@ "type": { "type": "reflection", "declaration": { - "id": 126, + "id": 127, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 127, + "id": 128, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 128, + "id": 129, "name": "key", "kind": 32768, "flags": {}, @@ -65037,7 +70779,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -65049,7 +70791,7 @@ ] }, { - "id": 264, + "id": 277, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -65057,13 +70799,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 495, + "line": 507, "character": 2 } ], "signatures": [ { - "id": 265, + "id": 278, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -65074,7 +70816,7 @@ }, "parameters": [ { - "id": 266, + "id": 279, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -65115,7 +70857,7 @@ ] }, { - "id": 129, + "id": 130, "name": "untrack", "kind": 2048, "kindString": "Method", @@ -65129,14 +70871,14 @@ ], "signatures": [ { - "id": 130, + "id": 131, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 131, + "id": 132, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -65144,20 +70886,20 @@ "type": { "type": "reflection", "declaration": { - "id": 132, + "id": 133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 133, + "id": 134, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 134, + "id": 135, "name": "key", "kind": 32768, "flags": {}, @@ -65182,7 +70924,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -65194,7 +70936,7 @@ ] }, { - "id": 258, + "id": 271, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", @@ -65202,20 +70944,20 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 482, + "line": 494, "character": 2 } ], "signatures": [ { - "id": 259, + "id": 272, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 260, + "id": 273, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -65223,20 +70965,20 @@ "type": { "type": "reflection", "declaration": { - "id": 261, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 262, + "id": 275, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 263, + "id": 276, "name": "key", "kind": 32768, "flags": {}, @@ -65272,31 +71014,31 @@ { "title": "Properties", "kind": 1024, - "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] + "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] }, { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -65304,13 +71046,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -65320,7 +71062,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -65334,7 +71076,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -65343,10 +71085,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -65354,21 +71096,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -65378,7 +71120,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -65390,7 +71132,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -65400,7 +71142,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -65412,7 +71154,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -65422,7 +71164,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -65432,7 +71174,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -65442,14 +71184,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -65457,19 +71199,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -65488,7 +71230,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -65498,7 +71240,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -65508,7 +71250,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -65518,7 +71260,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -65545,7 +71287,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -65555,7 +71297,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -65567,7 +71309,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -65577,14 +71319,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -65592,19 +71334,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -65623,7 +71365,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -65633,7 +71375,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -65645,7 +71387,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -65655,7 +71397,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -65665,7 +71407,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -65675,7 +71417,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -65683,6 +71425,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -65690,14 +71518,19 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493 + 520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, 532, 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -65709,14 +71542,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -65724,7 +71557,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -65744,7 +71641,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -65752,7 +71649,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -65772,7 +71669,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -65780,7 +71677,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -65795,7 +71692,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -65803,7 +71700,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -65823,7 +71720,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -65831,7 +71728,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -65843,7 +71740,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -65851,7 +71748,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -65863,7 +71760,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -65871,7 +71768,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -65882,7 +71779,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -65890,28 +71787,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -65935,7 +71832,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -65966,14 +71863,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -66001,7 +71898,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -66036,7 +71933,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -66046,27 +71943,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -66086,7 +71983,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -66094,7 +71991,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -66105,7 +72002,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -66113,7 +72010,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -66135,7 +72032,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -66143,7 +72059,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -66156,7 +72072,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -66166,27 +72082,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -66206,7 +72122,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -66214,7 +72130,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -66234,7 +72150,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -66242,7 +72158,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -66254,7 +72170,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -66262,7 +72178,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -66272,7 +72188,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -66280,7 +72196,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -66291,7 +72207,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -66299,7 +72215,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -66315,7 +72231,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -66323,7 +72239,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -66334,7 +72250,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -66342,21 +72258,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -66364,7 +72280,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -66379,7 +72295,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -66387,7 +72303,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -66402,7 +72318,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -66410,7 +72326,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -66425,7 +72341,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -66433,7 +72349,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -66452,7 +72368,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -66460,7 +72376,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -66468,7 +72384,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -66479,7 +72395,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -66487,7 +72403,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -66506,7 +72422,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -66514,20 +72543,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -66538,17 +72567,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -66556,21 +72585,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -66578,21 +72607,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -66605,21 +72634,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -66629,7 +72658,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -66639,7 +72668,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -66649,7 +72678,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -66663,13 +72692,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -66677,7 +72706,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -66690,21 +72719,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -66714,7 +72743,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -66728,31 +72757,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -66764,13 +72816,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -66790,7 +72842,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -66798,13 +72850,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -66820,7 +72872,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -66828,13 +72880,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -66850,7 +72902,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -66858,13 +72910,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -66874,7 +72926,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -66890,7 +72942,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -66914,7 +72966,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -66922,13 +73035,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -66948,7 +73061,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -66956,13 +73069,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -66978,7 +73091,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -66986,13 +73099,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -67003,7 +73116,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -67014,7 +73127,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -67025,7 +73138,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -67046,7 +73159,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -67054,13 +73167,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -67071,17 +73184,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -67089,21 +73202,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -67111,7 +73224,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -67121,7 +73234,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -67131,7 +73244,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -67141,7 +73254,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -67149,7 +73262,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -67159,7 +73272,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -67167,7 +73280,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -67177,7 +73290,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -67185,7 +73298,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -67199,13 +73312,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -67223,7 +73336,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -67231,13 +73344,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -67252,7 +73365,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -67265,7 +73378,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -67273,13 +73386,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -67289,7 +73402,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -67320,7 +73433,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 134, + "line": 147, "character": 2 } ], @@ -67351,10 +73464,10 @@ "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -67362,21 +73475,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -67384,21 +73497,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -67411,21 +73524,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -67435,7 +73548,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -67445,7 +73558,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -67455,7 +73568,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -67469,13 +73582,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -67483,7 +73596,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -67496,21 +73609,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -67520,7 +73633,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -67534,31 +73647,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -67570,13 +73706,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -67594,10 +73730,10 @@ "flags": {}, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", @@ -67607,30 +73743,30 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, - 379, 383, 372, 380, 386, 382, 381, 388, 389, 390, - 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, + 391, 392, 380, 396, 385, 393, 399, 395, 394, 401, + 402, 403, 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, "children": [ - 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, - 433 + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, + 451, 436, 433, 457, 454 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -67655,7 +73791,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 116, + "line": 128, "character": 2 } ], @@ -67705,7 +73841,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 120, + "line": 132, "character": 6 } ], @@ -67725,7 +73861,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 6 } ], @@ -67740,7 +73876,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 14 } ], @@ -67781,7 +73917,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 121, + "line": 133, "character": 6 } ], @@ -67799,7 +73935,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 118, + "line": 130, "character": 6 } ], @@ -67819,7 +73955,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 117, + "line": 129, "character": 19 } ] @@ -67840,7 +73976,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 143, "character": 2 } ], @@ -67858,7 +73994,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 127, + "line": 139, "character": 2 } ], @@ -67876,7 +74012,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 126, + "line": 138, "character": 2 } ], @@ -67887,7 +74023,7 @@ "defaultValue": "false" }, { - "id": 102, + "id": 103, "name": "params", "kind": 1024, "kindString": "Property", @@ -67896,10 +74032,10 @@ }, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -67907,21 +74043,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -67929,21 +74065,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -67956,21 +74092,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -67980,7 +74116,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -67990,7 +74126,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -68000,7 +74136,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -68014,13 +74150,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -68028,7 +74164,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -68041,21 +74177,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -68065,7 +74201,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -68079,31 +74215,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -68115,13 +74274,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -68140,7 +74299,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 130, + "line": 142, "character": 2 } ], @@ -68192,7 +74351,7 @@ "type": "reference", "id": 64, "name": "default", - "dereferenced": "[Circular ~.children.5.children.32.signatures.0.parameters.0.type.dereferenced]" + "dereferenced": "[Circular ~.children.5.children.40.signatures.0.parameters.0.type.dereferenced]" } }, { @@ -68340,7 +74499,7 @@ "type": "reference", "id": 64, "name": "default", - "dereferenced": "[Circular ~.children.5.children.32.signatures.0.parameters.0.type.dereferenced]" + "dereferenced": "[Circular ~.children.5.children.40.signatures.0.parameters.0.type.dereferenced]" } }, { @@ -68408,7 +74567,7 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reflection", @@ -68423,7 +74582,7 @@ ], "name": "RealtimePresenceState", "dereferenced": { - "id": 578, + "id": 604, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", @@ -68437,7 +74596,7 @@ ], "typeParameter": [ { - "id": 586, + "id": 612, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -68445,7 +74604,7 @@ "type": { "type": "reflection", "declaration": { - "id": 582, + "id": 608, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -68458,14 +74617,14 @@ } ], "indexSignature": { - "id": 583, + "id": 609, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 584, + "id": 610, "name": "key", "kind": 32768, "flags": {}, @@ -68485,7 +74644,7 @@ "default": { "type": "reflection", "declaration": { - "id": 585, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -68504,7 +74663,7 @@ "type": { "type": "reflection", "declaration": { - "id": 579, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -68517,14 +74676,14 @@ } ], "indexSignature": { - "id": 580, + "id": 606, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 581, + "id": 607, "name": "key", "kind": 32768, "flags": {}, @@ -68541,7 +74700,7 @@ "typeArguments": [ { "type": "reference", - "id": 586, + "id": 612, "name": "T" } ], @@ -68578,6 +74737,24 @@ } } }, + { + "id": 101, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 97, "name": "pushBuffer", @@ -68587,7 +74764,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 141, "character": 2 } ], @@ -68609,7 +74786,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 140, "character": 2 } ], @@ -68619,7 +74796,7 @@ } }, { - "id": 103, + "id": 104, "name": "socket", "kind": 1024, "kindString": "Property", @@ -68628,10 +74805,10 @@ }, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", @@ -68641,28 +74818,30 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, - 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, + 380, 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, + 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, "children": [ - 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, + 433, 457, 454 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -68678,7 +74857,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 125, + "line": 137, "character": 2 } ], @@ -68697,7 +74876,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 132, + "line": 144, "character": 2 } ], @@ -68715,7 +74894,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 124, + "line": 136, "character": 2 } ], @@ -68725,7 +74904,7 @@ } }, { - "id": 101, + "id": 102, "name": "topic", "kind": 1024, "kindString": "Property", @@ -68738,108 +74917,7 @@ } }, { - "id": 269, - "name": "_fetchWithTimeout", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 538, - "character": 8 - } - ], - "signatures": [ - { - "id": 270, - "name": "_fetchWithTimeout", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 271, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 272, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 273, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 274, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 275, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 276, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 135, + "id": 136, "name": "on", "kind": 2048, "kindString": "Method", @@ -68853,7 +74931,7 @@ ], "signatures": [ { - "id": 136, + "id": 137, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -68863,7 +74941,7 @@ }, "parameters": [ { - "id": 137, + "id": 138, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -68874,7 +74952,7 @@ } }, { - "id": 138, + "id": 139, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -68882,14 +74960,14 @@ "type": { "type": "reflection", "declaration": { - "id": 139, + "id": 140, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 140, + "id": 141, "name": "event", "kind": 1024, "kindString": "Property", @@ -68911,14 +74989,14 @@ { "title": "Properties", "kind": 1024, - "children": [140] + "children": [141] } ] } } }, { - "id": 141, + "id": 142, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -68926,14 +75004,14 @@ "type": { "type": "reflection", "declaration": { - "id": 142, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 143, + "id": 144, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -68955,14 +75033,14 @@ } }, { - "id": 144, + "id": 145, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 148, + "id": 149, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -68970,20 +75048,20 @@ "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 146, + "id": 147, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 147, + "id": 148, "name": "key", "kind": 32768, "flags": {}, @@ -69004,7 +75082,7 @@ ], "parameters": [ { - "id": 149, + "id": 150, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -69015,7 +75093,7 @@ } }, { - "id": 150, + "id": 151, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -69023,14 +75101,14 @@ "type": { "type": "reflection", "declaration": { - "id": 151, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 153, "name": "event", "kind": 1024, "kindString": "Property", @@ -69052,14 +75130,14 @@ { "title": "Properties", "kind": 1024, - "children": [152] + "children": [153] } ] } } }, { - "id": 153, + "id": 154, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -69067,32 +75145,32 @@ "type": { "type": "reflection", "declaration": { - "id": 154, + "id": 155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 155, + "id": 156, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 156, + "id": 157, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 558, + "id": 584, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 149, "name": "T" } ], @@ -69117,14 +75195,14 @@ } }, { - "id": 157, + "id": 158, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 161, + "id": 162, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -69132,20 +75210,20 @@ "type": { "type": "reflection", "declaration": { - "id": 158, + "id": 159, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 159, + "id": 160, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 160, + "id": 161, "name": "key", "kind": 32768, "flags": {}, @@ -69166,7 +75244,7 @@ ], "parameters": [ { - "id": 162, + "id": 163, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -69177,7 +75255,7 @@ } }, { - "id": 163, + "id": 164, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -69185,14 +75263,14 @@ "type": { "type": "reflection", "declaration": { - "id": 164, + "id": 165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 165, + "id": 166, "name": "event", "kind": 1024, "kindString": "Property", @@ -69214,14 +75292,14 @@ { "title": "Properties", "kind": 1024, - "children": [165] + "children": [166] } ] } } }, { - "id": 166, + "id": 167, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -69229,32 +75307,32 @@ "type": { "type": "reflection", "declaration": { - "id": 167, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 168, + "id": 169, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 169, + "id": 170, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 568, + "id": 594, "typeArguments": [ { "type": "reference", - "id": 161, + "id": 162, "name": "T" } ], @@ -69279,14 +75357,14 @@ } }, { - "id": 170, + "id": 171, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 174, + "id": 175, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -69294,20 +75372,20 @@ "type": { "type": "reflection", "declaration": { - "id": 171, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 172, + "id": 173, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 173, + "id": 174, "name": "key", "kind": 32768, "flags": {}, @@ -69328,7 +75406,7 @@ ], "parameters": [ { - "id": 175, + "id": 176, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -69339,14 +75417,14 @@ } }, { - "id": 176, + "id": 177, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -69355,7 +75433,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -69363,13 +75441,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -69381,7 +75459,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -69393,14 +75471,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -69411,19 +75489,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -69436,7 +75514,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -69446,7 +75524,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -69457,7 +75535,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -69467,7 +75545,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -69480,7 +75558,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -69494,13 +75572,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -69510,7 +75588,7 @@ } }, { - "id": 177, + "id": 178, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -69518,32 +75596,32 @@ "type": { "type": "reflection", "declaration": { - "id": 178, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 179, + "id": 180, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 180, + "id": 181, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 524, + "id": 550, "typeArguments": [ { "type": "reference", - "id": 174, + "id": 175, "name": "T" } ], @@ -69568,14 +75646,14 @@ } }, { - "id": 181, + "id": 182, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 185, + "id": 186, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -69583,20 +75661,20 @@ "type": { "type": "reflection", "declaration": { - "id": 182, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 183, + "id": 184, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 184, + "id": 185, "name": "key", "kind": 32768, "flags": {}, @@ -69617,7 +75695,7 @@ ], "parameters": [ { - "id": 186, + "id": 187, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -69628,14 +75706,14 @@ } }, { - "id": 187, + "id": 188, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -69644,7 +75722,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -69652,13 +75730,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -69670,7 +75748,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -69682,14 +75760,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -69700,19 +75778,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -69725,7 +75803,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -69735,7 +75813,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -69746,7 +75824,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -69756,7 +75834,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -69769,7 +75847,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -69783,13 +75861,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -69799,7 +75877,7 @@ } }, { - "id": 188, + "id": 189, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -69807,32 +75885,32 @@ "type": { "type": "reflection", "declaration": { - "id": 189, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 190, + "id": 191, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 191, + "id": 192, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 529, + "id": 555, "typeArguments": [ { "type": "reference", - "id": 185, + "id": 186, "name": "T" } ], @@ -69857,14 +75935,14 @@ } }, { - "id": 192, + "id": 193, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 196, + "id": 197, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -69872,20 +75950,20 @@ "type": { "type": "reflection", "declaration": { - "id": 193, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 194, + "id": 195, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 196, "name": "key", "kind": 32768, "flags": {}, @@ -69906,7 +75984,7 @@ ], "parameters": [ { - "id": 197, + "id": 198, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -69917,14 +75995,14 @@ } }, { - "id": 198, + "id": 199, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -69933,7 +76011,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -69941,13 +76019,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -69959,7 +76037,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -69971,14 +76049,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -69989,19 +76067,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -70014,7 +76092,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -70024,7 +76102,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -70035,7 +76113,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -70045,7 +76123,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -70058,7 +76136,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -70072,13 +76150,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -70088,7 +76166,7 @@ } }, { - "id": 199, + "id": 200, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -70096,32 +76174,32 @@ "type": { "type": "reflection", "declaration": { - "id": 200, + "id": 201, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 201, + "id": 202, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 202, + "id": 203, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 539, + "id": 565, "typeArguments": [ { "type": "reference", - "id": 196, + "id": 197, "name": "T" } ], @@ -70146,14 +76224,14 @@ } }, { - "id": 203, + "id": 204, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 207, + "id": 208, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -70161,20 +76239,20 @@ "type": { "type": "reflection", "declaration": { - "id": 204, + "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 205, + "id": 206, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 206, + "id": 207, "name": "key", "kind": 32768, "flags": {}, @@ -70195,7 +76273,7 @@ ], "parameters": [ { - "id": 208, + "id": 209, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -70206,14 +76284,14 @@ } }, { - "id": 209, + "id": 210, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -70222,7 +76300,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -70230,13 +76308,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -70248,7 +76326,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -70260,14 +76338,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -70278,19 +76356,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -70303,7 +76381,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -70313,7 +76391,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -70324,7 +76402,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -70334,7 +76412,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -70347,7 +76425,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -70361,13 +76439,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -70377,7 +76455,7 @@ } }, { - "id": 210, + "id": 211, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -70385,32 +76463,32 @@ "type": { "type": "reflection", "declaration": { - "id": 211, + "id": 212, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 212, + "id": 213, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 213, + "id": 214, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 548, + "id": 574, "typeArguments": [ { "type": "reference", - "id": 207, + "id": 208, "name": "T" } ], @@ -70435,7 +76513,7 @@ } }, { - "id": 214, + "id": 215, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -70445,7 +76523,7 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -70459,7 +76537,7 @@ } }, { - "id": 216, + "id": 217, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -70470,14 +76548,14 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 218, + "id": 219, "name": "event", "kind": 1024, "kindString": "Property", @@ -70499,14 +76577,14 @@ { "title": "Properties", "kind": 1024, - "children": [218] + "children": [219] } ] } } }, { - "id": 219, + "id": 220, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -70517,21 +76595,21 @@ "type": { "type": "reflection", "declaration": { - "id": 220, + "id": 221, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 221, + "id": 222, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 222, + "id": 223, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -70539,14 +76617,14 @@ "type": { "type": "reflection", "declaration": { - "id": 223, + "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 226, "name": "event", "kind": 1024, "kindString": "Property", @@ -70564,7 +76642,7 @@ } }, { - "id": 224, + "id": 225, "name": "type", "kind": 1024, "kindString": "Property", @@ -70586,18 +76664,18 @@ { "title": "Properties", "kind": 1024, - "children": [225, 224] + "children": [226, 225] } ], "indexSignature": { - "id": 226, + "id": 227, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 227, + "id": 228, "name": "key", "kind": 32768, "flags": {}, @@ -70633,14 +76711,14 @@ } }, { - "id": 228, + "id": 229, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 232, + "id": 233, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -70648,20 +76726,20 @@ "type": { "type": "reflection", "declaration": { - "id": 229, + "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 230, + "id": 231, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 231, + "id": 232, "name": "key", "kind": 32768, "flags": {}, @@ -70682,7 +76760,7 @@ ], "parameters": [ { - "id": 233, + "id": 234, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -70693,7 +76771,7 @@ } }, { - "id": 234, + "id": 235, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -70701,14 +76779,14 @@ "type": { "type": "reflection", "declaration": { - "id": 235, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 236, + "id": 237, "name": "event", "kind": 1024, "kindString": "Property", @@ -70730,14 +76808,14 @@ { "title": "Properties", "kind": 1024, - "children": [236] + "children": [237] } ] } } }, { - "id": 237, + "id": 238, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -70745,21 +76823,21 @@ "type": { "type": "reflection", "declaration": { - "id": 238, + "id": 239, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 239, + "id": 240, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 240, + "id": 241, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -70767,14 +76845,14 @@ "type": { "type": "reflection", "declaration": { - "id": 241, + "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 243, + "id": 244, "name": "event", "kind": 1024, "kindString": "Property", @@ -70792,7 +76870,7 @@ } }, { - "id": 244, + "id": 245, "name": "payload", "kind": 1024, "kindString": "Property", @@ -70806,12 +76884,12 @@ ], "type": { "type": "reference", - "id": 232, + "id": 233, "name": "T" } }, { - "id": 242, + "id": 243, "name": "type", "kind": 1024, "kindString": "Property", @@ -70833,7 +76911,7 @@ { "title": "Properties", "kind": 1024, - "children": [243, 244, 242] + "children": [244, 245, 243] } ] } @@ -70855,11 +76933,138 @@ "id": 64, "name": "default" } + }, + { + "id": 246, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 250, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 247, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 248, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 249, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 251, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "system" + } + }, + { + "id": 252, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 253, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 254, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 255, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 256, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 257, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } } ] }, { - "id": 112, + "id": 113, "name": "presenceState", "kind": 2048, "kindString": "Method", @@ -70873,14 +77078,14 @@ ], "signatures": [ { - "id": 113, + "id": 114, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 118, + "id": 119, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -70888,20 +77093,20 @@ "type": { "type": "reflection", "declaration": { - "id": 114, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 115, + "id": 116, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 116, + "id": 117, "name": "key", "kind": 32768, "flags": {}, @@ -70921,7 +77126,7 @@ "default": { "type": "reflection", "declaration": { - "id": 117, + "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -70932,11 +77137,11 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reference", - "id": 118, + "id": 119, "name": "T" } ], @@ -70946,7 +77151,7 @@ ] }, { - "id": 245, + "id": 258, "name": "send", "kind": 2048, "kindString": "Method", @@ -70954,13 +77159,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 425, + "line": 430, "character": 8 } ], "signatures": [ { - "id": 246, + "id": 259, "name": "send", "kind": 4096, "kindString": "Call signature", @@ -70970,7 +77175,7 @@ }, "parameters": [ { - "id": 247, + "id": 260, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -70981,14 +77186,14 @@ "type": { "type": "reflection", "declaration": { - "id": 248, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 263, "name": "event", "kind": 1024, "kindString": "Property", @@ -70999,7 +77204,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 428, + "line": 433, "character": 6 } ], @@ -71009,7 +77214,7 @@ } }, { - "id": 251, + "id": 264, "name": "payload", "kind": 1024, "kindString": "Property", @@ -71022,7 +77227,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 429, + "line": 434, "character": 6 } ], @@ -71032,7 +77237,7 @@ } }, { - "id": 249, + "id": 262, "name": "type", "kind": 1024, "kindString": "Property", @@ -71043,7 +77248,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 427, + "line": 432, "character": 6 } ], @@ -71070,18 +77275,18 @@ { "title": "Properties", "kind": 1024, - "children": [250, 251, 249] + "children": [263, 264, 262] } ], "indexSignature": { - "id": 252, + "id": 265, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 253, + "id": 266, "name": "key", "kind": 32768, "flags": {}, @@ -71100,7 +77305,7 @@ } }, { - "id": 254, + "id": 267, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -71111,20 +77316,20 @@ "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 256, + "id": 269, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 257, + "id": 270, "name": "key", "kind": 32768, "flags": {}, @@ -71149,7 +77354,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -71161,7 +77366,7 @@ ] }, { - "id": 104, + "id": 105, "name": "subscribe", "kind": 2048, "kindString": "Method", @@ -71169,13 +77374,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 198, + "line": 213, "character": 2 } ], "signatures": [ { - "id": 105, + "id": 106, "name": "subscribe", "kind": 4096, "kindString": "Call signature", @@ -71185,7 +77390,7 @@ }, "parameters": [ { - "id": 106, + "id": 107, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -71195,49 +77400,33 @@ "type": { "type": "reflection", "declaration": { - "id": 107, + "id": 108, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 108, + "id": 109, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 109, + "id": 110, "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" - } - ] + "type": "reference", + "id": 628, + "name": "REALTIME_SUBSCRIBE_STATES" } }, { - "id": 110, + "id": 111, "name": "err", "kind": 32768, "kindString": "Parameter", @@ -71262,7 +77451,7 @@ } }, { - "id": 111, + "id": 112, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -71283,7 +77472,7 @@ ] }, { - "id": 119, + "id": 120, "name": "track", "kind": 2048, "kindString": "Method", @@ -71297,14 +77486,14 @@ ], "signatures": [ { - "id": 120, + "id": 121, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 121, + "id": 122, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -71312,20 +77501,20 @@ "type": { "type": "reflection", "declaration": { - "id": 122, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 123, + "id": 124, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 124, + "id": 125, "name": "key", "kind": 32768, "flags": {}, @@ -71344,7 +77533,7 @@ } }, { - "id": 125, + "id": 126, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -71352,20 +77541,20 @@ "type": { "type": "reflection", "declaration": { - "id": 126, + "id": 127, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 127, + "id": 128, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 128, + "id": 129, "name": "key", "kind": 32768, "flags": {}, @@ -71390,7 +77579,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -71402,7 +77591,7 @@ ] }, { - "id": 264, + "id": 277, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -71410,13 +77599,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 495, + "line": 507, "character": 2 } ], "signatures": [ { - "id": 265, + "id": 278, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -71427,7 +77616,7 @@ }, "parameters": [ { - "id": 266, + "id": 279, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -71468,7 +77657,7 @@ ] }, { - "id": 129, + "id": 130, "name": "untrack", "kind": 2048, "kindString": "Method", @@ -71482,14 +77671,14 @@ ], "signatures": [ { - "id": 130, + "id": 131, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 131, + "id": 132, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -71497,20 +77686,20 @@ "type": { "type": "reflection", "declaration": { - "id": 132, + "id": 133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 133, + "id": 134, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 134, + "id": 135, "name": "key", "kind": 32768, "flags": {}, @@ -71535,7 +77724,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -71547,7 +77736,7 @@ ] }, { - "id": 258, + "id": 271, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", @@ -71555,20 +77744,20 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 482, + "line": 494, "character": 2 } ], "signatures": [ { - "id": 259, + "id": 272, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 260, + "id": 273, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -71576,20 +77765,20 @@ "type": { "type": "reflection", "declaration": { - "id": 261, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 262, + "id": 275, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 263, + "id": 276, "name": "key", "kind": 32768, "flags": {}, @@ -71625,18 +77814,20 @@ { "title": "Properties", "kind": 1024, - "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] + "children": [ + 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 + ] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -71649,7 +77840,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -71661,7 +77852,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -71669,29 +77898,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -71705,12 +77935,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -71720,26 +77959,28 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, 381, - 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, 385, 393, 399, + 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, - "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] + "children": [ + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, 454 + ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -71807,7 +78048,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 134, + "line": 147, "character": 2 } ], @@ -71838,10 +78079,10 @@ "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -71849,21 +78090,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -71871,21 +78112,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -71898,21 +78139,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -71922,7 +78163,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -71932,7 +78173,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -71942,7 +78183,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -71956,13 +78197,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -71970,7 +78211,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -71983,21 +78224,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -72007,7 +78248,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -72021,31 +78262,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -72057,13 +78321,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -72081,17 +78345,17 @@ "flags": {}, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -72099,13 +78363,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -72115,7 +78379,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -72129,7 +78393,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -72138,10 +78402,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -72149,21 +78413,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -72173,7 +78437,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -72185,7 +78449,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -72195,7 +78459,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -72207,7 +78471,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -72217,7 +78481,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -72227,7 +78491,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -72237,14 +78501,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -72252,19 +78516,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -72283,7 +78547,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -72293,7 +78557,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -72303,7 +78567,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -72313,7 +78577,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -72340,7 +78604,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -72350,7 +78614,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -72362,7 +78626,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -72372,14 +78636,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -72387,19 +78651,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -72418,7 +78682,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -72428,7 +78692,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -72440,7 +78704,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -72450,7 +78714,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -72460,7 +78724,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -72470,7 +78734,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -72478,6 +78742,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -72485,15 +78835,21 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, - 496, 504, 499, 494, 493 + 520, 519, 531, 522, 517, 530, + 518, 526, 521, 516, 515, 532, + 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -72505,14 +78861,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -72520,7 +78876,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -72540,7 +78960,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -72548,7 +78968,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -72568,7 +78988,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -72576,7 +78996,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -72591,7 +79011,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -72599,7 +79019,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -72619,7 +79039,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -72627,7 +79047,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -72639,7 +79059,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -72647,7 +79067,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -72659,7 +79079,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -72667,7 +79087,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -72678,7 +79098,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -72686,28 +79106,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -72731,7 +79151,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -72762,14 +79182,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -72797,7 +79217,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -72832,7 +79252,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -72842,27 +79262,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -72882,7 +79302,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -72890,7 +79310,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -72901,7 +79321,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -72909,7 +79329,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -72931,7 +79351,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -72939,7 +79378,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -72952,7 +79391,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -72962,27 +79401,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -73002,7 +79441,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -73010,7 +79449,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -73030,7 +79469,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -73038,7 +79477,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -73050,7 +79489,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -73058,7 +79497,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -73068,7 +79507,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -73076,7 +79515,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -73087,7 +79526,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -73095,7 +79534,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -73111,7 +79550,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -73119,7 +79558,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -73130,7 +79569,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -73138,21 +79577,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -73160,7 +79599,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -73175,7 +79614,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -73183,7 +79622,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -73198,7 +79637,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -73206,7 +79645,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -73221,7 +79660,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -73229,7 +79668,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -73248,7 +79687,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -73256,7 +79695,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -73264,7 +79703,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -73275,7 +79714,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -73283,7 +79722,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -73302,7 +79741,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -73310,20 +79862,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -73334,17 +79886,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -73352,21 +79904,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -73374,21 +79926,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -73401,21 +79953,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -73425,7 +79977,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -73435,7 +79987,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -73445,7 +79997,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -73460,14 +80012,14 @@ "title": "Properties", "kind": 1024, "children": [ - 354, 353 + 365, 364 ] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -73475,7 +80027,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -73488,21 +80040,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -73512,7 +80064,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -73526,31 +80078,56 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [ + 362, 366, 369 + ] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -73562,13 +80139,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -73588,7 +80165,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -73596,13 +80173,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -73618,7 +80195,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -73626,13 +80203,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -73648,7 +80225,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -73656,13 +80233,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -73672,7 +80249,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -73688,7 +80265,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -73712,7 +80289,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -73720,13 +80358,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -73746,7 +80384,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -73754,13 +80392,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -73776,7 +80414,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -73784,13 +80422,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -73801,7 +80439,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -73812,7 +80450,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -73823,7 +80461,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -73844,7 +80482,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -73852,13 +80490,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -73869,17 +80507,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -73887,21 +80525,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -73909,7 +80547,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -73919,7 +80557,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -73929,7 +80567,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -73939,7 +80577,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -73947,7 +80585,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -73957,7 +80595,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -73965,7 +80603,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -73975,7 +80613,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -73983,7 +80621,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -73998,14 +80636,14 @@ "title": "Properties", "kind": 1024, "children": [ - 513, 516, 514, 515, 512 + 539, 542, 540, 541, 538 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -74023,7 +80661,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -74031,13 +80669,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -74052,7 +80690,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -74065,7 +80703,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -74073,13 +80711,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -74089,7 +80727,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -74110,7 +80748,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -74122,7 +80760,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -74130,29 +80806,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -74166,12 +80843,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -74181,30 +80867,30 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, - 379, 383, 372, 380, 386, 382, 381, 388, 389, 390, - 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, + 391, 392, 380, 396, 385, 393, 399, 395, 394, 401, + 402, 403, 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, "children": [ - 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, - 433 + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, + 451, 436, 433, 457, 454 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -74229,7 +80915,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 116, + "line": 128, "character": 2 } ], @@ -74279,7 +80965,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 120, + "line": 132, "character": 6 } ], @@ -74299,7 +80985,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 6 } ], @@ -74314,7 +81000,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 14 } ], @@ -74355,7 +81041,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 121, + "line": 133, "character": 6 } ], @@ -74373,7 +81059,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 118, + "line": 130, "character": 6 } ], @@ -74393,7 +81079,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 117, + "line": 129, "character": 19 } ] @@ -74414,7 +81100,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 143, "character": 2 } ], @@ -74432,7 +81118,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 127, + "line": 139, "character": 2 } ], @@ -74450,7 +81136,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 126, + "line": 138, "character": 2 } ], @@ -74461,7 +81147,7 @@ "defaultValue": "false" }, { - "id": 102, + "id": 103, "name": "params", "kind": 1024, "kindString": "Property", @@ -74470,10 +81156,10 @@ }, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -74481,21 +81167,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -74503,21 +81189,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -74530,21 +81216,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -74554,7 +81240,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -74564,7 +81250,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -74574,7 +81260,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -74588,13 +81274,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -74602,7 +81288,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -74615,21 +81301,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -74639,7 +81325,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -74653,31 +81339,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -74689,13 +81398,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -74714,7 +81423,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 130, + "line": 142, "character": 2 } ], @@ -74751,6 +81460,24 @@ } } }, + { + "id": 101, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 97, "name": "pushBuffer", @@ -74760,7 +81487,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 141, "character": 2 } ], @@ -74782,7 +81509,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 140, "character": 2 } ], @@ -74792,7 +81519,7 @@ } }, { - "id": 103, + "id": 104, "name": "socket", "kind": 1024, "kindString": "Property", @@ -74801,17 +81528,17 @@ }, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -74819,13 +81546,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -74835,7 +81562,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -74849,7 +81576,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -74858,10 +81585,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -74869,21 +81596,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -74893,7 +81620,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -74905,7 +81632,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -74915,7 +81642,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -74927,7 +81654,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -74937,7 +81664,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -74947,7 +81674,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -74957,14 +81684,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -74972,19 +81699,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -75003,7 +81730,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -75013,7 +81740,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -75023,7 +81750,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -75033,7 +81760,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -75060,7 +81787,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -75070,7 +81797,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -75082,7 +81809,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -75092,14 +81819,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -75107,19 +81834,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -75138,7 +81865,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -75148,7 +81875,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -75160,7 +81887,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -75170,7 +81897,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -75180,7 +81907,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -75190,7 +81917,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -75198,6 +81925,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -75205,15 +82018,20 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, 496, 504, - 499, 494, 493 + 520, 519, 531, 522, 517, 530, 518, 526, + 521, 516, 515, 532, 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -75225,14 +82043,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -75240,7 +82058,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -75260,7 +82142,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -75268,7 +82150,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -75288,7 +82170,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -75296,7 +82178,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -75311,7 +82193,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -75319,7 +82201,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -75339,7 +82221,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -75347,7 +82229,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -75359,7 +82241,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -75367,7 +82249,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -75379,7 +82261,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -75387,7 +82269,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -75398,7 +82280,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -75406,28 +82288,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -75451,7 +82333,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -75482,14 +82364,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -75517,7 +82399,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -75552,7 +82434,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -75562,27 +82444,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -75602,7 +82484,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -75610,7 +82492,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -75621,7 +82503,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -75629,7 +82511,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -75651,7 +82533,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -75659,7 +82560,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -75672,7 +82573,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -75682,27 +82583,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -75722,7 +82623,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -75730,7 +82631,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -75750,7 +82651,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -75758,7 +82659,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -75770,7 +82671,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -75778,7 +82679,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -75788,7 +82689,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -75796,7 +82697,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -75807,7 +82708,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -75815,7 +82716,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -75831,7 +82732,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -75839,7 +82740,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -75850,7 +82751,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -75858,21 +82759,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -75880,7 +82781,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -75895,7 +82796,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -75903,7 +82804,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -75918,7 +82819,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -75926,7 +82827,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -75941,7 +82842,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -75949,7 +82850,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -75968,7 +82869,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -75976,7 +82877,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -75984,7 +82885,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -75995,7 +82896,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -76003,7 +82904,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -76022,7 +82923,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -76030,20 +83044,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -76054,17 +83068,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -76072,21 +83086,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -76094,21 +83108,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -76121,21 +83135,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -76145,7 +83159,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -76155,7 +83169,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -76165,7 +83179,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -76179,13 +83193,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -76193,7 +83207,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -76206,21 +83220,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -76230,7 +83244,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -76244,31 +83258,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -76280,13 +83317,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -76306,7 +83343,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -76314,13 +83351,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -76336,7 +83373,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -76344,13 +83381,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -76366,7 +83403,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -76374,13 +83411,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -76390,7 +83427,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -76406,7 +83443,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -76430,7 +83467,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -76438,13 +83536,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -76464,7 +83562,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -76472,13 +83570,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -76494,7 +83592,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -76502,13 +83600,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -76519,7 +83617,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -76530,7 +83628,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -76541,7 +83639,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -76562,7 +83660,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -76570,13 +83668,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -76587,17 +83685,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -76605,21 +83703,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -76627,7 +83725,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -76637,7 +83735,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -76647,7 +83745,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -76657,7 +83755,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -76665,7 +83763,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -76675,7 +83773,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -76683,7 +83781,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -76693,7 +83791,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -76701,7 +83799,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -76715,13 +83813,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -76739,7 +83837,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -76747,13 +83845,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -76768,7 +83866,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -76781,7 +83879,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -76789,13 +83887,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -76805,7 +83903,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -76826,7 +83924,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -76838,7 +83936,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -76846,29 +83982,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -76882,12 +84019,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -76897,28 +84043,30 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, - 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, + 380, 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, + 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, "children": [ - 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, + 433, 457, 454 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -76934,7 +84082,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 125, + "line": 137, "character": 2 } ], @@ -76953,7 +84101,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 132, + "line": 144, "character": 2 } ], @@ -76971,7 +84119,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 124, + "line": 136, "character": 2 } ], @@ -76981,7 +84129,7 @@ } }, { - "id": 101, + "id": 102, "name": "topic", "kind": 1024, "kindString": "Property", @@ -76994,108 +84142,7 @@ } }, { - "id": 269, - "name": "_fetchWithTimeout", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 538, - "character": 8 - } - ], - "signatures": [ - { - "id": 270, - "name": "_fetchWithTimeout", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 271, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 272, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 273, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 274, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 275, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 276, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 135, + "id": 136, "name": "on", "kind": 2048, "kindString": "Method", @@ -77109,7 +84156,7 @@ ], "signatures": [ { - "id": 136, + "id": 137, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -77119,7 +84166,7 @@ }, "parameters": [ { - "id": 137, + "id": 138, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -77130,7 +84177,7 @@ } }, { - "id": 138, + "id": 139, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -77138,14 +84185,14 @@ "type": { "type": "reflection", "declaration": { - "id": 139, + "id": 140, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 140, + "id": 141, "name": "event", "kind": 1024, "kindString": "Property", @@ -77167,14 +84214,14 @@ { "title": "Properties", "kind": 1024, - "children": [140] + "children": [141] } ] } } }, { - "id": 141, + "id": 142, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -77182,14 +84229,14 @@ "type": { "type": "reflection", "declaration": { - "id": 142, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 143, + "id": 144, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -77211,14 +84258,14 @@ } }, { - "id": 144, + "id": 145, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 148, + "id": 149, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -77226,20 +84273,20 @@ "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 146, + "id": 147, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 147, + "id": 148, "name": "key", "kind": 32768, "flags": {}, @@ -77260,7 +84307,7 @@ ], "parameters": [ { - "id": 149, + "id": 150, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -77271,7 +84318,7 @@ } }, { - "id": 150, + "id": 151, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -77279,14 +84326,14 @@ "type": { "type": "reflection", "declaration": { - "id": 151, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 153, "name": "event", "kind": 1024, "kindString": "Property", @@ -77308,14 +84355,14 @@ { "title": "Properties", "kind": 1024, - "children": [152] + "children": [153] } ] } } }, { - "id": 153, + "id": 154, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -77323,32 +84370,32 @@ "type": { "type": "reflection", "declaration": { - "id": 154, + "id": 155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 155, + "id": 156, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 156, + "id": 157, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 558, + "id": 584, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 149, "name": "T" } ], @@ -77373,14 +84420,14 @@ } }, { - "id": 157, + "id": 158, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 161, + "id": 162, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -77388,20 +84435,20 @@ "type": { "type": "reflection", "declaration": { - "id": 158, + "id": 159, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 159, + "id": 160, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 160, + "id": 161, "name": "key", "kind": 32768, "flags": {}, @@ -77422,7 +84469,7 @@ ], "parameters": [ { - "id": 162, + "id": 163, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -77433,7 +84480,7 @@ } }, { - "id": 163, + "id": 164, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -77441,14 +84488,14 @@ "type": { "type": "reflection", "declaration": { - "id": 164, + "id": 165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 165, + "id": 166, "name": "event", "kind": 1024, "kindString": "Property", @@ -77470,14 +84517,14 @@ { "title": "Properties", "kind": 1024, - "children": [165] + "children": [166] } ] } } }, { - "id": 166, + "id": 167, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -77485,32 +84532,32 @@ "type": { "type": "reflection", "declaration": { - "id": 167, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 168, + "id": 169, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 169, + "id": 170, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 568, + "id": 594, "typeArguments": [ { "type": "reference", - "id": 161, + "id": 162, "name": "T" } ], @@ -77535,14 +84582,14 @@ } }, { - "id": 170, + "id": 171, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 174, + "id": 175, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -77550,20 +84597,20 @@ "type": { "type": "reflection", "declaration": { - "id": 171, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 172, + "id": 173, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 173, + "id": 174, "name": "key", "kind": 32768, "flags": {}, @@ -77584,7 +84631,7 @@ ], "parameters": [ { - "id": 175, + "id": 176, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -77595,14 +84642,14 @@ } }, { - "id": 176, + "id": 177, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -77611,7 +84658,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -77619,13 +84666,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -77637,7 +84684,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -77649,14 +84696,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -77667,19 +84714,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -77692,7 +84739,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -77702,7 +84749,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -77713,7 +84760,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -77723,7 +84770,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -77736,7 +84783,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -77750,13 +84797,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -77766,7 +84813,7 @@ } }, { - "id": 177, + "id": 178, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -77774,32 +84821,32 @@ "type": { "type": "reflection", "declaration": { - "id": 178, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 179, + "id": 180, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 180, + "id": 181, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 524, + "id": 550, "typeArguments": [ { "type": "reference", - "id": 174, + "id": 175, "name": "T" } ], @@ -77824,14 +84871,14 @@ } }, { - "id": 181, + "id": 182, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 185, + "id": 186, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -77839,20 +84886,20 @@ "type": { "type": "reflection", "declaration": { - "id": 182, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 183, + "id": 184, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 184, + "id": 185, "name": "key", "kind": 32768, "flags": {}, @@ -77873,7 +84920,7 @@ ], "parameters": [ { - "id": 186, + "id": 187, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -77884,14 +84931,14 @@ } }, { - "id": 187, + "id": 188, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -77900,7 +84947,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -77908,13 +84955,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -77926,7 +84973,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -77938,14 +84985,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -77956,19 +85003,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -77981,7 +85028,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -77991,7 +85038,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -78002,7 +85049,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -78012,7 +85059,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -78025,7 +85072,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -78039,13 +85086,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -78055,7 +85102,7 @@ } }, { - "id": 188, + "id": 189, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -78063,32 +85110,32 @@ "type": { "type": "reflection", "declaration": { - "id": 189, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 190, + "id": 191, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 191, + "id": 192, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 529, + "id": 555, "typeArguments": [ { "type": "reference", - "id": 185, + "id": 186, "name": "T" } ], @@ -78113,14 +85160,14 @@ } }, { - "id": 192, + "id": 193, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 196, + "id": 197, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -78128,20 +85175,20 @@ "type": { "type": "reflection", "declaration": { - "id": 193, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 194, + "id": 195, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 196, "name": "key", "kind": 32768, "flags": {}, @@ -78162,7 +85209,7 @@ ], "parameters": [ { - "id": 197, + "id": 198, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -78173,14 +85220,14 @@ } }, { - "id": 198, + "id": 199, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -78189,7 +85236,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -78197,13 +85244,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -78215,7 +85262,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -78227,14 +85274,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -78245,19 +85292,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -78270,7 +85317,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -78280,7 +85327,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -78291,7 +85338,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -78301,7 +85348,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -78314,7 +85361,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -78328,13 +85375,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -78344,7 +85391,7 @@ } }, { - "id": 199, + "id": 200, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -78352,32 +85399,32 @@ "type": { "type": "reflection", "declaration": { - "id": 200, + "id": 201, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 201, + "id": 202, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 202, + "id": 203, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 539, + "id": 565, "typeArguments": [ { "type": "reference", - "id": 196, + "id": 197, "name": "T" } ], @@ -78402,14 +85449,14 @@ } }, { - "id": 203, + "id": 204, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 207, + "id": 208, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -78417,20 +85464,20 @@ "type": { "type": "reflection", "declaration": { - "id": 204, + "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 205, + "id": 206, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 206, + "id": 207, "name": "key", "kind": 32768, "flags": {}, @@ -78451,7 +85498,7 @@ ], "parameters": [ { - "id": 208, + "id": 209, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -78462,14 +85509,14 @@ } }, { - "id": 209, + "id": 210, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -78478,7 +85525,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -78486,13 +85533,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -78504,7 +85551,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -78516,14 +85563,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -78534,19 +85581,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -78559,7 +85606,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -78569,7 +85616,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -78580,7 +85627,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -78590,7 +85637,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -78603,7 +85650,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -78617,13 +85664,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -78633,7 +85680,7 @@ } }, { - "id": 210, + "id": 211, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -78641,32 +85688,32 @@ "type": { "type": "reflection", "declaration": { - "id": 211, + "id": 212, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 212, + "id": 213, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 213, + "id": 214, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 548, + "id": 574, "typeArguments": [ { "type": "reference", - "id": 207, + "id": 208, "name": "T" } ], @@ -78691,7 +85738,7 @@ } }, { - "id": 214, + "id": 215, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -78701,7 +85748,7 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -78715,7 +85762,7 @@ } }, { - "id": 216, + "id": 217, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -78726,14 +85773,14 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 218, + "id": 219, "name": "event", "kind": 1024, "kindString": "Property", @@ -78755,14 +85802,14 @@ { "title": "Properties", "kind": 1024, - "children": [218] + "children": [219] } ] } } }, { - "id": 219, + "id": 220, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -78773,21 +85820,21 @@ "type": { "type": "reflection", "declaration": { - "id": 220, + "id": 221, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 221, + "id": 222, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 222, + "id": 223, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -78795,14 +85842,14 @@ "type": { "type": "reflection", "declaration": { - "id": 223, + "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 226, "name": "event", "kind": 1024, "kindString": "Property", @@ -78820,7 +85867,7 @@ } }, { - "id": 224, + "id": 225, "name": "type", "kind": 1024, "kindString": "Property", @@ -78842,18 +85889,18 @@ { "title": "Properties", "kind": 1024, - "children": [225, 224] + "children": [226, 225] } ], "indexSignature": { - "id": 226, + "id": 227, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 227, + "id": 228, "name": "key", "kind": 32768, "flags": {}, @@ -78889,14 +85936,14 @@ } }, { - "id": 228, + "id": 229, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 232, + "id": 233, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -78904,20 +85951,20 @@ "type": { "type": "reflection", "declaration": { - "id": 229, + "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 230, + "id": 231, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 231, + "id": 232, "name": "key", "kind": 32768, "flags": {}, @@ -78938,7 +85985,7 @@ ], "parameters": [ { - "id": 233, + "id": 234, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -78949,7 +85996,7 @@ } }, { - "id": 234, + "id": 235, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -78957,14 +86004,14 @@ "type": { "type": "reflection", "declaration": { - "id": 235, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 236, + "id": 237, "name": "event", "kind": 1024, "kindString": "Property", @@ -78986,14 +86033,14 @@ { "title": "Properties", "kind": 1024, - "children": [236] + "children": [237] } ] } } }, { - "id": 237, + "id": 238, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -79001,21 +86048,21 @@ "type": { "type": "reflection", "declaration": { - "id": 238, + "id": 239, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 239, + "id": 240, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 240, + "id": 241, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -79023,14 +86070,14 @@ "type": { "type": "reflection", "declaration": { - "id": 241, + "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 243, + "id": 244, "name": "event", "kind": 1024, "kindString": "Property", @@ -79048,7 +86095,7 @@ } }, { - "id": 244, + "id": 245, "name": "payload", "kind": 1024, "kindString": "Property", @@ -79062,12 +86109,12 @@ ], "type": { "type": "reference", - "id": 232, + "id": 233, "name": "T" } }, { - "id": 242, + "id": 243, "name": "type", "kind": 1024, "kindString": "Property", @@ -79089,7 +86136,7 @@ { "title": "Properties", "kind": 1024, - "children": [243, 244, 242] + "children": [244, 245, 243] } ] } @@ -79111,11 +86158,138 @@ "id": 64, "name": "default" } + }, + { + "id": 246, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 250, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 247, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 248, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 249, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 251, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "system" + } + }, + { + "id": 252, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 253, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 254, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 255, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 256, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 257, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } } ] }, { - "id": 112, + "id": 113, "name": "presenceState", "kind": 2048, "kindString": "Method", @@ -79129,14 +86303,14 @@ ], "signatures": [ { - "id": 113, + "id": 114, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 118, + "id": 119, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -79144,20 +86318,20 @@ "type": { "type": "reflection", "declaration": { - "id": 114, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 115, + "id": 116, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 116, + "id": 117, "name": "key", "kind": 32768, "flags": {}, @@ -79177,7 +86351,7 @@ "default": { "type": "reflection", "declaration": { - "id": 117, + "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -79188,11 +86362,11 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reference", - "id": 118, + "id": 119, "name": "T" } ], @@ -79202,7 +86376,7 @@ ] }, { - "id": 245, + "id": 258, "name": "send", "kind": 2048, "kindString": "Method", @@ -79210,13 +86384,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 425, + "line": 430, "character": 8 } ], "signatures": [ { - "id": 246, + "id": 259, "name": "send", "kind": 4096, "kindString": "Call signature", @@ -79226,7 +86400,7 @@ }, "parameters": [ { - "id": 247, + "id": 260, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -79237,14 +86411,14 @@ "type": { "type": "reflection", "declaration": { - "id": 248, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 263, "name": "event", "kind": 1024, "kindString": "Property", @@ -79255,7 +86429,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 428, + "line": 433, "character": 6 } ], @@ -79265,7 +86439,7 @@ } }, { - "id": 251, + "id": 264, "name": "payload", "kind": 1024, "kindString": "Property", @@ -79278,7 +86452,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 429, + "line": 434, "character": 6 } ], @@ -79288,7 +86462,7 @@ } }, { - "id": 249, + "id": 262, "name": "type", "kind": 1024, "kindString": "Property", @@ -79299,7 +86473,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 427, + "line": 432, "character": 6 } ], @@ -79326,18 +86500,18 @@ { "title": "Properties", "kind": 1024, - "children": [250, 251, 249] + "children": [263, 264, 262] } ], "indexSignature": { - "id": 252, + "id": 265, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 253, + "id": 266, "name": "key", "kind": 32768, "flags": {}, @@ -79356,7 +86530,7 @@ } }, { - "id": 254, + "id": 267, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -79367,20 +86541,20 @@ "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 256, + "id": 269, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 257, + "id": 270, "name": "key", "kind": 32768, "flags": {}, @@ -79405,7 +86579,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -79417,7 +86591,7 @@ ] }, { - "id": 104, + "id": 105, "name": "subscribe", "kind": 2048, "kindString": "Method", @@ -79425,13 +86599,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 198, + "line": 213, "character": 2 } ], "signatures": [ { - "id": 105, + "id": 106, "name": "subscribe", "kind": 4096, "kindString": "Call signature", @@ -79441,7 +86615,7 @@ }, "parameters": [ { - "id": 106, + "id": 107, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -79451,49 +86625,33 @@ "type": { "type": "reflection", "declaration": { - "id": 107, + "id": 108, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 108, + "id": 109, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 109, + "id": 110, "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" - } - ] + "type": "reference", + "id": 628, + "name": "REALTIME_SUBSCRIBE_STATES" } }, { - "id": 110, + "id": 111, "name": "err", "kind": 32768, "kindString": "Parameter", @@ -79518,7 +86676,7 @@ } }, { - "id": 111, + "id": 112, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -79539,7 +86697,7 @@ ] }, { - "id": 119, + "id": 120, "name": "track", "kind": 2048, "kindString": "Method", @@ -79553,14 +86711,14 @@ ], "signatures": [ { - "id": 120, + "id": 121, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 121, + "id": 122, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -79568,20 +86726,20 @@ "type": { "type": "reflection", "declaration": { - "id": 122, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 123, + "id": 124, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 124, + "id": 125, "name": "key", "kind": 32768, "flags": {}, @@ -79600,7 +86758,7 @@ } }, { - "id": 125, + "id": 126, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -79608,20 +86766,20 @@ "type": { "type": "reflection", "declaration": { - "id": 126, + "id": 127, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 127, + "id": 128, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 128, + "id": 129, "name": "key", "kind": 32768, "flags": {}, @@ -79646,7 +86804,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -79658,7 +86816,7 @@ ] }, { - "id": 264, + "id": 277, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -79666,13 +86824,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 495, + "line": 507, "character": 2 } ], "signatures": [ { - "id": 265, + "id": 278, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -79683,7 +86841,7 @@ }, "parameters": [ { - "id": 266, + "id": 279, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -79724,7 +86882,7 @@ ] }, { - "id": 129, + "id": 130, "name": "untrack", "kind": 2048, "kindString": "Method", @@ -79738,14 +86896,14 @@ ], "signatures": [ { - "id": 130, + "id": 131, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 131, + "id": 132, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -79753,20 +86911,20 @@ "type": { "type": "reflection", "declaration": { - "id": 132, + "id": 133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 133, + "id": 134, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 134, + "id": 135, "name": "key", "kind": 32768, "flags": {}, @@ -79791,7 +86949,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -79803,7 +86961,7 @@ ] }, { - "id": 258, + "id": 271, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", @@ -79811,20 +86969,20 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 482, + "line": 494, "character": 2 } ], "signatures": [ { - "id": 259, + "id": 272, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 260, + "id": 273, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -79832,20 +86990,20 @@ "type": { "type": "reflection", "declaration": { - "id": 261, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 262, + "id": 275, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 263, + "id": 276, "name": "key", "kind": 32768, "flags": {}, @@ -79881,18 +87039,20 @@ { "title": "Properties", "kind": 1024, - "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] + "children": [ + 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 + ] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -80063,7 +87223,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 134, + "line": 147, "character": 2 } ], @@ -80094,10 +87254,10 @@ "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -80105,21 +87265,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -80127,21 +87287,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -80154,21 +87314,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -80178,7 +87338,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -80188,7 +87348,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -80198,7 +87358,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -80212,13 +87372,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -80226,7 +87386,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -80239,21 +87399,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -80263,7 +87423,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -80277,31 +87437,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -80313,13 +87496,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -80337,17 +87520,17 @@ "flags": {}, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -80355,13 +87538,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -80371,7 +87554,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -80385,7 +87568,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -80394,10 +87577,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -80405,21 +87588,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -80429,7 +87612,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -80441,7 +87624,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -80451,7 +87634,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -80463,7 +87646,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -80473,7 +87656,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -80483,7 +87666,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -80493,14 +87676,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -80508,19 +87691,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -80539,7 +87722,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -80549,7 +87732,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -80559,7 +87742,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -80569,7 +87752,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -80596,7 +87779,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -80606,7 +87789,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -80618,7 +87801,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -80628,14 +87811,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -80643,19 +87826,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -80674,7 +87857,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -80684,7 +87867,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -80696,7 +87879,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -80706,7 +87889,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -80716,7 +87899,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -80726,7 +87909,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -80734,6 +87917,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -80741,15 +88010,20 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, 496, 504, - 499, 494, 493 + 520, 519, 531, 522, 517, 530, 518, 526, + 521, 516, 515, 532, 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -80761,14 +88035,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -80776,7 +88050,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -80796,7 +88134,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -80804,7 +88142,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -80824,7 +88162,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -80832,7 +88170,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -80847,7 +88185,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -80855,7 +88193,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -80875,7 +88213,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -80883,7 +88221,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -80895,7 +88233,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -80903,7 +88241,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -80915,7 +88253,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -80923,7 +88261,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -80934,7 +88272,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -80942,28 +88280,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -80987,7 +88325,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -81018,14 +88356,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -81053,7 +88391,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -81088,7 +88426,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -81098,27 +88436,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -81138,7 +88476,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -81146,7 +88484,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -81157,7 +88495,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -81165,7 +88503,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -81187,7 +88525,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -81195,7 +88552,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -81208,7 +88565,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -81218,27 +88575,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -81258,7 +88615,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -81266,7 +88623,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -81286,7 +88643,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -81294,7 +88651,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -81306,7 +88663,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -81314,7 +88671,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -81324,7 +88681,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -81332,7 +88689,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -81343,7 +88700,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -81351,7 +88708,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -81367,7 +88724,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -81375,7 +88732,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -81386,7 +88743,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -81394,21 +88751,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -81416,7 +88773,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -81431,7 +88788,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -81439,7 +88796,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -81454,7 +88811,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -81462,7 +88819,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -81477,7 +88834,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -81485,7 +88842,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -81504,7 +88861,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -81512,7 +88869,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -81520,7 +88877,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -81531,7 +88888,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -81539,7 +88896,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -81558,7 +88915,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -81566,20 +89036,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -81590,17 +89060,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -81608,21 +89078,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -81630,21 +89100,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -81657,21 +89127,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -81681,7 +89151,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -81691,7 +89161,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -81701,7 +89171,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -81715,13 +89185,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -81729,7 +89199,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -81742,21 +89212,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -81766,7 +89236,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -81780,31 +89250,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -81816,13 +89309,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -81842,7 +89335,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -81850,13 +89343,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -81872,7 +89365,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -81880,13 +89373,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -81902,7 +89395,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -81910,13 +89403,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -81926,7 +89419,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -81942,7 +89435,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -81966,7 +89459,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -81974,13 +89528,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -82000,7 +89554,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -82008,13 +89562,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -82030,7 +89584,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -82038,13 +89592,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -82055,7 +89609,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -82066,7 +89620,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -82077,7 +89631,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -82098,7 +89652,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -82106,13 +89660,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -82123,17 +89677,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -82141,21 +89695,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -82163,7 +89717,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -82173,7 +89727,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -82183,7 +89737,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -82193,7 +89747,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -82201,7 +89755,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -82211,7 +89765,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -82219,7 +89773,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -82229,7 +89783,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -82237,7 +89791,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -82251,13 +89805,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -82275,7 +89829,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -82283,13 +89837,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -82304,7 +89858,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -82317,7 +89871,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -82325,13 +89879,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -82341,7 +89895,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -82362,7 +89916,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -82374,7 +89928,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -82382,29 +89974,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -82418,12 +90011,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -82433,28 +90035,30 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, - 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, + 380, 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, + 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, "children": [ - 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, + 433, 457, 454 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -82479,7 +90083,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 116, + "line": 128, "character": 2 } ], @@ -82529,7 +90133,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 120, + "line": 132, "character": 6 } ], @@ -82549,7 +90153,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 6 } ], @@ -82564,7 +90168,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 14 } ], @@ -82605,7 +90209,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 121, + "line": 133, "character": 6 } ], @@ -82623,7 +90227,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 118, + "line": 130, "character": 6 } ], @@ -82643,7 +90247,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 117, + "line": 129, "character": 19 } ] @@ -82664,7 +90268,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 143, "character": 2 } ], @@ -82682,7 +90286,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 127, + "line": 139, "character": 2 } ], @@ -82700,7 +90304,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 126, + "line": 138, "character": 2 } ], @@ -82711,7 +90315,7 @@ "defaultValue": "false" }, { - "id": 102, + "id": 103, "name": "params", "kind": 1024, "kindString": "Property", @@ -82720,10 +90324,10 @@ }, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -82731,21 +90335,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -82753,21 +90357,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -82780,21 +90384,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -82804,7 +90408,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -82814,7 +90418,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -82824,7 +90428,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -82838,13 +90442,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -82852,7 +90456,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -82865,21 +90469,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -82889,7 +90493,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -82903,31 +90507,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -82939,13 +90566,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -82964,7 +90591,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 130, + "line": 142, "character": 2 } ], @@ -83001,6 +90628,24 @@ } } }, + { + "id": 101, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 97, "name": "pushBuffer", @@ -83010,7 +90655,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 141, "character": 2 } ], @@ -83032,7 +90677,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 140, "character": 2 } ], @@ -83042,7 +90687,7 @@ } }, { - "id": 103, + "id": 104, "name": "socket", "kind": 1024, "kindString": "Property", @@ -83051,17 +90696,17 @@ }, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -83069,13 +90714,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -83085,7 +90730,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -83099,7 +90744,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -83108,10 +90753,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -83119,21 +90764,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -83143,7 +90788,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -83155,7 +90800,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -83165,7 +90810,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -83177,7 +90822,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -83187,7 +90832,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -83197,7 +90842,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -83207,14 +90852,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -83222,19 +90867,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -83253,7 +90898,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -83263,7 +90908,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -83273,7 +90918,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -83283,7 +90928,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -83310,7 +90955,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -83320,7 +90965,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -83332,7 +90977,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -83342,14 +90987,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -83357,19 +91002,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -83388,7 +91033,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -83398,7 +91043,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -83410,7 +91055,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -83420,7 +91065,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -83430,7 +91075,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -83440,7 +91085,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -83448,6 +91093,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -83455,15 +91186,20 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, 496, 504, 499, - 494, 493 + 520, 519, 531, 522, 517, 530, 518, 526, 521, + 516, 515, 532, 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -83475,14 +91211,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -83490,7 +91226,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -83510,7 +91310,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -83518,7 +91318,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -83538,7 +91338,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -83546,7 +91346,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -83561,7 +91361,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -83569,7 +91369,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -83589,7 +91389,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -83597,7 +91397,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -83609,7 +91409,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -83617,7 +91417,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -83629,7 +91429,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -83637,7 +91437,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -83648,7 +91448,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -83656,28 +91456,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -83701,7 +91501,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -83732,14 +91532,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -83767,7 +91567,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -83802,7 +91602,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -83812,27 +91612,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -83852,7 +91652,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -83860,7 +91660,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -83871,7 +91671,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -83879,7 +91679,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -83901,7 +91701,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -83909,7 +91728,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -83922,7 +91741,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -83932,27 +91751,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -83972,7 +91791,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -83980,7 +91799,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -84000,7 +91819,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -84008,7 +91827,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -84020,7 +91839,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -84028,7 +91847,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -84038,7 +91857,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -84046,7 +91865,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -84057,7 +91876,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -84065,7 +91884,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -84081,7 +91900,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -84089,7 +91908,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -84100,7 +91919,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -84108,21 +91927,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -84130,7 +91949,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -84145,7 +91964,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -84153,7 +91972,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -84168,7 +91987,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -84176,7 +91995,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -84191,7 +92010,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -84199,7 +92018,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -84218,7 +92037,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -84226,7 +92045,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -84234,7 +92053,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -84245,7 +92064,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -84253,7 +92072,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -84272,7 +92091,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -84280,20 +92212,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -84304,17 +92236,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -84322,21 +92254,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -84344,21 +92276,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -84371,21 +92303,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -84395,7 +92327,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -84405,7 +92337,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -84415,7 +92347,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -84429,13 +92361,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -84443,7 +92375,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -84456,21 +92388,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -84480,7 +92412,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -84494,31 +92426,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -84530,13 +92485,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -84556,7 +92511,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -84564,13 +92519,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -84586,7 +92541,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -84594,13 +92549,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -84616,7 +92571,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -84624,13 +92579,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -84640,7 +92595,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -84656,7 +92611,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -84680,7 +92635,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -84688,13 +92704,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -84714,7 +92730,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -84722,13 +92738,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -84744,7 +92760,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -84752,13 +92768,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -84769,7 +92785,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -84780,7 +92796,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -84791,7 +92807,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -84812,7 +92828,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -84820,13 +92836,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -84837,17 +92853,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -84855,21 +92871,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -84877,7 +92893,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -84887,7 +92903,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -84897,7 +92913,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -84907,7 +92923,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -84915,7 +92931,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -84925,7 +92941,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -84933,7 +92949,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -84943,7 +92959,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -84951,7 +92967,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -84965,13 +92981,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -84989,7 +93005,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -84997,13 +93013,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -85018,7 +93034,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -85031,7 +93047,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -85039,13 +93055,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -85055,7 +93071,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -85076,7 +93092,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -85088,7 +93104,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -85096,29 +93150,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -85132,12 +93187,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -85147,26 +93211,29 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, - 380, 386, 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, + 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, - "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] + "children": [ + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, + 457, 454 + ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -85182,7 +93249,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 125, + "line": 137, "character": 2 } ], @@ -85201,7 +93268,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 132, + "line": 144, "character": 2 } ], @@ -85219,7 +93286,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 124, + "line": 136, "character": 2 } ], @@ -85229,7 +93296,7 @@ } }, { - "id": 101, + "id": 102, "name": "topic", "kind": 1024, "kindString": "Property", @@ -85242,108 +93309,7 @@ } }, { - "id": 269, - "name": "_fetchWithTimeout", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 538, - "character": 8 - } - ], - "signatures": [ - { - "id": 270, - "name": "_fetchWithTimeout", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 271, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 272, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 273, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 274, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 275, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 276, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 135, + "id": 136, "name": "on", "kind": 2048, "kindString": "Method", @@ -85357,7 +93323,7 @@ ], "signatures": [ { - "id": 136, + "id": 137, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -85367,7 +93333,7 @@ }, "parameters": [ { - "id": 137, + "id": 138, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -85378,7 +93344,7 @@ } }, { - "id": 138, + "id": 139, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -85386,14 +93352,14 @@ "type": { "type": "reflection", "declaration": { - "id": 139, + "id": 140, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 140, + "id": 141, "name": "event", "kind": 1024, "kindString": "Property", @@ -85415,14 +93381,14 @@ { "title": "Properties", "kind": 1024, - "children": [140] + "children": [141] } ] } } }, { - "id": 141, + "id": 142, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -85430,14 +93396,14 @@ "type": { "type": "reflection", "declaration": { - "id": 142, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 143, + "id": 144, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -85459,14 +93425,14 @@ } }, { - "id": 144, + "id": 145, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 148, + "id": 149, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -85474,20 +93440,20 @@ "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 146, + "id": 147, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 147, + "id": 148, "name": "key", "kind": 32768, "flags": {}, @@ -85508,7 +93474,7 @@ ], "parameters": [ { - "id": 149, + "id": 150, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -85519,7 +93485,7 @@ } }, { - "id": 150, + "id": 151, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -85527,14 +93493,14 @@ "type": { "type": "reflection", "declaration": { - "id": 151, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 153, "name": "event", "kind": 1024, "kindString": "Property", @@ -85556,14 +93522,14 @@ { "title": "Properties", "kind": 1024, - "children": [152] + "children": [153] } ] } } }, { - "id": 153, + "id": 154, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -85571,32 +93537,32 @@ "type": { "type": "reflection", "declaration": { - "id": 154, + "id": 155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 155, + "id": 156, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 156, + "id": 157, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 558, + "id": 584, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 149, "name": "T" } ], @@ -85621,14 +93587,14 @@ } }, { - "id": 157, + "id": 158, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 161, + "id": 162, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -85636,20 +93602,20 @@ "type": { "type": "reflection", "declaration": { - "id": 158, + "id": 159, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 159, + "id": 160, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 160, + "id": 161, "name": "key", "kind": 32768, "flags": {}, @@ -85670,7 +93636,7 @@ ], "parameters": [ { - "id": 162, + "id": 163, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -85681,7 +93647,7 @@ } }, { - "id": 163, + "id": 164, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -85689,14 +93655,14 @@ "type": { "type": "reflection", "declaration": { - "id": 164, + "id": 165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 165, + "id": 166, "name": "event", "kind": 1024, "kindString": "Property", @@ -85718,14 +93684,14 @@ { "title": "Properties", "kind": 1024, - "children": [165] + "children": [166] } ] } } }, { - "id": 166, + "id": 167, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -85733,32 +93699,32 @@ "type": { "type": "reflection", "declaration": { - "id": 167, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 168, + "id": 169, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 169, + "id": 170, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 568, + "id": 594, "typeArguments": [ { "type": "reference", - "id": 161, + "id": 162, "name": "T" } ], @@ -85783,14 +93749,14 @@ } }, { - "id": 170, + "id": 171, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 174, + "id": 175, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -85798,20 +93764,20 @@ "type": { "type": "reflection", "declaration": { - "id": 171, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 172, + "id": 173, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 173, + "id": 174, "name": "key", "kind": 32768, "flags": {}, @@ -85832,7 +93798,7 @@ ], "parameters": [ { - "id": 175, + "id": 176, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -85843,14 +93809,14 @@ } }, { - "id": 176, + "id": 177, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -85859,7 +93825,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -85867,13 +93833,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -85885,7 +93851,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -85897,14 +93863,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -85915,19 +93881,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -85940,7 +93906,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -85950,7 +93916,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -85961,7 +93927,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -85971,7 +93937,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -85984,7 +93950,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -85998,13 +93964,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -86014,7 +93980,7 @@ } }, { - "id": 177, + "id": 178, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -86022,32 +93988,32 @@ "type": { "type": "reflection", "declaration": { - "id": 178, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 179, + "id": 180, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 180, + "id": 181, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 524, + "id": 550, "typeArguments": [ { "type": "reference", - "id": 174, + "id": 175, "name": "T" } ], @@ -86072,14 +94038,14 @@ } }, { - "id": 181, + "id": 182, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 185, + "id": 186, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -86087,20 +94053,20 @@ "type": { "type": "reflection", "declaration": { - "id": 182, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 183, + "id": 184, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 184, + "id": 185, "name": "key", "kind": 32768, "flags": {}, @@ -86121,7 +94087,7 @@ ], "parameters": [ { - "id": 186, + "id": 187, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -86132,14 +94098,14 @@ } }, { - "id": 187, + "id": 188, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -86148,7 +94114,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -86156,13 +94122,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -86174,7 +94140,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -86186,14 +94152,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -86204,19 +94170,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -86229,7 +94195,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -86239,7 +94205,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -86250,7 +94216,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -86260,7 +94226,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -86273,7 +94239,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -86287,13 +94253,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -86303,7 +94269,7 @@ } }, { - "id": 188, + "id": 189, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -86311,32 +94277,32 @@ "type": { "type": "reflection", "declaration": { - "id": 189, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 190, + "id": 191, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 191, + "id": 192, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 529, + "id": 555, "typeArguments": [ { "type": "reference", - "id": 185, + "id": 186, "name": "T" } ], @@ -86361,14 +94327,14 @@ } }, { - "id": 192, + "id": 193, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 196, + "id": 197, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -86376,20 +94342,20 @@ "type": { "type": "reflection", "declaration": { - "id": 193, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 194, + "id": 195, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 196, "name": "key", "kind": 32768, "flags": {}, @@ -86410,7 +94376,7 @@ ], "parameters": [ { - "id": 197, + "id": 198, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -86421,14 +94387,14 @@ } }, { - "id": 198, + "id": 199, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -86437,7 +94403,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -86445,13 +94411,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -86463,7 +94429,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -86475,14 +94441,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -86493,19 +94459,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -86518,7 +94484,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -86528,7 +94494,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -86539,7 +94505,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -86549,7 +94515,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -86562,7 +94528,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -86576,13 +94542,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -86592,7 +94558,7 @@ } }, { - "id": 199, + "id": 200, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -86600,32 +94566,32 @@ "type": { "type": "reflection", "declaration": { - "id": 200, + "id": 201, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 201, + "id": 202, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 202, + "id": 203, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 539, + "id": 565, "typeArguments": [ { "type": "reference", - "id": 196, + "id": 197, "name": "T" } ], @@ -86650,14 +94616,14 @@ } }, { - "id": 203, + "id": 204, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 207, + "id": 208, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -86665,20 +94631,20 @@ "type": { "type": "reflection", "declaration": { - "id": 204, + "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 205, + "id": 206, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 206, + "id": 207, "name": "key", "kind": 32768, "flags": {}, @@ -86699,7 +94665,7 @@ ], "parameters": [ { - "id": 208, + "id": 209, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -86710,14 +94676,14 @@ } }, { - "id": 209, + "id": 210, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -86726,7 +94692,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -86734,13 +94700,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -86752,7 +94718,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -86764,14 +94730,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -86782,19 +94748,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -86807,7 +94773,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -86817,7 +94783,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -86828,7 +94794,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -86838,7 +94804,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -86851,7 +94817,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -86865,13 +94831,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -86881,7 +94847,7 @@ } }, { - "id": 210, + "id": 211, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -86889,32 +94855,32 @@ "type": { "type": "reflection", "declaration": { - "id": 211, + "id": 212, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 212, + "id": 213, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 213, + "id": 214, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 548, + "id": 574, "typeArguments": [ { "type": "reference", - "id": 207, + "id": 208, "name": "T" } ], @@ -86939,7 +94905,7 @@ } }, { - "id": 214, + "id": 215, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -86949,7 +94915,7 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -86963,7 +94929,7 @@ } }, { - "id": 216, + "id": 217, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -86974,14 +94940,14 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 218, + "id": 219, "name": "event", "kind": 1024, "kindString": "Property", @@ -87003,14 +94969,14 @@ { "title": "Properties", "kind": 1024, - "children": [218] + "children": [219] } ] } } }, { - "id": 219, + "id": 220, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -87021,21 +94987,21 @@ "type": { "type": "reflection", "declaration": { - "id": 220, + "id": 221, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 221, + "id": 222, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 222, + "id": 223, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -87043,14 +95009,14 @@ "type": { "type": "reflection", "declaration": { - "id": 223, + "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 226, "name": "event", "kind": 1024, "kindString": "Property", @@ -87068,7 +95034,7 @@ } }, { - "id": 224, + "id": 225, "name": "type", "kind": 1024, "kindString": "Property", @@ -87090,18 +95056,18 @@ { "title": "Properties", "kind": 1024, - "children": [225, 224] + "children": [226, 225] } ], "indexSignature": { - "id": 226, + "id": 227, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 227, + "id": 228, "name": "key", "kind": 32768, "flags": {}, @@ -87137,14 +95103,14 @@ } }, { - "id": 228, + "id": 229, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 232, + "id": 233, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -87152,20 +95118,20 @@ "type": { "type": "reflection", "declaration": { - "id": 229, + "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 230, + "id": 231, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 231, + "id": 232, "name": "key", "kind": 32768, "flags": {}, @@ -87186,7 +95152,7 @@ ], "parameters": [ { - "id": 233, + "id": 234, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -87197,7 +95163,7 @@ } }, { - "id": 234, + "id": 235, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -87205,14 +95171,14 @@ "type": { "type": "reflection", "declaration": { - "id": 235, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 236, + "id": 237, "name": "event", "kind": 1024, "kindString": "Property", @@ -87234,14 +95200,14 @@ { "title": "Properties", "kind": 1024, - "children": [236] + "children": [237] } ] } } }, { - "id": 237, + "id": 238, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -87249,21 +95215,21 @@ "type": { "type": "reflection", "declaration": { - "id": 238, + "id": 239, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 239, + "id": 240, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 240, + "id": 241, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -87271,14 +95237,14 @@ "type": { "type": "reflection", "declaration": { - "id": 241, + "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 243, + "id": 244, "name": "event", "kind": 1024, "kindString": "Property", @@ -87296,7 +95262,7 @@ } }, { - "id": 244, + "id": 245, "name": "payload", "kind": 1024, "kindString": "Property", @@ -87310,12 +95276,12 @@ ], "type": { "type": "reference", - "id": 232, + "id": 233, "name": "T" } }, { - "id": 242, + "id": 243, "name": "type", "kind": 1024, "kindString": "Property", @@ -87337,7 +95303,7 @@ { "title": "Properties", "kind": 1024, - "children": [243, 244, 242] + "children": [244, 245, 243] } ] } @@ -87359,11 +95325,138 @@ "id": 64, "name": "default" } + }, + { + "id": 246, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 250, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 247, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 248, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 249, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 251, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "system" + } + }, + { + "id": 252, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 253, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 254, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 255, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 256, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 257, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } } ] }, { - "id": 112, + "id": 113, "name": "presenceState", "kind": 2048, "kindString": "Method", @@ -87377,14 +95470,14 @@ ], "signatures": [ { - "id": 113, + "id": 114, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 118, + "id": 119, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -87392,20 +95485,20 @@ "type": { "type": "reflection", "declaration": { - "id": 114, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 115, + "id": 116, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 116, + "id": 117, "name": "key", "kind": 32768, "flags": {}, @@ -87425,7 +95518,7 @@ "default": { "type": "reflection", "declaration": { - "id": 117, + "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -87436,11 +95529,11 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reference", - "id": 118, + "id": 119, "name": "T" } ], @@ -87450,7 +95543,7 @@ ] }, { - "id": 245, + "id": 258, "name": "send", "kind": 2048, "kindString": "Method", @@ -87458,13 +95551,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 425, + "line": 430, "character": 8 } ], "signatures": [ { - "id": 246, + "id": 259, "name": "send", "kind": 4096, "kindString": "Call signature", @@ -87474,7 +95567,7 @@ }, "parameters": [ { - "id": 247, + "id": 260, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -87485,14 +95578,14 @@ "type": { "type": "reflection", "declaration": { - "id": 248, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 263, "name": "event", "kind": 1024, "kindString": "Property", @@ -87503,7 +95596,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 428, + "line": 433, "character": 6 } ], @@ -87513,7 +95606,7 @@ } }, { - "id": 251, + "id": 264, "name": "payload", "kind": 1024, "kindString": "Property", @@ -87526,7 +95619,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 429, + "line": 434, "character": 6 } ], @@ -87536,7 +95629,7 @@ } }, { - "id": 249, + "id": 262, "name": "type", "kind": 1024, "kindString": "Property", @@ -87547,7 +95640,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 427, + "line": 432, "character": 6 } ], @@ -87574,18 +95667,18 @@ { "title": "Properties", "kind": 1024, - "children": [250, 251, 249] + "children": [263, 264, 262] } ], "indexSignature": { - "id": 252, + "id": 265, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 253, + "id": 266, "name": "key", "kind": 32768, "flags": {}, @@ -87604,7 +95697,7 @@ } }, { - "id": 254, + "id": 267, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -87615,20 +95708,20 @@ "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 256, + "id": 269, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 257, + "id": 270, "name": "key", "kind": 32768, "flags": {}, @@ -87653,7 +95746,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -87665,7 +95758,7 @@ ] }, { - "id": 104, + "id": 105, "name": "subscribe", "kind": 2048, "kindString": "Method", @@ -87673,13 +95766,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 198, + "line": 213, "character": 2 } ], "signatures": [ { - "id": 105, + "id": 106, "name": "subscribe", "kind": 4096, "kindString": "Call signature", @@ -87689,7 +95782,7 @@ }, "parameters": [ { - "id": 106, + "id": 107, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -87699,49 +95792,33 @@ "type": { "type": "reflection", "declaration": { - "id": 107, + "id": 108, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 108, + "id": 109, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 109, + "id": 110, "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" - } - ] + "type": "reference", + "id": 628, + "name": "REALTIME_SUBSCRIBE_STATES" } }, { - "id": 110, + "id": 111, "name": "err", "kind": 32768, "kindString": "Parameter", @@ -87766,7 +95843,7 @@ } }, { - "id": 111, + "id": 112, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -87787,7 +95864,7 @@ ] }, { - "id": 119, + "id": 120, "name": "track", "kind": 2048, "kindString": "Method", @@ -87801,14 +95878,14 @@ ], "signatures": [ { - "id": 120, + "id": 121, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 121, + "id": 122, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -87816,20 +95893,20 @@ "type": { "type": "reflection", "declaration": { - "id": 122, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 123, + "id": 124, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 124, + "id": 125, "name": "key", "kind": 32768, "flags": {}, @@ -87848,7 +95925,7 @@ } }, { - "id": 125, + "id": 126, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -87856,20 +95933,20 @@ "type": { "type": "reflection", "declaration": { - "id": 126, + "id": 127, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 127, + "id": 128, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 128, + "id": 129, "name": "key", "kind": 32768, "flags": {}, @@ -87894,7 +95971,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -87906,7 +95983,7 @@ ] }, { - "id": 264, + "id": 277, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -87914,13 +95991,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 495, + "line": 507, "character": 2 } ], "signatures": [ { - "id": 265, + "id": 278, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -87931,7 +96008,7 @@ }, "parameters": [ { - "id": 266, + "id": 279, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -87972,7 +96049,7 @@ ] }, { - "id": 129, + "id": 130, "name": "untrack", "kind": 2048, "kindString": "Method", @@ -87986,14 +96063,14 @@ ], "signatures": [ { - "id": 130, + "id": 131, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 131, + "id": 132, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -88001,20 +96078,20 @@ "type": { "type": "reflection", "declaration": { - "id": 132, + "id": 133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 133, + "id": 134, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 134, + "id": 135, "name": "key", "kind": 32768, "flags": {}, @@ -88039,7 +96116,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -88051,7 +96128,7 @@ ] }, { - "id": 258, + "id": 271, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", @@ -88059,20 +96136,20 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 482, + "line": 494, "character": 2 } ], "signatures": [ { - "id": 259, + "id": 272, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 260, + "id": 273, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -88080,20 +96157,20 @@ "type": { "type": "reflection", "declaration": { - "id": 261, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 262, + "id": 275, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 263, + "id": 276, "name": "key", "kind": 32768, "flags": {}, @@ -88129,18 +96206,18 @@ { "title": "Properties", "kind": 1024, - "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] + "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -88212,7 +96289,7 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reflection", @@ -88227,7 +96304,7 @@ ], "name": "RealtimePresenceState", "dereferenced": { - "id": 578, + "id": 604, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", @@ -88241,7 +96318,7 @@ ], "typeParameter": [ { - "id": 586, + "id": 612, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -88249,7 +96326,7 @@ "type": { "type": "reflection", "declaration": { - "id": 582, + "id": 608, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -88262,14 +96339,14 @@ } ], "indexSignature": { - "id": 583, + "id": 609, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 584, + "id": 610, "name": "key", "kind": 32768, "flags": {}, @@ -88289,7 +96366,7 @@ "default": { "type": "reflection", "declaration": { - "id": 585, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -88308,7 +96385,7 @@ "type": { "type": "reflection", "declaration": { - "id": 579, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -88321,14 +96398,14 @@ } ], "indexSignature": { - "id": 580, + "id": 606, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 581, + "id": 607, "name": "key", "kind": 32768, "flags": {}, @@ -88345,7 +96422,7 @@ "typeArguments": [ { "type": "reference", - "id": 586, + "id": 612, "name": "T" } ], @@ -88381,7 +96458,7 @@ ] }, { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -88389,21 +96466,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -88411,21 +96488,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -88438,21 +96515,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -88462,7 +96539,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -88472,7 +96549,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -88482,7 +96559,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -88496,13 +96573,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -88510,7 +96587,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -88523,21 +96600,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -88547,7 +96624,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -88561,31 +96638,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -88597,13 +96697,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -88611,7 +96711,7 @@ } }, { - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse", "kind": 4194304, "kindString": "Type alias", @@ -88619,7 +96719,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 83, + "line": 88, "character": 12 } ], @@ -88642,7 +96742,7 @@ } }, { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -88650,21 +96750,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -88674,7 +96774,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -88686,7 +96786,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -88696,7 +96796,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -88708,7 +96808,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -88718,7 +96818,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -88728,7 +96828,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -88738,14 +96838,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -88753,19 +96853,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -88784,7 +96884,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -88794,7 +96894,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -88804,7 +96904,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -88814,7 +96914,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -88841,7 +96941,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -88851,7 +96951,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -88863,7 +96963,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -88873,14 +96973,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -88888,19 +96988,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -88919,7 +97019,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -88929,7 +97029,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -88941,7 +97041,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -88951,7 +97051,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -88961,7 +97061,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -88971,7 +97071,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -88979,57 +97079,39 @@ "type": "reference", "name": "WebSocketLikeConstructor" } - } - ], - "groups": [ + }, { - "title": "Properties", - "kind": 1024, - "children": [498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 20, - "character": 36 - } - ] - } - } - }, - { - "id": 510, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 511, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 513, - "name": "event", + "id": 532, + "name": "worker", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, "character": 2 } ], @@ -89039,7 +97121,116 @@ } }, { - "id": 516, + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, 532, 533] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 29, + "character": 36 + } + ] + } + } + }, + { + "id": 536, + "name": "RealtimeMessage", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 46, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 537, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 539, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -89049,7 +97240,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -89059,7 +97250,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -89067,7 +97258,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -89077,7 +97268,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -89085,7 +97276,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -89095,7 +97286,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -89103,7 +97294,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -89117,13 +97308,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -89131,7 +97322,7 @@ } }, { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -89139,13 +97330,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -89157,7 +97348,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -89169,14 +97360,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -89187,19 +97378,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -89212,7 +97403,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -89222,7 +97413,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -89233,7 +97424,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -89243,7 +97434,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -89256,7 +97447,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -89270,13 +97461,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -89284,7 +97475,7 @@ } }, { - "id": 524, + "id": 550, "name": "RealtimePostgresChangesPayload", "kind": 4194304, "kindString": "Type alias", @@ -89292,13 +97483,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 57, + "line": 62, "character": 12 } ], "typeParameter": [ { - "id": 528, + "id": 554, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -89306,7 +97497,7 @@ "type": { "type": "reflection", "declaration": { - "id": 525, + "id": 551, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -89314,19 +97505,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 57, + "line": 62, "character": 53 } ], "indexSignature": { - "id": 526, + "id": 552, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 527, + "id": 553, "name": "key", "kind": 32768, "flags": {}, @@ -89349,7 +97540,7 @@ "type": "union", "types": [ { - "id": 529, + "id": 555, "name": "RealtimePostgresInsertPayload", "kind": 4194304, "kindString": "Type alias", @@ -89357,13 +97548,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 36, + "line": 41, "character": 12 } ], "typeParameter": [ { - "id": 538, + "id": 564, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -89371,7 +97562,7 @@ "type": { "type": "reflection", "declaration": { - "id": 535, + "id": 561, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -89379,19 +97570,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 36, + "line": 41, "character": 52 } ], "indexSignature": { - "id": 536, + "id": 562, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 537, + "id": 563, "name": "key", "kind": 32768, "flags": {}, @@ -89420,14 +97611,14 @@ { "type": "reflection", "declaration": { - "id": 530, + "id": 556, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 531, + "id": 557, "name": "eventType", "kind": 1024, "kindString": "Property", @@ -89435,7 +97626,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 38, + "line": 43, "character": 4 } ], @@ -89446,7 +97637,7 @@ [ { "type": "reference", - "id": 594, + "id": 621, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" }, "" @@ -89455,7 +97646,7 @@ } }, { - "id": 532, + "id": 558, "name": "new", "kind": 1024, "kindString": "Property", @@ -89463,151 +97654,22 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 39, + "line": 44, "character": 4 } ], "type": { "type": "reference", - "id": 538, + "id": 564, "name": "T" } }, { - "id": 533, + "id": 559, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 40, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 534, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 40, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [531, 532, 533] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 37, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 539, - "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 43, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 547, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 43, - "character": 52 - } - ], - "indexSignature": { - "id": 545, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 546, - "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": 540, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 541, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -89616,64 +97678,21 @@ } ], "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ + "type": "reflection", + "declaration": { + "id": 560, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ { - "type": "reference", - "id": 595, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "" + "fileName": "src/RealtimeChannel.ts", + "line": 45, + "character": 9 + } ] - ] - } - }, - { - "id": 542, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 46, - "character": 4 } - ], - "type": { - "type": "reference", - "id": 547, - "name": "T" - } - }, - { - "id": 543, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 547, - "name": "T" - } - ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" } } ], @@ -89681,13 +97700,13 @@ { "title": "Properties", "kind": 1024, - "children": [541, 542, 543] + "children": [557, 558, 559] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 44, + "line": 42, "character": 39 } ] @@ -89697,21 +97716,21 @@ } }, { - "id": 548, - "name": "RealtimePostgresDeletePayload", + "id": 565, + "name": "RealtimePostgresUpdatePayload", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 48, "character": 12 } ], "typeParameter": [ { - "id": 557, + "id": 573, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -89719,7 +97738,7 @@ "type": { "type": "reflection", "declaration": { - "id": 554, + "id": 570, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -89727,19 +97746,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 48, "character": 52 } ], "indexSignature": { - "id": 555, + "id": 571, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 556, + "id": 572, "name": "key", "kind": 32768, "flags": {}, @@ -89768,18 +97787,65 @@ { "type": "reflection", "declaration": { - "id": 549, + "id": 566, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 550, + "id": 567, "name": "eventType", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 50, + "character": 4 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 622, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" + }, + "" + ] + ] + } + }, + { + "id": 568, + "name": "new", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 51, + "character": 4 + } + ], + "type": { + "type": "reference", + "id": 573, + "name": "T" + } + }, + { + "id": 569, + "name": "old", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -89787,71 +97853,12 @@ "character": 4 } ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 596, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "" - ] - ] - } - }, - { - "id": 551, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 53, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 552, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 53, - "character": 9 - } - ] - } - } - }, - { - "id": 553, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 54, - "character": 4 - } - ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 557, + "id": 573, "name": "T" } ], @@ -89865,13 +97872,197 @@ { "title": "Properties", "kind": 1024, - "children": [550, 551, 553] + "children": [567, 568, 569] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 51, + "line": 49, + "character": 39 + } + ] + } + } + ] + } + }, + { + "id": 574, + "name": "RealtimePostgresDeletePayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 55, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 583, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 580, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 55, + "character": 52 + } + ], + "indexSignature": { + "id": 581, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 582, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "name": "RealtimePostgresChangesPayloadBase" + }, + { + "type": "reflection", + "declaration": { + "id": 575, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 576, + "name": "eventType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 57, + "character": 4 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 623, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" + }, + "" + ] + ] + } + }, + { + "id": 577, + "name": "new", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 58, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 578, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 58, + "character": 9 + } + ] + } + } + }, + { + "id": 579, + "name": "old", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 59, + "character": 4 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 583, + "name": "T" + } + ], + "qualifiedName": "Partial", + "package": "typescript", + "name": "Partial" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [576, 577, 579] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 56, "character": 39 } ] @@ -89884,7 +98075,7 @@ } }, { - "id": 548, + "id": 574, "name": "RealtimePostgresDeletePayload", "kind": 4194304, "kindString": "Type alias", @@ -89892,13 +98083,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 55, "character": 12 } ], "typeParameter": [ { - "id": 557, + "id": 583, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -89906,7 +98097,7 @@ "type": { "type": "reflection", "declaration": { - "id": 554, + "id": 580, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -89914,19 +98105,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 55, "character": 52 } ], "indexSignature": { - "id": 555, + "id": 581, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 556, + "id": 582, "name": "key", "kind": 32768, "flags": {}, @@ -89955,14 +98146,14 @@ { "type": "reflection", "declaration": { - "id": 549, + "id": 575, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 550, + "id": 576, "name": "eventType", "kind": 1024, "kindString": "Property", @@ -89970,7 +98161,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 52, + "line": 57, "character": 4 } ], @@ -89981,7 +98172,7 @@ [ { "type": "reference", - "id": 596, + "id": 623, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" }, "" @@ -89990,7 +98181,7 @@ } }, { - "id": 551, + "id": 577, "name": "new", "kind": 1024, "kindString": "Property", @@ -89998,14 +98189,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 53, + "line": 58, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 552, + "id": 578, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -90013,7 +98204,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 53, + "line": 58, "character": 9 } ] @@ -90021,7 +98212,7 @@ } }, { - "id": 553, + "id": 579, "name": "old", "kind": 1024, "kindString": "Property", @@ -90029,7 +98220,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 54, + "line": 59, "character": 4 } ], @@ -90038,7 +98229,7 @@ "typeArguments": [ { "type": "reference", - "id": 557, + "id": 583, "name": "T" } ], @@ -90052,13 +98243,13 @@ { "title": "Properties", "kind": 1024, - "children": [550, 551, 553] + "children": [576, 577, 579] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 51, + "line": 56, "character": 39 } ] @@ -90068,7 +98259,7 @@ } }, { - "id": 529, + "id": 555, "name": "RealtimePostgresInsertPayload", "kind": 4194304, "kindString": "Type alias", @@ -90076,13 +98267,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 36, + "line": 41, "character": 12 } ], "typeParameter": [ { - "id": 538, + "id": 564, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -90090,7 +98281,7 @@ "type": { "type": "reflection", "declaration": { - "id": 535, + "id": 561, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -90098,19 +98289,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 36, + "line": 41, "character": 52 } ], "indexSignature": { - "id": 536, + "id": 562, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 537, + "id": 563, "name": "key", "kind": 32768, "flags": {}, @@ -90139,14 +98330,14 @@ { "type": "reflection", "declaration": { - "id": 530, + "id": 556, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 531, + "id": 557, "name": "eventType", "kind": 1024, "kindString": "Property", @@ -90154,7 +98345,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 38, + "line": 43, "character": 4 } ], @@ -90165,7 +98356,7 @@ [ { "type": "reference", - "id": 594, + "id": 621, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" }, "" @@ -90174,7 +98365,7 @@ } }, { - "id": 532, + "id": 558, "name": "new", "kind": 1024, "kindString": "Property", @@ -90182,151 +98373,22 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 39, + "line": 44, "character": 4 } ], "type": { "type": "reference", - "id": 538, + "id": 564, "name": "T" } }, { - "id": 533, + "id": 559, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 40, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 534, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 40, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [531, 532, 533] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 37, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 539, - "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 43, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 547, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 43, - "character": 52 - } - ], - "indexSignature": { - "id": 545, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 546, - "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": 540, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 541, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -90334,6 +98396,135 @@ "character": 4 } ], + "type": { + "type": "reflection", + "declaration": { + "id": 560, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 45, + "character": 9 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [557, 558, 559] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 42, + "character": 39 + } + ] + } + } + ] + } + }, + { + "id": 565, + "name": "RealtimePostgresUpdatePayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 48, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 573, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 570, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 48, + "character": 52 + } + ], + "indexSignature": { + "id": 571, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 572, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "name": "RealtimePostgresChangesPayloadBase" + }, + { + "type": "reflection", + "declaration": { + "id": 566, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 567, + "name": "eventType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 50, + "character": 4 + } + ], "type": { "type": "template-literal", "head": "", @@ -90341,7 +98532,7 @@ [ { "type": "reference", - "id": 595, + "id": 622, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" }, "" @@ -90350,7 +98541,7 @@ } }, { - "id": 542, + "id": 568, "name": "new", "kind": 1024, "kindString": "Property", @@ -90358,18 +98549,18 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 46, + "line": 51, "character": 4 } ], "type": { "type": "reference", - "id": 547, + "id": 573, "name": "T" } }, { - "id": 543, + "id": 569, "name": "old", "kind": 1024, "kindString": "Property", @@ -90377,7 +98568,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 47, + "line": 52, "character": 4 } ], @@ -90386,7 +98577,7 @@ "typeArguments": [ { "type": "reference", - "id": 547, + "id": 573, "name": "T" } ], @@ -90400,13 +98591,13 @@ { "title": "Properties", "kind": 1024, - "children": [541, 542, 543] + "children": [567, 568, 569] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 44, + "line": 49, "character": 39 } ] @@ -90416,7 +98607,7 @@ } }, { - "id": 558, + "id": 584, "name": "RealtimePresenceJoinPayload", "kind": 4194304, "kindString": "Type alias", @@ -90430,7 +98621,7 @@ ], "typeParameter": [ { - "id": 567, + "id": 593, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -90438,7 +98629,7 @@ "type": { "type": "reflection", "declaration": { - "id": 564, + "id": 590, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -90451,14 +98642,14 @@ } ], "indexSignature": { - "id": 565, + "id": 591, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 566, + "id": 592, "name": "key", "kind": 32768, "flags": {}, @@ -90480,14 +98671,14 @@ "type": { "type": "reflection", "declaration": { - "id": 559, + "id": 585, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 562, + "id": 588, "name": "currentPresences", "kind": 1024, "kindString": "Property", @@ -90506,7 +98697,7 @@ "typeArguments": [ { "type": "reference", - "id": 567, + "id": 593, "name": "T" } ], @@ -90515,7 +98706,7 @@ } }, { - "id": 560, + "id": 586, "name": "event", "kind": 1024, "kindString": "Property", @@ -90534,7 +98725,7 @@ [ { "type": "reference", - "id": 599, + "id": 626, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" }, "" @@ -90543,7 +98734,7 @@ } }, { - "id": 561, + "id": 587, "name": "key", "kind": 1024, "kindString": "Property", @@ -90561,7 +98752,7 @@ } }, { - "id": 563, + "id": 589, "name": "newPresences", "kind": 1024, "kindString": "Property", @@ -90580,7 +98771,7 @@ "typeArguments": [ { "type": "reference", - "id": 567, + "id": 593, "name": "T" } ], @@ -90593,7 +98784,7 @@ { "title": "Properties", "kind": 1024, - "children": [562, 560, 561, 563] + "children": [588, 586, 587, 589] } ], "sources": [ @@ -90607,7 +98798,7 @@ } }, { - "id": 568, + "id": 594, "name": "RealtimePresenceLeavePayload", "kind": 4194304, "kindString": "Type alias", @@ -90621,7 +98812,7 @@ ], "typeParameter": [ { - "id": 577, + "id": 603, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -90629,7 +98820,7 @@ "type": { "type": "reflection", "declaration": { - "id": 574, + "id": 600, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -90642,14 +98833,14 @@ } ], "indexSignature": { - "id": 575, + "id": 601, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 576, + "id": 602, "name": "key", "kind": 32768, "flags": {}, @@ -90671,14 +98862,14 @@ "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 572, + "id": 598, "name": "currentPresences", "kind": 1024, "kindString": "Property", @@ -90697,7 +98888,7 @@ "typeArguments": [ { "type": "reference", - "id": 577, + "id": 603, "name": "T" } ], @@ -90706,7 +98897,7 @@ } }, { - "id": 570, + "id": 596, "name": "event", "kind": 1024, "kindString": "Property", @@ -90725,7 +98916,7 @@ [ { "type": "reference", - "id": 600, + "id": 627, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" }, "" @@ -90734,7 +98925,7 @@ } }, { - "id": 571, + "id": 597, "name": "key", "kind": 1024, "kindString": "Property", @@ -90752,7 +98943,7 @@ } }, { - "id": 573, + "id": 599, "name": "leftPresences", "kind": 1024, "kindString": "Property", @@ -90771,7 +98962,7 @@ "typeArguments": [ { "type": "reference", - "id": 577, + "id": 603, "name": "T" } ], @@ -90784,7 +98975,7 @@ { "title": "Properties", "kind": 1024, - "children": [572, 570, 571, 573] + "children": [598, 596, 597, 599] } ], "sources": [ @@ -90798,7 +98989,7 @@ } }, { - "id": 578, + "id": 604, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", @@ -90812,7 +99003,7 @@ ], "typeParameter": [ { - "id": 586, + "id": 612, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -90820,7 +99011,7 @@ "type": { "type": "reflection", "declaration": { - "id": 582, + "id": 608, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -90833,14 +99024,14 @@ } ], "indexSignature": { - "id": 583, + "id": 609, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 584, + "id": 610, "name": "key", "kind": 32768, "flags": {}, @@ -90860,7 +99051,7 @@ "default": { "type": "reflection", "declaration": { - "id": 585, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -90879,7 +99070,7 @@ "type": { "type": "reflection", "declaration": { - "id": 579, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -90892,14 +99083,14 @@ } ], "indexSignature": { - "id": 580, + "id": 606, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 581, + "id": 607, "name": "key", "kind": 32768, "flags": {}, @@ -90916,7 +99107,7 @@ "typeArguments": [ { "type": "reference", - "id": 586, + "id": 612, "name": "T" } ], @@ -90928,7 +99119,7 @@ } }, { - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse", "kind": 4194304, "kindString": "Type alias", @@ -90936,7 +99127,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 42, + "line": 54, "character": 12 } ], @@ -90959,7 +99150,7 @@ } }, { - "id": 606, + "id": 633, "name": "REALTIME_CHANNEL_STATES", "kind": 32, "kindString": "Variable", @@ -90969,7 +99160,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 108, + "line": 111, "character": 13 } ], @@ -90987,22 +99178,22 @@ { "title": "Enumerations", "kind": 8, - "children": [588, 592, 597, 601] + "children": [614, 619, 624, 628] }, { "title": "Classes", "kind": 128, - "children": [64, 359, 1] + "children": [64, 371, 1] }, { "title": "Type Aliases", "kind": 4194304, - "children": [347, 358, 491, 510, 517, 524, 548, 529, 539, 558, 568, 578, 587] + "children": [358, 370, 513, 536, 543, 550, 574, 555, 565, 584, 594, 604, 613] }, { "title": "Variables", "kind": 32, - "children": [606] + "children": [633] } ], "sources": [ @@ -91028,14 +99219,14 @@ "flags": {}, "children": [ { - "id": 449, + "id": 498, "name": "StorageApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 450, + "id": 499, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -91049,14 +99240,14 @@ ], "signatures": [ { - "id": 451, + "id": 500, "name": "new StorageApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 452, + "id": 501, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -91067,7 +99258,7 @@ } }, { - "id": 453, + "id": 502, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -91080,24 +99271,24 @@ ], "type": { "type": "reference", - "id": 449, + "id": 498, "name": "StorageApiError" }, "overwrites": { "type": "reference", - "id": 446, + "id": 495, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 445, + "id": 494, "name": "StorageError.constructor" } }, { - "id": 454, + "id": 503, "name": "status", "kind": 1024, "kindString": "Property", @@ -91115,7 +99306,7 @@ } }, { - "id": 455, + "id": 504, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -91129,7 +99320,7 @@ ], "signatures": [ { - "id": 456, + "id": 505, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -91137,14 +99328,14 @@ "type": { "type": "reflection", "declaration": { - "id": 457, + "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 459, + "id": 508, "name": "message", "kind": 1024, "kindString": "Property", @@ -91163,7 +99354,7 @@ "defaultValue": "..." }, { - "id": 458, + "id": 507, "name": "name", "kind": 1024, "kindString": "Property", @@ -91182,7 +99373,7 @@ "defaultValue": "..." }, { - "id": 460, + "id": 509, "name": "status", "kind": 1024, "kindString": "Property", @@ -91205,7 +99396,7 @@ { "title": "Properties", "kind": 1024, - "children": [459, 458, 460] + "children": [508, 507, 509] } ] } @@ -91218,17 +99409,17 @@ { "title": "Constructors", "kind": 512, - "children": [450] + "children": [499] }, { "title": "Properties", "kind": 1024, - "children": [454] + "children": [503] }, { "title": "Methods", "kind": 2048, - "children": [455] + "children": [504] } ], "sources": [ @@ -91241,20 +99432,20 @@ "extendedTypes": [ { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } ] }, { - "id": 304, + "id": 333, "name": "StorageClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 305, + "id": 334, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -91268,14 +99459,14 @@ ], "signatures": [ { - "id": 306, + "id": 335, "name": "new StorageClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 307, + "id": 336, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -91286,7 +99477,7 @@ } }, { - "id": 308, + "id": 337, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -91294,20 +99485,20 @@ "type": { "type": "reflection", "declaration": { - "id": 309, + "id": 338, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 310, + "id": 339, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 311, + "id": 340, "name": "key", "kind": 32768, "flags": {}, @@ -91327,7 +99518,7 @@ "defaultValue": "{}" }, { - "id": 312, + "id": 341, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -91337,21 +99528,21 @@ "type": { "type": "reflection", "declaration": { - "id": 313, + "id": 342, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 314, + "id": 343, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 315, + "id": 344, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -91364,7 +99555,7 @@ } }, { - "id": 316, + "id": 345, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -91401,7 +99592,7 @@ ], "type": { "type": "reference", - "id": 304, + "id": 333, "name": "StorageClient" }, "overwrites": { @@ -91418,7 +99609,7 @@ } }, { - "id": 347, + "id": 376, "name": "createBucket", "kind": 2048, "kindString": "Method", @@ -91432,7 +99623,7 @@ ], "signatures": [ { - "id": 348, + "id": 377, "name": "createBucket", "kind": 4096, "kindString": "Call signature", @@ -91443,7 +99634,7 @@ }, "parameters": [ { - "id": 349, + "id": 378, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -91457,7 +99648,7 @@ } }, { - "id": 350, + "id": 379, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -91465,14 +99656,14 @@ "type": { "type": "reflection", "declaration": { - "id": 351, + "id": 380, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 383, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -91507,7 +99698,7 @@ } }, { - "id": 353, + "id": 382, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -91543,7 +99734,7 @@ } }, { - "id": 352, + "id": 381, "name": "public", "kind": 1024, "kindString": "Property", @@ -91568,7 +99759,7 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353, 352] + "children": [383, 382, 381] } ] } @@ -91585,14 +99776,14 @@ { "type": "reflection", "declaration": { - "id": 355, + "id": 384, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 356, + "id": 385, "name": "data", "kind": 1024, "kindString": "Property", @@ -91609,7 +99800,7 @@ "typeArguments": [ { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" }, { @@ -91623,7 +99814,7 @@ } }, { - "id": 357, + "id": 386, "name": "error", "kind": 1024, "kindString": "Property", @@ -91645,7 +99836,7 @@ { "title": "Properties", "kind": 1024, - "children": [356, 357] + "children": [385, 386] } ] } @@ -91653,14 +99844,14 @@ { "type": "reflection", "declaration": { - "id": 358, + "id": 387, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 359, + "id": 388, "name": "data", "kind": 1024, "kindString": "Property", @@ -91678,7 +99869,7 @@ } }, { - "id": 360, + "id": 389, "name": "error", "kind": 1024, "kindString": "Property", @@ -91692,7 +99883,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -91701,7 +99892,7 @@ { "title": "Properties", "kind": 1024, - "children": [359, 360] + "children": [388, 389] } ] } @@ -91727,7 +99918,7 @@ } }, { - "id": 388, + "id": 417, "name": "deleteBucket", "kind": 2048, "kindString": "Method", @@ -91741,7 +99932,7 @@ ], "signatures": [ { - "id": 389, + "id": 418, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", @@ -91751,7 +99942,7 @@ }, "parameters": [ { - "id": 390, + "id": 419, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -91774,14 +99965,14 @@ { "type": "reflection", "declaration": { - "id": 391, + "id": 420, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 392, + "id": 421, "name": "data", "kind": 1024, "kindString": "Property", @@ -91796,14 +99987,14 @@ "type": { "type": "reflection", "declaration": { - "id": 393, + "id": 422, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 394, + "id": 423, "name": "message", "kind": 1024, "kindString": "Property", @@ -91825,14 +100016,14 @@ { "title": "Properties", "kind": 1024, - "children": [394] + "children": [423] } ] } } }, { - "id": 395, + "id": 424, "name": "error", "kind": 1024, "kindString": "Property", @@ -91854,7 +100045,7 @@ { "title": "Properties", "kind": 1024, - "children": [392, 395] + "children": [421, 424] } ] } @@ -91862,14 +100053,14 @@ { "type": "reflection", "declaration": { - "id": 396, + "id": 425, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 397, + "id": 426, "name": "data", "kind": 1024, "kindString": "Property", @@ -91887,7 +100078,7 @@ } }, { - "id": 398, + "id": 427, "name": "error", "kind": 1024, "kindString": "Property", @@ -91901,7 +100092,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -91910,7 +100101,7 @@ { "title": "Properties", "kind": 1024, - "children": [397, 398] + "children": [426, 427] } ] } @@ -91936,7 +100127,7 @@ } }, { - "id": 377, + "id": 406, "name": "emptyBucket", "kind": 2048, "kindString": "Method", @@ -91950,7 +100141,7 @@ ], "signatures": [ { - "id": 378, + "id": 407, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", @@ -91960,7 +100151,7 @@ }, "parameters": [ { - "id": 379, + "id": 408, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -91983,14 +100174,14 @@ { "type": "reflection", "declaration": { - "id": 380, + "id": 409, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 381, + "id": 410, "name": "data", "kind": 1024, "kindString": "Property", @@ -92005,14 +100196,14 @@ "type": { "type": "reflection", "declaration": { - "id": 382, + "id": 411, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 383, + "id": 412, "name": "message", "kind": 1024, "kindString": "Property", @@ -92034,14 +100225,14 @@ { "title": "Properties", "kind": 1024, - "children": [383] + "children": [412] } ] } } }, { - "id": 384, + "id": 413, "name": "error", "kind": 1024, "kindString": "Property", @@ -92063,7 +100254,7 @@ { "title": "Properties", "kind": 1024, - "children": [381, 384] + "children": [410, 413] } ] } @@ -92071,14 +100262,14 @@ { "type": "reflection", "declaration": { - "id": 385, + "id": 414, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 386, + "id": 415, "name": "data", "kind": 1024, "kindString": "Property", @@ -92096,7 +100287,7 @@ } }, { - "id": 387, + "id": 416, "name": "error", "kind": 1024, "kindString": "Property", @@ -92110,7 +100301,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -92119,7 +100310,7 @@ { "title": "Properties", "kind": 1024, - "children": [386, 387] + "children": [415, 416] } ] } @@ -92145,7 +100336,7 @@ } }, { - "id": 317, + "id": 346, "name": "from", "kind": 2048, "kindString": "Method", @@ -92159,7 +100350,7 @@ ], "signatures": [ { - "id": 318, + "id": 347, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -92169,7 +100360,7 @@ }, "parameters": [ { - "id": 319, + "id": 348, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -92192,7 +100383,7 @@ ] }, { - "id": 338, + "id": 367, "name": "getBucket", "kind": 2048, "kindString": "Method", @@ -92206,7 +100397,7 @@ ], "signatures": [ { - "id": 339, + "id": 368, "name": "getBucket", "kind": 4096, "kindString": "Call signature", @@ -92216,7 +100407,7 @@ }, "parameters": [ { - "id": 340, + "id": 369, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -92239,14 +100430,14 @@ { "type": "reflection", "declaration": { - "id": 341, + "id": 370, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 371, "name": "data", "kind": 1024, "kindString": "Property", @@ -92260,12 +100451,12 @@ ], "type": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } }, { - "id": 343, + "id": 372, "name": "error", "kind": 1024, "kindString": "Property", @@ -92287,7 +100478,7 @@ { "title": "Properties", "kind": 1024, - "children": [342, 343] + "children": [371, 372] } ] } @@ -92295,14 +100486,14 @@ { "type": "reflection", "declaration": { - "id": 344, + "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 345, + "id": 374, "name": "data", "kind": 1024, "kindString": "Property", @@ -92320,7 +100511,7 @@ } }, { - "id": 346, + "id": 375, "name": "error", "kind": 1024, "kindString": "Property", @@ -92334,7 +100525,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -92343,7 +100534,7 @@ { "title": "Properties", "kind": 1024, - "children": [345, 346] + "children": [374, 375] } ] } @@ -92369,7 +100560,7 @@ } }, { - "id": 330, + "id": 359, "name": "listBuckets", "kind": 2048, "kindString": "Method", @@ -92383,7 +100574,7 @@ ], "signatures": [ { - "id": 331, + "id": 360, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", @@ -92400,14 +100591,14 @@ { "type": "reflection", "declaration": { - "id": 332, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 333, + "id": 362, "name": "data", "kind": 1024, "kindString": "Property", @@ -92423,13 +100614,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } } }, { - "id": 334, + "id": 363, "name": "error", "kind": 1024, "kindString": "Property", @@ -92451,7 +100642,7 @@ { "title": "Properties", "kind": 1024, - "children": [333, 334] + "children": [362, 363] } ] } @@ -92459,14 +100650,14 @@ { "type": "reflection", "declaration": { - "id": 335, + "id": 364, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 336, + "id": 365, "name": "data", "kind": 1024, "kindString": "Property", @@ -92484,7 +100675,7 @@ } }, { - "id": 337, + "id": 366, "name": "error", "kind": 1024, "kindString": "Property", @@ -92498,7 +100689,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -92507,7 +100698,7 @@ { "title": "Properties", "kind": 1024, - "children": [336, 337] + "children": [365, 366] } ] } @@ -92533,7 +100724,7 @@ } }, { - "id": 361, + "id": 390, "name": "updateBucket", "kind": 2048, "kindString": "Method", @@ -92547,7 +100738,7 @@ ], "signatures": [ { - "id": 362, + "id": 391, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", @@ -92557,7 +100748,7 @@ }, "parameters": [ { - "id": 363, + "id": 392, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -92571,7 +100762,7 @@ } }, { - "id": 364, + "id": 393, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -92579,14 +100770,14 @@ "type": { "type": "reflection", "declaration": { - "id": 365, + "id": 394, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 368, + "id": 397, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -92621,7 +100812,7 @@ } }, { - "id": 367, + "id": 396, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -92657,7 +100848,7 @@ } }, { - "id": 366, + "id": 395, "name": "public", "kind": 1024, "kindString": "Property", @@ -92682,7 +100873,7 @@ { "title": "Properties", "kind": 1024, - "children": [368, 367, 366] + "children": [397, 396, 395] } ] } @@ -92698,14 +100889,14 @@ { "type": "reflection", "declaration": { - "id": 369, + "id": 398, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 370, + "id": 399, "name": "data", "kind": 1024, "kindString": "Property", @@ -92720,14 +100911,14 @@ "type": { "type": "reflection", "declaration": { - "id": 371, + "id": 400, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 372, + "id": 401, "name": "message", "kind": 1024, "kindString": "Property", @@ -92749,14 +100940,14 @@ { "title": "Properties", "kind": 1024, - "children": [372] + "children": [401] } ] } } }, { - "id": 373, + "id": 402, "name": "error", "kind": 1024, "kindString": "Property", @@ -92778,7 +100969,7 @@ { "title": "Properties", "kind": 1024, - "children": [370, 373] + "children": [399, 402] } ] } @@ -92786,14 +100977,14 @@ { "type": "reflection", "declaration": { - "id": 374, + "id": 403, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 375, + "id": 404, "name": "data", "kind": 1024, "kindString": "Property", @@ -92811,7 +101002,7 @@ } }, { - "id": 376, + "id": 405, "name": "error", "kind": 1024, "kindString": "Property", @@ -92825,7 +101016,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -92834,7 +101025,7 @@ { "title": "Properties", "kind": 1024, - "children": [375, 376] + "children": [404, 405] } ] } @@ -92864,12 +101055,12 @@ { "title": "Constructors", "kind": 512, - "children": [305] + "children": [334] }, { "title": "Methods", "kind": 2048, - "children": [347, 388, 377, 317, 338, 330, 361] + "children": [376, 417, 406, 346, 367, 359, 390] } ], "sources": [ @@ -92888,14 +101079,14 @@ ] }, { - "id": 444, + "id": 493, "name": "StorageError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 445, + "id": 494, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -92909,14 +101100,14 @@ ], "signatures": [ { - "id": 446, + "id": 495, "name": "new StorageError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 447, + "id": 496, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -92929,7 +101120,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" }, "overwrites": { @@ -92948,7 +101139,7 @@ { "title": "Constructors", "kind": 512, - "children": [445] + "children": [494] } ], "sources": [ @@ -92969,25 +101160,25 @@ "extendedBy": [ { "type": "reference", - "id": 449, + "id": 498, "name": "StorageApiError" }, { "type": "reference", - "id": 462, + "id": 511, "name": "StorageUnknownError" } ] }, { - "id": 462, + "id": 511, "name": "StorageUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 463, + "id": 512, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -93001,14 +101192,14 @@ ], "signatures": [ { - "id": 464, + "id": 513, "name": "new StorageUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 465, + "id": 514, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -93019,7 +101210,7 @@ } }, { - "id": 466, + "id": 515, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -93032,24 +101223,24 @@ ], "type": { "type": "reference", - "id": 462, + "id": 511, "name": "StorageUnknownError" }, "overwrites": { "type": "reference", - "id": 446, + "id": 495, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 445, + "id": 494, "name": "StorageError.constructor" } }, { - "id": 467, + "id": 516, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -93071,12 +101262,12 @@ { "title": "Constructors", "kind": 512, - "children": [463] + "children": [512] }, { "title": "Properties", "kind": 1024, - "children": [467] + "children": [516] } ], "sources": [ @@ -93089,20 +101280,20 @@ "extendedTypes": [ { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } ] }, { - "id": 399, + "id": 428, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 404, + "id": 433, "name": "allowed_mime_types", "kind": 1024, "kindString": "Property", @@ -93125,7 +101316,7 @@ } }, { - "id": 405, + "id": 434, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -93143,7 +101334,7 @@ } }, { - "id": 403, + "id": 432, "name": "file_size_limit", "kind": 1024, "kindString": "Property", @@ -93163,7 +101354,7 @@ } }, { - "id": 400, + "id": 429, "name": "id", "kind": 1024, "kindString": "Property", @@ -93181,7 +101372,7 @@ } }, { - "id": 401, + "id": 430, "name": "name", "kind": 1024, "kindString": "Property", @@ -93199,7 +101390,7 @@ } }, { - "id": 402, + "id": 431, "name": "owner", "kind": 1024, "kindString": "Property", @@ -93217,7 +101408,7 @@ } }, { - "id": 407, + "id": 436, "name": "public", "kind": 1024, "kindString": "Property", @@ -93235,7 +101426,7 @@ } }, { - "id": 406, + "id": 435, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -93257,7 +101448,7 @@ { "title": "Properties", "kind": 1024, - "children": [404, 405, 403, 400, 401, 402, 407, 406] + "children": [433, 434, 432, 429, 430, 431, 436, 435] } ], "sources": [ @@ -93269,14 +101460,57 @@ ] }, { - "id": 431, + "id": 471, + "name": "DestinationOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 472, + "name": "destinationBucket", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [472] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 74, + "character": 17 + } + ] + }, + { + "id": 478, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 432, + "id": 479, "name": "signal", "kind": 1024, "kindString": "Property", @@ -93289,7 +101523,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 104, "character": 2 } ], @@ -93305,26 +101539,26 @@ { "title": "Properties", "kind": 1024, - "children": [432] + "children": [479] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 100, "character": 17 } ] }, { - "id": 408, + "id": 437, "name": "FileObject", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 410, + "id": 439, "name": "bucket_id", "kind": 1024, "kindString": "Property", @@ -93342,7 +101576,7 @@ } }, { - "id": 417, + "id": 446, "name": "buckets", "kind": 1024, "kindString": "Property", @@ -93356,17 +101590,17 @@ ], "type": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket", "dereferenced": { - "id": 399, + "id": 428, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 404, + "id": 433, "name": "allowed_mime_types", "kind": 1024, "kindString": "Property", @@ -93389,7 +101623,7 @@ } }, { - "id": 405, + "id": 434, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -93407,7 +101641,7 @@ } }, { - "id": 403, + "id": 432, "name": "file_size_limit", "kind": 1024, "kindString": "Property", @@ -93427,7 +101661,7 @@ } }, { - "id": 400, + "id": 429, "name": "id", "kind": 1024, "kindString": "Property", @@ -93445,7 +101679,7 @@ } }, { - "id": 401, + "id": 430, "name": "name", "kind": 1024, "kindString": "Property", @@ -93463,7 +101697,7 @@ } }, { - "id": 402, + "id": 431, "name": "owner", "kind": 1024, "kindString": "Property", @@ -93481,7 +101715,7 @@ } }, { - "id": 407, + "id": 436, "name": "public", "kind": 1024, "kindString": "Property", @@ -93499,7 +101733,7 @@ } }, { - "id": 406, + "id": 435, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -93521,7 +101755,7 @@ { "title": "Properties", "kind": 1024, - "children": [404, 405, 403, 400, 401, 402, 407, 406] + "children": [433, 434, 432, 429, 430, 431, 436, 435] } ], "sources": [ @@ -93535,7 +101769,7 @@ } }, { - "id": 414, + "id": 443, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -93553,7 +101787,7 @@ } }, { - "id": 412, + "id": 441, "name": "id", "kind": 1024, "kindString": "Property", @@ -93571,7 +101805,7 @@ } }, { - "id": 415, + "id": 444, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", @@ -93589,7 +101823,7 @@ } }, { - "id": 416, + "id": 445, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -93619,7 +101853,7 @@ } }, { - "id": 409, + "id": 438, "name": "name", "kind": 1024, "kindString": "Property", @@ -93637,7 +101871,7 @@ } }, { - "id": 411, + "id": 440, "name": "owner", "kind": 1024, "kindString": "Property", @@ -93655,7 +101889,7 @@ } }, { - "id": 413, + "id": 442, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -93677,7 +101911,7 @@ { "title": "Properties", "kind": 1024, - "children": [410, 417, 414, 412, 415, 416, 409, 411, 413] + "children": [439, 446, 443, 441, 444, 445, 438, 440, 442] } ], "sources": [ @@ -93689,23 +101923,38 @@ ] }, { - "id": 421, - "name": "FileOptions", + "id": 447, + "name": "FileObjectV2", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 422, - "name": "cacheControl", + "id": 451, + "name": "bucket_id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 28, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 456, + "name": "cache_control", "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", @@ -93719,20 +101968,17 @@ } }, { - "id": 423, - "name": "contentType", + "id": 457, + "name": "content_type", "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": 37, + "line": 34, "character": 2 } ], @@ -93742,176 +101988,15 @@ } }, { - "id": 425, - "name": "duplex", - "kind": 1024, - "kindString": "Property", - "flags": { - "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." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 45, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 424, - "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": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [422, 423, 425, 424] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 29, - "character": 17 - } - ] - }, - { - "id": 433, - "name": "Metadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 434, - "name": "name", + "id": 453, + "name": "created_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 79, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [434] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 78, - "character": 17 - } - ] - }, - { - "id": 426, - "name": "SearchOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 427, - "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": 52, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 428, - "name": "offset", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The starting position." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "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": 67, + "line": 30, "character": 2 } ], @@ -93921,123 +102006,31 @@ } }, { - "id": 429, - "name": "sortBy", + "id": 458, + "name": "etag", "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": 62, + "line": 35, "character": 2 } ], "type": { - "type": "reference", - "id": 418, - "name": "SortBy", - "dereferenced": { - "id": 418, - "name": "SortBy", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 419, - "name": "column", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 420, - "name": "order", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 26, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [419, 420] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 24, - "character": 17 - } - ] - } + "type": "intrinsic", + "name": "string" } - } - ], - "groups": [ + }, { - "title": "Properties", - "kind": 1024, - "children": [427, 428, 430, 429] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 48, - "character": 17 - } - ] - }, - { - "id": 418, - "name": "SortBy", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 419, - "name": "column", + "id": 448, + "name": "id", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -94051,13 +102044,137 @@ } }, { - "id": 420, - "name": "order", + "id": 454, + "name": "last_accessed_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 31, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 459, + "name": "last_modified", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 36, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 460, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 450, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 27, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 455, + "name": "size", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 32, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 452, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 29, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 449, + "name": "version", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -94075,7 +102192,7 @@ { "title": "Properties", "kind": 1024, - "children": [419, 420] + "children": [451, 456, 457, 453, 458, 448, 454, 459, 460, 450, 455, 452, 449] } ], "sources": [ @@ -94087,14 +102204,482 @@ ] }, { - "id": 435, + "id": 464, + "name": "FileOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 465, + "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": 49, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 466, + "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": 53, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 468, + "name": "duplex", + "kind": 1024, + "kindString": "Property", + "flags": { + "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." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 61, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 470, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optionally add extra headers" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 469, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "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." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 467, + "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": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [465, 466, 468, 470, 469, 467] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 17 + } + ] + }, + { + "id": 480, + "name": "Metadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 481, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 109, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [481] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 17 + } + ] + }, + { + "id": 473, + "name": "SearchOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 474, + "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": 82, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 475, + "name": "offset", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The starting position." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 87, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 477, + "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": 97, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 476, + "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": 92, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 461, + "name": "SortBy", + "dereferenced": { + "id": 461, + "name": "SortBy", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 462, + "name": "column", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 463, + "name": "order", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [462, 463] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 40, + "character": 17 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [474, 475, 477, 476] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 78, + "character": 17 + } + ] + }, + { + "id": 461, + "name": "SortBy", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 462, + "name": "column", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 463, + "name": "order", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [462, 463] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 40, + "character": 17 + } + ] + }, + { + "id": 482, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 440, + "id": 487, "name": "format", "kind": 1024, "kindString": "Property", @@ -94108,7 +102693,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 110, + "line": 140, "character": 2 } ], @@ -94118,7 +102703,7 @@ } }, { - "id": 437, + "id": 484, "name": "height", "kind": 1024, "kindString": "Property", @@ -94131,7 +102716,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 90, + "line": 120, "character": 2 } ], @@ -94141,7 +102726,7 @@ } }, { - "id": 439, + "id": 486, "name": "quality", "kind": 1024, "kindString": "Property", @@ -94154,7 +102739,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 103, + "line": 133, "character": 2 } ], @@ -94164,7 +102749,7 @@ } }, { - "id": 438, + "id": 485, "name": "resize", "kind": 1024, "kindString": "Property", @@ -94177,7 +102762,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 127, "character": 2 } ], @@ -94200,7 +102785,7 @@ } }, { - "id": 436, + "id": 483, "name": "width", "kind": 1024, "kindString": "Property", @@ -94213,7 +102798,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 116, "character": 2 } ], @@ -94227,19 +102812,89 @@ { "title": "Properties", "kind": 1024, - "children": [440, 437, 439, 438, 436] + "children": [487, 484, 486, 485, 483] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 112, "character": 17 } ] }, { - "id": 441, + "id": 488, + "name": "Camelize", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 147, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 489, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "mapped", + "parameter": "K", + "parameterType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 489, + "name": "T" + } + }, + "templateType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "name": "K" + }, + "objectType": { + "type": "reference", + "id": 489, + "name": "T" + } + }, + "nameType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "K" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Extract", + "package": "typescript", + "name": "Extract" + } + ], + "name": "CamelCase" + } + } + }, + { + "id": 490, "name": "isStorageError", "kind": 64, "kindString": "Function", @@ -94253,14 +102908,14 @@ ], "signatures": [ { - "id": 442, + "id": 491, "name": "isStorageError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 443, + "id": 492, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -94277,7 +102932,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -94289,17 +102944,22 @@ { "title": "Classes", "kind": 128, - "children": [449, 304, 444, 462] + "children": [498, 333, 493, 511] }, { "title": "Interfaces", "kind": 256, - "children": [399, 431, 408, 421, 433, 426, 418, 435] + "children": [428, 471, 478, 437, 447, 464, 480, 473, 461, 482] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [488] }, { "title": "Functions", "kind": 64, - "children": [441] + "children": [490] } ], "sources": [ @@ -94670,7 +103330,7 @@ "typeArguments": [ { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" }, { @@ -94753,7 +103413,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -94952,7 +103612,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -95151,7 +103811,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -95244,7 +103904,7 @@ ], "type": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } }, @@ -95318,7 +103978,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -95397,7 +104057,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } } @@ -95472,7 +104132,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -95789,7 +104449,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -95836,7 +104496,7 @@ "extendedBy": [ { "type": "reference", - "id": 304, + "id": 333, "name": "StorageClient" } ] @@ -95880,7 +104540,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 45, + "line": 48, "character": 2 } ], @@ -96039,7 +104699,7 @@ ] }, { - "id": 207, + "id": 211, "name": "copy", "kind": 2048, "kindString": "Method", @@ -96047,13 +104707,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 338, + "line": 373, "character": 8 } ], "signatures": [ { - "id": 208, + "id": 212, "name": "copy", "kind": 4096, "kindString": "Call signature", @@ -96063,7 +104723,7 @@ }, "parameters": [ { - "id": 209, + "id": 213, "name": "fromPath", "kind": 32768, "kindString": "Parameter", @@ -96077,18 +104737,78 @@ } }, { - "id": 210, + "id": 214, "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" + "shortText": "The new file path, including the new file name. For example `folder/image-copy.png`." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 215, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The destination options.\n" + }, + "type": { + "type": "reference", + "id": 471, + "name": "DestinationOptions", + "dereferenced": { + "id": 471, + "name": "DestinationOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 472, + "name": "destinationBucket", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [472] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 74, + "character": 17 + } + ] + } + } } ], "type": { @@ -96097,94 +104817,6 @@ { "type": "union", "types": [ - { - "type": "reflection", - "declaration": { - "id": 211, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 212, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 343, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 213, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 214, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 343, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [214] - } - ] - } - } - }, - { - "id": 215, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 344, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [212, 215] - } - ] - } - }, { "type": "reflection", "declaration": { @@ -96203,7 +104835,95 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 347, + "line": 379, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 218, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 219, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 379, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [219] + } + ] + } + } + }, + { + "id": 220, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 380, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [217, 220] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 221, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 222, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 383, "character": 8 } ], @@ -96213,7 +104933,7 @@ } }, { - "id": 218, + "id": 223, "name": "error", "kind": 1024, "kindString": "Property", @@ -96221,13 +104941,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 348, + "line": 384, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -96236,7 +104956,7 @@ { "title": "Properties", "kind": 1024, - "children": [217, 218] + "children": [222, 223] } ] } @@ -96260,7 +104980,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 223, + "line": 243, "character": 8 } ], @@ -96282,12 +105002,61 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`.\n" + "shortText": "The file path, including the current file name. For example `folder/image.png`." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 170, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 171, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 172, + "name": "upsert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "If set to true, allows the file to be overwritten if it already exists.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 245, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [172] + } + ] + } + } } ], "type": { @@ -96299,14 +105068,14 @@ { "type": "reflection", "declaration": { - "id": 170, + "id": 173, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 171, + "id": 174, "name": "data", "kind": 1024, "kindString": "Property", @@ -96314,21 +105083,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, + "line": 248, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 172, + "id": 175, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 175, + "id": 178, "name": "path", "kind": 1024, "kindString": "Property", @@ -96336,7 +105105,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, + "line": 248, "character": 50 } ], @@ -96346,7 +105115,7 @@ } }, { - "id": 173, + "id": 176, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -96354,7 +105123,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, + "line": 248, "character": 16 } ], @@ -96364,7 +105133,7 @@ } }, { - "id": 174, + "id": 177, "name": "token", "kind": 1024, "kindString": "Property", @@ -96372,7 +105141,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, + "line": 248, "character": 35 } ], @@ -96386,67 +105155,12 @@ { "title": "Properties", "kind": 1024, - "children": [175, 173, 174] + "children": [178, 176, 177] } ] } } }, - { - "id": 176, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 228, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [171, 176] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 177, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 178, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 231, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, { "id": 179, "name": "error", @@ -96456,13 +105170,68 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 232, + "line": 249, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [174, 179] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 180, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 181, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 252, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 182, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 253, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -96471,7 +105240,7 @@ { "title": "Properties", "kind": 1024, - "children": [178, 179] + "children": [181, 182] } ] } @@ -96487,7 +105256,7 @@ ] }, { - "id": 219, + "id": 224, "name": "createSignedUrl", "kind": 2048, "kindString": "Method", @@ -96495,13 +105264,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 376, + "line": 417, "character": 8 } ], "signatures": [ { - "id": 220, + "id": 225, "name": "createSignedUrl", "kind": 4096, "kindString": "Call signature", @@ -96511,7 +105280,7 @@ }, "parameters": [ { - "id": 221, + "id": 226, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -96525,7 +105294,7 @@ } }, { - "id": 222, + "id": 227, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", @@ -96539,7 +105308,7 @@ } }, { - "id": 223, + "id": 228, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -96549,14 +105318,14 @@ "type": { "type": "reflection", "declaration": { - "id": 224, + "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 230, "name": "download", "kind": 1024, "kindString": "Property", @@ -96569,7 +105338,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 379, + "line": 420, "character": 16 } ], @@ -96588,7 +105357,7 @@ } }, { - "id": 226, + "id": 231, "name": "transform", "kind": 1024, "kindString": "Property", @@ -96601,23 +105370,23 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 379, + "line": 420, "character": 45 } ], "type": { "type": "reference", - "id": 435, + "id": 482, "name": "TransformOptions", "dereferenced": { - "id": 435, + "id": 482, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 440, + "id": 487, "name": "format", "kind": 1024, "kindString": "Property", @@ -96631,7 +105400,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 110, + "line": 140, "character": 2 } ], @@ -96641,7 +105410,7 @@ } }, { - "id": 437, + "id": 484, "name": "height", "kind": 1024, "kindString": "Property", @@ -96654,7 +105423,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 90, + "line": 120, "character": 2 } ], @@ -96664,7 +105433,7 @@ } }, { - "id": 439, + "id": 486, "name": "quality", "kind": 1024, "kindString": "Property", @@ -96677,7 +105446,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 103, + "line": 133, "character": 2 } ], @@ -96687,7 +105456,7 @@ } }, { - "id": 438, + "id": 485, "name": "resize", "kind": 1024, "kindString": "Property", @@ -96700,7 +105469,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 127, "character": 2 } ], @@ -96723,7 +105492,7 @@ } }, { - "id": 436, + "id": 483, "name": "width", "kind": 1024, "kindString": "Property", @@ -96736,7 +105505,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 116, "character": 2 } ], @@ -96750,13 +105519,13 @@ { "title": "Properties", "kind": 1024, - "children": [440, 437, 439, 438, 436] + "children": [487, 484, 486, 485, 483] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 112, "character": 17 } ] @@ -96768,7 +105537,7 @@ { "title": "Properties", "kind": 1024, - "children": [225, 226] + "children": [230, 231] } ] } @@ -96781,94 +105550,6 @@ { "type": "union", "types": [ - { - "type": "reflection", - "declaration": { - "id": 227, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 228, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 382, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 229, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 230, - "name": "signedUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 382, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [230] - } - ] - } - } - }, - { - "id": 231, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 383, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [228, 231] - } - ] - } - }, { "type": "reflection", "declaration": { @@ -96887,7 +105568,95 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 386, + "line": 423, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 234, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 235, + "name": "signedUrl", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 423, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [235] + } + ] + } + } + }, + { + "id": 236, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 424, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [233, 236] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 237, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 238, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 427, "character": 8 } ], @@ -96897,7 +105666,7 @@ } }, { - "id": 234, + "id": 239, "name": "error", "kind": 1024, "kindString": "Property", @@ -96905,13 +105674,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 387, + "line": 428, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -96920,7 +105689,7 @@ { "title": "Properties", "kind": 1024, - "children": [233, 234] + "children": [238, 239] } ] } @@ -96936,7 +105705,7 @@ ] }, { - "id": 235, + "id": 240, "name": "createSignedUrls", "kind": 2048, "kindString": "Method", @@ -96944,13 +105713,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 421, + "line": 462, "character": 8 } ], "signatures": [ { - "id": 236, + "id": 241, "name": "createSignedUrls", "kind": 4096, "kindString": "Call signature", @@ -96960,7 +105729,7 @@ }, "parameters": [ { - "id": 237, + "id": 242, "name": "paths", "kind": 32768, "kindString": "Parameter", @@ -96977,7 +105746,7 @@ } }, { - "id": 238, + "id": 243, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", @@ -96991,7 +105760,7 @@ } }, { - "id": 239, + "id": 244, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -97001,14 +105770,14 @@ "type": { "type": "reflection", "declaration": { - "id": 240, + "id": 245, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 241, + "id": 246, "name": "download", "kind": 1024, "kindString": "Property", @@ -97019,7 +105788,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 424, + "line": 465, "character": 16 } ], @@ -97042,7 +105811,7 @@ { "title": "Properties", "kind": 1024, - "children": [241] + "children": [246] } ] } @@ -97058,14 +105827,14 @@ { "type": "reflection", "declaration": { - "id": 242, + "id": 247, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 243, + "id": 248, "name": "data", "kind": 1024, "kindString": "Property", @@ -97073,7 +105842,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 427, + "line": 468, "character": 8 } ], @@ -97082,14 +105851,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 244, + "id": 249, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 245, + "id": 250, "name": "error", "kind": 1024, "kindString": "Property", @@ -97097,7 +105866,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 427, + "line": 468, "character": 16 } ], @@ -97116,7 +105885,7 @@ } }, { - "id": 246, + "id": 251, "name": "path", "kind": 1024, "kindString": "Property", @@ -97124,7 +105893,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 427, + "line": 468, "character": 38 } ], @@ -97143,7 +105912,7 @@ } }, { - "id": 247, + "id": 252, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -97151,7 +105920,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 427, + "line": 468, "character": 59 } ], @@ -97165,7 +105934,7 @@ { "title": "Properties", "kind": 1024, - "children": [245, 246, 247] + "children": [250, 251, 252] } ] } @@ -97173,7 +105942,7 @@ } }, { - "id": 248, + "id": 253, "name": "error", "kind": 1024, "kindString": "Property", @@ -97181,7 +105950,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 428, + "line": 469, "character": 8 } ], @@ -97195,7 +105964,7 @@ { "title": "Properties", "kind": 1024, - "children": [243, 248] + "children": [248, 253] } ] } @@ -97203,14 +105972,14 @@ { "type": "reflection", "declaration": { - "id": 249, + "id": 254, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 255, "name": "data", "kind": 1024, "kindString": "Property", @@ -97218,7 +105987,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 431, + "line": 472, "character": 8 } ], @@ -97228,7 +105997,7 @@ } }, { - "id": 251, + "id": 256, "name": "error", "kind": 1024, "kindString": "Property", @@ -97236,13 +106005,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 432, + "line": 473, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -97251,7 +106020,7 @@ { "title": "Properties", "kind": 1024, - "children": [250, 251] + "children": [255, 256] } ] } @@ -97267,7 +106036,7 @@ ] }, { - "id": 252, + "id": 257, "name": "download", "kind": 2048, "kindString": "Method", @@ -97275,13 +106044,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 470, + "line": 511, "character": 8 } ], "signatures": [ { - "id": 253, + "id": 258, "name": "download", "kind": 4096, "kindString": "Call signature", @@ -97291,7 +106060,7 @@ }, "parameters": [ { - "id": 254, + "id": 259, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -97305,7 +106074,7 @@ } }, { - "id": 255, + "id": 260, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -97315,14 +106084,14 @@ "type": { "type": "reflection", "declaration": { - "id": 256, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 257, + "id": 262, "name": "transform", "kind": 1024, "kindString": "Property", @@ -97335,23 +106104,23 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 472, + "line": 513, "character": 16 } ], "type": { "type": "reference", - "id": 435, + "id": 482, "name": "TransformOptions", "dereferenced": { - "id": 435, + "id": 482, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 440, + "id": 487, "name": "format", "kind": 1024, "kindString": "Property", @@ -97365,7 +106134,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 110, + "line": 140, "character": 2 } ], @@ -97375,7 +106144,7 @@ } }, { - "id": 437, + "id": 484, "name": "height", "kind": 1024, "kindString": "Property", @@ -97388,7 +106157,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 90, + "line": 120, "character": 2 } ], @@ -97398,7 +106167,7 @@ } }, { - "id": 439, + "id": 486, "name": "quality", "kind": 1024, "kindString": "Property", @@ -97411,7 +106180,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 103, + "line": 133, "character": 2 } ], @@ -97421,7 +106190,7 @@ } }, { - "id": 438, + "id": 485, "name": "resize", "kind": 1024, "kindString": "Property", @@ -97434,7 +106203,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 127, "character": 2 } ], @@ -97457,7 +106226,7 @@ } }, { - "id": 436, + "id": 483, "name": "width", "kind": 1024, "kindString": "Property", @@ -97470,7 +106239,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 116, "character": 2 } ], @@ -97484,13 +106253,13 @@ { "title": "Properties", "kind": 1024, - "children": [440, 437, 439, 438, 436] + "children": [487, 484, 486, 485, 483] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 112, "character": 17 } ] @@ -97502,7 +106271,7 @@ { "title": "Properties", "kind": 1024, - "children": [257] + "children": [262] } ] } @@ -97518,14 +106287,14 @@ { "type": "reflection", "declaration": { - "id": 258, + "id": 263, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 259, + "id": 264, "name": "data", "kind": 1024, "kindString": "Property", @@ -97533,7 +106302,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 475, + "line": 516, "character": 8 } ], @@ -97545,7 +106314,7 @@ } }, { - "id": 260, + "id": 265, "name": "error", "kind": 1024, "kindString": "Property", @@ -97553,7 +106322,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 476, + "line": 517, "character": 8 } ], @@ -97567,7 +106336,7 @@ { "title": "Properties", "kind": 1024, - "children": [259, 260] + "children": [264, 265] } ] } @@ -97575,14 +106344,14 @@ { "type": "reflection", "declaration": { - "id": 261, + "id": 266, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 262, + "id": 267, "name": "data", "kind": 1024, "kindString": "Property", @@ -97590,7 +106359,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 479, + "line": 520, "character": 8 } ], @@ -97600,7 +106369,7 @@ } }, { - "id": 263, + "id": 268, "name": "error", "kind": 1024, "kindString": "Property", @@ -97608,13 +106377,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 480, + "line": 521, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -97623,7 +106392,7 @@ { "title": "Properties", "kind": 1024, - "children": [262, 263] + "children": [267, 268] } ] } @@ -97639,7 +106408,173 @@ ] }, { - "id": 264, + "id": 278, + "name": "exists", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 583, + "character": 8 + } + ], + "signatures": [ + { + "id": 279, + "name": "exists", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Checks the existence of a file." + }, + "parameters": [ + { + "id": 280, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 281, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 282, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 587, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 283, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 588, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [282, 283] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 284, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 285, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 591, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 286, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 592, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 493, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [285, 286] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 287, "name": "getPublicUrl", "kind": 2048, "kindString": "Method", @@ -97647,13 +106582,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 513, + "line": 624, "character": 2 } ], "signatures": [ { - "id": 265, + "id": 288, "name": "getPublicUrl", "kind": 4096, "kindString": "Call signature", @@ -97663,7 +106598,7 @@ }, "parameters": [ { - "id": 266, + "id": 289, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -97677,7 +106612,7 @@ } }, { - "id": 267, + "id": 290, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -97687,14 +106622,14 @@ "type": { "type": "reflection", "declaration": { - "id": 268, + "id": 291, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 269, + "id": 292, "name": "download", "kind": 1024, "kindString": "Property", @@ -97707,7 +106642,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 515, + "line": 626, "character": 16 } ], @@ -97726,7 +106661,7 @@ } }, { - "id": 270, + "id": 293, "name": "transform", "kind": 1024, "kindString": "Property", @@ -97739,23 +106674,23 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 515, + "line": 626, "character": 45 } ], "type": { "type": "reference", - "id": 435, + "id": 482, "name": "TransformOptions", "dereferenced": { - "id": 435, + "id": 482, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 440, + "id": 487, "name": "format", "kind": 1024, "kindString": "Property", @@ -97769,7 +106704,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 110, + "line": 140, "character": 2 } ], @@ -97779,7 +106714,7 @@ } }, { - "id": 437, + "id": 484, "name": "height", "kind": 1024, "kindString": "Property", @@ -97792,7 +106727,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 90, + "line": 120, "character": 2 } ], @@ -97802,7 +106737,7 @@ } }, { - "id": 439, + "id": 486, "name": "quality", "kind": 1024, "kindString": "Property", @@ -97815,7 +106750,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 103, + "line": 133, "character": 2 } ], @@ -97825,7 +106760,7 @@ } }, { - "id": 438, + "id": 485, "name": "resize", "kind": 1024, "kindString": "Property", @@ -97838,7 +106773,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 127, "character": 2 } ], @@ -97861,7 +106796,7 @@ } }, { - "id": 436, + "id": 483, "name": "width", "kind": 1024, "kindString": "Property", @@ -97874,7 +106809,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 116, "character": 2 } ], @@ -97888,13 +106823,13 @@ { "title": "Properties", "kind": 1024, - "children": [440, 437, 439, 438, 436] + "children": [487, 484, 486, 485, 483] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 112, "character": 17 } ] @@ -97906,7 +106841,7 @@ { "title": "Properties", "kind": 1024, - "children": [269, 270] + "children": [292, 293] } ] } @@ -97916,14 +106851,14 @@ "type": { "type": "reflection", "declaration": { - "id": 271, + "id": 294, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 272, + "id": 295, "name": "data", "kind": 1024, "kindString": "Property", @@ -97931,21 +106866,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 516, + "line": 627, "character": 7 } ], "type": { "type": "reflection", "declaration": { - "id": 273, + "id": 296, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 274, + "id": 297, "name": "publicUrl", "kind": 1024, "kindString": "Property", @@ -97953,7 +106888,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 516, + "line": 627, "character": 15 } ], @@ -97967,7 +106902,7 @@ { "title": "Properties", "kind": 1024, - "children": [274] + "children": [297] } ] } @@ -97978,7 +106913,7 @@ { "title": "Properties", "kind": 1024, - "children": [272] + "children": [295] } ] } @@ -97987,7 +106922,181 @@ ] }, { - "id": 284, + "id": 269, + "name": "info", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 550, + "character": 8 + } + ], + "signatures": [ + { + "id": 270, + "name": "info", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves the details of an existing file." + }, + "parameters": [ + { + "id": 271, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 272, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 273, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 554, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 488, + "typeArguments": [ + { + "type": "reference", + "id": 447, + "name": "FileObjectV2" + } + ], + "name": "Camelize" + } + }, + { + "id": 274, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 555, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [273, 274] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 275, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 276, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 558, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 277, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 559, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 493, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [276, 277] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 307, "name": "list", "kind": 2048, "kindString": "Method", @@ -97995,13 +107104,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 647, + "line": 758, "character": 8 } ], "signatures": [ { - "id": 285, + "id": 308, "name": "list", "kind": 4096, "kindString": "Call signature", @@ -98011,7 +107120,7 @@ }, "parameters": [ { - "id": 286, + "id": 309, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -98027,7 +107136,7 @@ } }, { - "id": 287, + "id": 310, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -98036,17 +107145,17 @@ }, "type": { "type": "reference", - "id": 426, + "id": 473, "name": "SearchOptions", "dereferenced": { - "id": 426, + "id": 473, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 427, + "id": 474, "name": "limit", "kind": 1024, "kindString": "Property", @@ -98059,7 +107168,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 52, + "line": 82, "character": 2 } ], @@ -98069,7 +107178,7 @@ } }, { - "id": 428, + "id": 475, "name": "offset", "kind": 1024, "kindString": "Property", @@ -98082,7 +107191,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 57, + "line": 87, "character": 2 } ], @@ -98092,7 +107201,7 @@ } }, { - "id": 430, + "id": 477, "name": "search", "kind": 1024, "kindString": "Property", @@ -98105,7 +107214,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 67, + "line": 97, "character": 2 } ], @@ -98115,7 +107224,7 @@ } }, { - "id": 429, + "id": 476, "name": "sortBy", "kind": 1024, "kindString": "Property", @@ -98128,23 +107237,23 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 62, + "line": 92, "character": 2 } ], "type": { "type": "reference", - "id": 418, + "id": 461, "name": "SortBy", "dereferenced": { - "id": 418, + "id": 461, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 419, + "id": 462, "name": "column", "kind": 1024, "kindString": "Property", @@ -98154,7 +107263,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 25, + "line": 41, "character": 2 } ], @@ -98164,7 +107273,7 @@ } }, { - "id": 420, + "id": 463, "name": "order", "kind": 1024, "kindString": "Property", @@ -98174,7 +107283,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 26, + "line": 42, "character": 2 } ], @@ -98188,13 +107297,13 @@ { "title": "Properties", "kind": 1024, - "children": [419, 420] + "children": [462, 463] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 24, + "line": 40, "character": 17 } ] @@ -98206,13 +107315,13 @@ { "title": "Properties", "kind": 1024, - "children": [427, 428, 430, 429] + "children": [474, 475, 477, 476] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 78, "character": 17 } ] @@ -98220,7 +107329,7 @@ } }, { - "id": 288, + "id": 311, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -98229,17 +107338,17 @@ }, "type": { "type": "reference", - "id": 431, + "id": 478, "name": "FetchParameters", "dereferenced": { - "id": 431, + "id": 478, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 432, + "id": 479, "name": "signal", "kind": 1024, "kindString": "Property", @@ -98252,7 +107361,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 104, "character": 2 } ], @@ -98268,13 +107377,13 @@ { "title": "Properties", "kind": 1024, - "children": [432] + "children": [479] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 100, "character": 17 } ] @@ -98291,14 +107400,14 @@ { "type": "reflection", "declaration": { - "id": 289, + "id": 312, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 290, + "id": 313, "name": "data", "kind": 1024, "kindString": "Property", @@ -98306,7 +107415,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 653, + "line": 764, "character": 8 } ], @@ -98314,13 +107423,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 408, + "id": 437, "name": "FileObject" } } }, { - "id": 291, + "id": 314, "name": "error", "kind": 1024, "kindString": "Property", @@ -98328,7 +107437,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 654, + "line": 765, "character": 8 } ], @@ -98342,7 +107451,7 @@ { "title": "Properties", "kind": 1024, - "children": [290, 291] + "children": [313, 314] } ] } @@ -98350,14 +107459,14 @@ { "type": "reflection", "declaration": { - "id": 292, + "id": 315, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 293, + "id": 316, "name": "data", "kind": 1024, "kindString": "Property", @@ -98365,7 +107474,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 657, + "line": 768, "character": 8 } ], @@ -98375,7 +107484,7 @@ } }, { - "id": 294, + "id": 317, "name": "error", "kind": 1024, "kindString": "Property", @@ -98383,13 +107492,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 658, + "line": 769, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -98398,7 +107507,7 @@ { "title": "Properties", "kind": 1024, - "children": [293, 294] + "children": [316, 317] } ] } @@ -98414,7 +107523,7 @@ ] }, { - "id": 195, + "id": 198, "name": "move", "kind": 2048, "kindString": "Method", @@ -98422,13 +107531,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 302, + "line": 330, "character": 8 } ], "signatures": [ { - "id": 196, + "id": 199, "name": "move", "kind": 4096, "kindString": "Call signature", @@ -98438,7 +107547,7 @@ }, "parameters": [ { - "id": 197, + "id": 200, "name": "fromPath", "kind": 32768, "kindString": "Parameter", @@ -98452,18 +107561,78 @@ } }, { - "id": 198, + "id": 201, "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" + "shortText": "The new file path, including the new file name. For example `folder/image-new.png`." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 202, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The destination options.\n" + }, + "type": { + "type": "reference", + "id": 471, + "name": "DestinationOptions", + "dereferenced": { + "id": 471, + "name": "DestinationOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 472, + "name": "destinationBucket", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [472] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 74, + "character": 17 + } + ] + } + } } ], "type": { @@ -98475,14 +107644,14 @@ { "type": "reflection", "declaration": { - "id": 199, + "id": 203, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 200, + "id": 204, "name": "data", "kind": 1024, "kindString": "Property", @@ -98490,21 +107659,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 307, + "line": 336, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 201, + "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 202, + "id": 206, "name": "message", "kind": 1024, "kindString": "Property", @@ -98512,7 +107681,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 307, + "line": 336, "character": 16 } ], @@ -98526,14 +107695,14 @@ { "title": "Properties", "kind": 1024, - "children": [202] + "children": [206] } ] } } }, { - "id": 203, + "id": 207, "name": "error", "kind": 1024, "kindString": "Property", @@ -98541,7 +107710,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 308, + "line": 337, "character": 8 } ], @@ -98555,7 +107724,7 @@ { "title": "Properties", "kind": 1024, - "children": [200, 203] + "children": [204, 207] } ] } @@ -98563,14 +107732,14 @@ { "type": "reflection", "declaration": { - "id": 204, + "id": 208, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 205, + "id": 209, "name": "data", "kind": 1024, "kindString": "Property", @@ -98578,7 +107747,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 311, + "line": 340, "character": 8 } ], @@ -98588,7 +107757,7 @@ } }, { - "id": 206, + "id": 210, "name": "error", "kind": 1024, "kindString": "Property", @@ -98596,13 +107765,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 312, + "line": 341, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -98611,7 +107780,7 @@ { "title": "Properties", "kind": 1024, - "children": [205, 206] + "children": [209, 210] } ] } @@ -98627,7 +107796,7 @@ ] }, { - "id": 275, + "id": 298, "name": "remove", "kind": 2048, "kindString": "Method", @@ -98635,13 +107804,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 551, + "line": 662, "character": 8 } ], "signatures": [ { - "id": 276, + "id": 299, "name": "remove", "kind": 4096, "kindString": "Call signature", @@ -98651,7 +107820,7 @@ }, "parameters": [ { - "id": 277, + "id": 300, "name": "paths", "kind": 32768, "kindString": "Parameter", @@ -98677,14 +107846,14 @@ { "type": "reflection", "declaration": { - "id": 278, + "id": 301, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 279, + "id": 302, "name": "data", "kind": 1024, "kindString": "Property", @@ -98692,7 +107861,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 555, + "line": 666, "character": 8 } ], @@ -98700,13 +107869,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 408, + "id": 437, "name": "FileObject" } } }, { - "id": 280, + "id": 303, "name": "error", "kind": 1024, "kindString": "Property", @@ -98714,7 +107883,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 556, + "line": 667, "character": 8 } ], @@ -98728,7 +107897,7 @@ { "title": "Properties", "kind": 1024, - "children": [279, 280] + "children": [302, 303] } ] } @@ -98736,14 +107905,14 @@ { "type": "reflection", "declaration": { - "id": 281, + "id": 304, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 282, + "id": 305, "name": "data", "kind": 1024, "kindString": "Property", @@ -98751,7 +107920,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 559, + "line": 670, "character": 8 } ], @@ -98761,7 +107930,7 @@ } }, { - "id": 283, + "id": 306, "name": "error", "kind": 1024, "kindString": "Property", @@ -98769,13 +107938,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 560, + "line": 671, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -98784,7 +107953,7 @@ { "title": "Properties", "kind": 1024, - "children": [282, 283] + "children": [305, 306] } ] } @@ -98800,7 +107969,47 @@ ] }, { - "id": 180, + "id": 321, + "name": "toBase64", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 795, + "character": 2 + } + ], + "signatures": [ + { + "id": 322, + "name": "toBase64", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 323, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 183, "name": "update", "kind": 2048, "kindString": "Method", @@ -98808,13 +108017,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 269, + "line": 296, "character": 8 } ], "signatures": [ { - "id": 181, + "id": 184, "name": "update", "kind": 4096, "kindString": "Call signature", @@ -98824,7 +108033,7 @@ }, "parameters": [ { - "id": 182, + "id": 185, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -98838,7 +108047,7 @@ } }, { - "id": 183, + "id": 186, "name": "fileBody", "kind": 32768, "kindString": "Parameter", @@ -98919,7 +108128,7 @@ } }, { - "id": 184, + "id": 187, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", @@ -98928,17 +108137,17 @@ }, "type": { "type": "reference", - "id": 421, + "id": 464, "name": "FileOptions", "dereferenced": { - "id": 421, + "id": 464, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 422, + "id": 465, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -98951,7 +108160,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 33, + "line": 49, "character": 2 } ], @@ -98961,7 +108170,7 @@ } }, { - "id": 423, + "id": 466, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -98974,7 +108183,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 37, + "line": 53, "character": 2 } ], @@ -98984,7 +108193,7 @@ } }, { - "id": 425, + "id": 468, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -98997,7 +108206,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 45, + "line": 61, "character": 2 } ], @@ -99007,7 +108216,77 @@ } }, { - "id": 424, + "id": 470, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optionally add extra headers" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 469, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "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." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 467, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -99020,7 +108299,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 41, + "line": 57, "character": 2 } ], @@ -99034,13 +108313,13 @@ { "title": "Properties", "kind": 1024, - "children": [422, 423, 425, 424] + "children": [465, 466, 468, 470, 469, 467] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 29, + "line": 45, "character": 17 } ] @@ -99057,14 +108336,14 @@ { "type": "reflection", "declaration": { - "id": 185, + "id": 188, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 186, + "id": 189, "name": "data", "kind": 1024, "kindString": "Property", @@ -99072,21 +108351,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 285, + "line": 312, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 187, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 190, + "id": 193, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -99094,7 +108373,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 285, + "line": 312, "character": 42 } ], @@ -99104,7 +108383,7 @@ } }, { - "id": 188, + "id": 191, "name": "id", "kind": 1024, "kindString": "Property", @@ -99112,7 +108391,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 285, + "line": 312, "character": 16 } ], @@ -99122,7 +108401,7 @@ } }, { - "id": 189, + "id": 192, "name": "path", "kind": 1024, "kindString": "Property", @@ -99130,7 +108409,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 285, + "line": 312, "character": 28 } ], @@ -99144,67 +108423,12 @@ { "title": "Properties", "kind": 1024, - "children": [190, 188, 189] + "children": [193, 191, 192] } ] } } }, - { - "id": 191, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 286, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [186, 191] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 192, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 193, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 289, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, { "id": 194, "name": "error", @@ -99214,13 +108438,68 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 290, + "line": 313, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [189, 194] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 195, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 196, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 316, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 197, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 317, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -99229,7 +108508,7 @@ { "title": "Properties", "kind": 1024, - "children": [193, 194] + "children": [196, 197] } ] } @@ -99253,7 +108532,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 135, + "line": 154, "character": 8 } ], @@ -99306,17 +108585,17 @@ }, "type": { "type": "reference", - "id": 421, + "id": 464, "name": "FileOptions", "dereferenced": { - "id": 421, + "id": 464, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 422, + "id": 465, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -99329,7 +108608,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 33, + "line": 49, "character": 2 } ], @@ -99339,7 +108618,7 @@ } }, { - "id": 423, + "id": 466, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -99352,7 +108631,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 37, + "line": 53, "character": 2 } ], @@ -99362,7 +108641,7 @@ } }, { - "id": 425, + "id": 468, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -99375,7 +108654,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 45, + "line": 61, "character": 2 } ], @@ -99385,7 +108664,77 @@ } }, { - "id": 424, + "id": 470, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optionally add extra headers" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 469, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "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." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 467, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -99398,7 +108747,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 41, + "line": 57, "character": 2 } ], @@ -99412,13 +108761,13 @@ { "title": "Properties", "kind": 1024, - "children": [422, 423, 425, 424] + "children": [465, 466, 468, 470, 469, 467] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 29, + "line": 45, "character": 17 } ] @@ -99450,7 +108799,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 160, "character": 8 } ], @@ -99472,7 +108821,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 160, "character": 42 } ], @@ -99490,7 +108839,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 160, "character": 16 } ], @@ -99508,7 +108857,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 160, "character": 28 } ], @@ -99537,7 +108886,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 142, + "line": 161, "character": 8 } ], @@ -99574,7 +108923,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 145, + "line": 164, "character": 8 } ], @@ -99592,13 +108941,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 146, + "line": 165, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -99631,7 +108980,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 158, + "line": 177, "character": 8 } ], @@ -99698,17 +109047,17 @@ }, "type": { "type": "reference", - "id": 421, + "id": 464, "name": "FileOptions", "dereferenced": { - "id": 421, + "id": 464, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 422, + "id": 465, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -99721,7 +109070,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 33, + "line": 49, "character": 2 } ], @@ -99731,7 +109080,7 @@ } }, { - "id": 423, + "id": 466, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -99744,7 +109093,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 37, + "line": 53, "character": 2 } ], @@ -99754,7 +109103,7 @@ } }, { - "id": 425, + "id": 468, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -99767,7 +109116,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 45, + "line": 61, "character": 2 } ], @@ -99777,7 +109126,77 @@ } }, { - "id": 424, + "id": 470, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optionally add extra headers" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 469, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "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." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 467, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -99790,7 +109209,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 41, + "line": 57, "character": 2 } ], @@ -99804,13 +109223,13 @@ { "title": "Properties", "kind": 1024, - "children": [422, 423, 425, 424] + "children": [465, 466, 468, 470, 469, 467] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 29, + "line": 45, "character": 17 } ] @@ -99842,7 +109261,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 201, + "line": 220, "character": 10 } ], @@ -99864,7 +109283,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 201, + "line": 220, "character": 35 } ], @@ -99883,7 +109302,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 201, + "line": 220, "character": 18 } ], @@ -99914,7 +109333,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 202, + "line": 221, "character": 10 } ], @@ -99952,7 +109371,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 206, + "line": 225, "character": 17 } ], @@ -100003,13 +109422,15 @@ { "title": "Methods", "kind": 2048, - "children": [207, 167, 219, 235, 252, 264, 284, 195, 275, 180, 137, 152] + "children": [ + 211, 167, 224, 240, 257, 278, 287, 269, 307, 198, 298, 321, 183, 137, 152 + ] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 39, + "line": 42, "character": 21 } ] @@ -100048,14 +109469,14 @@ "originalName": "", "children": [ { - "id": 63, + "id": 67, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 64, + "id": 68, "name": "Any", "kind": 16, "kindString": "Enumeration Member", @@ -100074,7 +109495,7 @@ "defaultValue": "\"any\"" }, { - "id": 65, + "id": 69, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", @@ -100093,7 +109514,7 @@ "defaultValue": "\"ap-northeast-1\"" }, { - "id": 66, + "id": 70, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", @@ -100112,7 +109533,7 @@ "defaultValue": "\"ap-northeast-2\"" }, { - "id": 67, + "id": 71, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", @@ -100131,7 +109552,7 @@ "defaultValue": "\"ap-south-1\"" }, { - "id": 68, + "id": 72, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", @@ -100150,7 +109571,7 @@ "defaultValue": "\"ap-southeast-1\"" }, { - "id": 69, + "id": 73, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", @@ -100169,7 +109590,7 @@ "defaultValue": "\"ap-southeast-2\"" }, { - "id": 70, + "id": 74, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -100188,7 +109609,7 @@ "defaultValue": "\"ca-central-1\"" }, { - "id": 71, + "id": 75, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -100207,7 +109628,7 @@ "defaultValue": "\"eu-central-1\"" }, { - "id": 72, + "id": 76, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", @@ -100226,7 +109647,7 @@ "defaultValue": "\"eu-west-1\"" }, { - "id": 73, + "id": 77, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", @@ -100245,7 +109666,7 @@ "defaultValue": "\"eu-west-2\"" }, { - "id": 74, + "id": 78, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", @@ -100264,7 +109685,7 @@ "defaultValue": "\"eu-west-3\"" }, { - "id": 75, + "id": 79, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", @@ -100283,7 +109704,7 @@ "defaultValue": "\"sa-east-1\"" }, { - "id": 76, + "id": 80, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", @@ -100302,7 +109723,7 @@ "defaultValue": "\"us-east-1\"" }, { - "id": 77, + "id": 81, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", @@ -100321,7 +109742,7 @@ "defaultValue": "\"us-west-1\"" }, { - "id": 78, + "id": 82, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", @@ -100344,7 +109765,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78] + "children": [68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82] } ], "sources": [ @@ -100494,6 +109915,72 @@ "package": "typescript", "name": "Promise" } + }, + { + "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": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "qualifiedName": "Request", + "package": "typescript", + "name": "Request" + }, + { + "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" + } } ] } @@ -100532,7 +110019,7 @@ } }, { - "id": 13, + "id": 16, "name": "region", "kind": 1024, "kindString": "Property", @@ -100548,17 +110035,17 @@ ], "type": { "type": "reference", - "id": 63, + "id": 67, "name": "FunctionRegion", "dereferenced": { - "id": 63, + "id": 67, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 64, + "id": 68, "name": "Any", "kind": 16, "kindString": "Enumeration Member", @@ -100577,7 +110064,7 @@ "defaultValue": "\"any\"" }, { - "id": 65, + "id": 69, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", @@ -100596,7 +110083,7 @@ "defaultValue": "\"ap-northeast-1\"" }, { - "id": 66, + "id": 70, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", @@ -100615,7 +110102,7 @@ "defaultValue": "\"ap-northeast-2\"" }, { - "id": 67, + "id": 71, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", @@ -100634,7 +110121,7 @@ "defaultValue": "\"ap-south-1\"" }, { - "id": 68, + "id": 72, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", @@ -100653,7 +110140,7 @@ "defaultValue": "\"ap-southeast-1\"" }, { - "id": 69, + "id": 73, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", @@ -100672,7 +110159,7 @@ "defaultValue": "\"ap-southeast-2\"" }, { - "id": 70, + "id": 74, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -100691,7 +110178,7 @@ "defaultValue": "\"ca-central-1\"" }, { - "id": 71, + "id": 75, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -100710,7 +110197,7 @@ "defaultValue": "\"eu-central-1\"" }, { - "id": 72, + "id": 76, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", @@ -100729,7 +110216,7 @@ "defaultValue": "\"eu-west-1\"" }, { - "id": 73, + "id": 77, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", @@ -100748,7 +110235,7 @@ "defaultValue": "\"eu-west-2\"" }, { - "id": 74, + "id": 78, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", @@ -100767,7 +110254,7 @@ "defaultValue": "\"eu-west-3\"" }, { - "id": 75, + "id": 79, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", @@ -100786,7 +110273,7 @@ "defaultValue": "\"sa-east-1\"" }, { - "id": 76, + "id": 80, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", @@ -100805,7 +110292,7 @@ "defaultValue": "\"us-east-1\"" }, { - "id": 77, + "id": 81, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", @@ -100824,7 +110311,7 @@ "defaultValue": "\"us-west-1\"" }, { - "id": 78, + "id": 82, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", @@ -100848,7 +110335,7 @@ "title": "Enumeration Members", "kind": 16, "children": [ - 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78 + 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82 ] } ], @@ -100867,7 +110354,7 @@ { "title": "Properties", "kind": 1024, - "children": [8, 7, 13] + "children": [8, 7, 16] } ] } @@ -100884,7 +110371,7 @@ ] }, { - "id": 17, + "id": 20, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -100901,21 +110388,21 @@ "type": { "type": "reflection", "declaration": { - "id": 18, + "id": 21, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 19, + "id": 22, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 20, + "id": 23, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -100939,7 +110426,73 @@ } }, { - "id": 21, + "id": 24, + "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": 25, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 26, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "qualifiedName": "Request", + "package": "typescript", + "name": "Request" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 27, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -100974,7 +110527,7 @@ } }, { - "id": 15, + "id": 18, "name": "headers", "kind": 1024, "kindString": "Property", @@ -101006,7 +110559,7 @@ } }, { - "id": 16, + "id": 19, "name": "region", "kind": 1024, "kindString": "Property", @@ -101022,17 +110575,17 @@ ], "type": { "type": "reference", - "id": 63, + "id": 67, "name": "FunctionRegion", "dereferenced": { - "id": 63, + "id": 67, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 64, + "id": 68, "name": "Any", "kind": 16, "kindString": "Enumeration Member", @@ -101051,7 +110604,7 @@ "defaultValue": "\"any\"" }, { - "id": 65, + "id": 69, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", @@ -101070,7 +110623,7 @@ "defaultValue": "\"ap-northeast-1\"" }, { - "id": 66, + "id": 70, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", @@ -101089,7 +110642,7 @@ "defaultValue": "\"ap-northeast-2\"" }, { - "id": 67, + "id": 71, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", @@ -101108,7 +110661,7 @@ "defaultValue": "\"ap-south-1\"" }, { - "id": 68, + "id": 72, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", @@ -101127,7 +110680,7 @@ "defaultValue": "\"ap-southeast-1\"" }, { - "id": 69, + "id": 73, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", @@ -101146,7 +110699,7 @@ "defaultValue": "\"ap-southeast-2\"" }, { - "id": 70, + "id": 74, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -101165,7 +110718,7 @@ "defaultValue": "\"ca-central-1\"" }, { - "id": 71, + "id": 75, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -101184,7 +110737,7 @@ "defaultValue": "\"eu-central-1\"" }, { - "id": 72, + "id": 76, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", @@ -101203,7 +110756,7 @@ "defaultValue": "\"eu-west-1\"" }, { - "id": 73, + "id": 77, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", @@ -101222,7 +110775,7 @@ "defaultValue": "\"eu-west-2\"" }, { - "id": 74, + "id": 78, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", @@ -101241,7 +110794,7 @@ "defaultValue": "\"eu-west-3\"" }, { - "id": 75, + "id": 79, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", @@ -101260,7 +110813,7 @@ "defaultValue": "\"sa-east-1\"" }, { - "id": 76, + "id": 80, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", @@ -101279,7 +110832,7 @@ "defaultValue": "\"us-east-1\"" }, { - "id": 77, + "id": 81, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", @@ -101298,7 +110851,7 @@ "defaultValue": "\"us-west-1\"" }, { - "id": 78, + "id": 82, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", @@ -101321,7 +110874,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78] + "children": [68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82] } ], "sources": [ @@ -101335,7 +110888,7 @@ } }, { - "id": 14, + "id": 17, "name": "url", "kind": 1024, "kindString": "Property", @@ -101355,7 +110908,7 @@ } }, { - "id": 25, + "id": 31, "name": "invoke", "kind": 2048, "kindString": "Method", @@ -101369,7 +110922,7 @@ ], "signatures": [ { - "id": 26, + "id": 32, "name": "invoke", "kind": 4096, "kindString": "Call signature", @@ -101379,7 +110932,7 @@ }, "typeParameter": [ { - "id": 27, + "id": 33, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -101392,7 +110945,7 @@ ], "parameters": [ { - "id": 28, + "id": 34, "name": "functionName", "kind": 32768, "kindString": "Parameter", @@ -101406,7 +110959,7 @@ } }, { - "id": 29, + "id": 35, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -101416,10 +110969,10 @@ }, "type": { "type": "reference", - "id": 30, + "id": 36, "name": "FunctionInvokeOptions", "dereferenced": { - "id": 30, + "id": 36, "name": "FunctionInvokeOptions", "kind": 4194304, "kindString": "Type alias", @@ -101434,14 +110987,14 @@ "type": { "type": "reflection", "declaration": { - "id": 31, + "id": 37, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 38, + "id": 44, "name": "body", "kind": 1024, "kindString": "Property", @@ -101523,7 +111076,7 @@ } }, { - "id": 32, + "id": 38, "name": "headers", "kind": 1024, "kindString": "Property", @@ -101543,7 +111096,7 @@ "type": { "type": "reflection", "declaration": { - "id": 33, + "id": 39, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -101556,14 +111109,14 @@ } ], "indexSignature": { - "id": 34, + "id": 40, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 35, + "id": 41, "name": "key", "kind": 32768, "flags": {}, @@ -101582,7 +111135,7 @@ } }, { - "id": 36, + "id": 42, "name": "method", "kind": 1024, "kindString": "Property", @@ -101626,7 +111179,7 @@ } }, { - "id": 37, + "id": 43, "name": "region", "kind": 1024, "kindString": "Property", @@ -101645,17 +111198,17 @@ ], "type": { "type": "reference", - "id": 63, + "id": 67, "name": "FunctionRegion", "dereferenced": { - "id": 63, + "id": 67, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 64, + "id": 68, "name": "Any", "kind": 16, "kindString": "Enumeration Member", @@ -101674,7 +111227,7 @@ "defaultValue": "\"any\"" }, { - "id": 65, + "id": 69, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", @@ -101693,7 +111246,7 @@ "defaultValue": "\"ap-northeast-1\"" }, { - "id": 66, + "id": 70, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", @@ -101712,7 +111265,7 @@ "defaultValue": "\"ap-northeast-2\"" }, { - "id": 67, + "id": 71, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", @@ -101731,7 +111284,7 @@ "defaultValue": "\"ap-south-1\"" }, { - "id": 68, + "id": 72, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", @@ -101750,7 +111303,7 @@ "defaultValue": "\"ap-southeast-1\"" }, { - "id": 69, + "id": 73, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", @@ -101769,7 +111322,7 @@ "defaultValue": "\"ap-southeast-2\"" }, { - "id": 70, + "id": 74, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -101788,7 +111341,7 @@ "defaultValue": "\"ca-central-1\"" }, { - "id": 71, + "id": 75, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -101807,7 +111360,7 @@ "defaultValue": "\"eu-central-1\"" }, { - "id": 72, + "id": 76, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", @@ -101826,7 +111379,7 @@ "defaultValue": "\"eu-west-1\"" }, { - "id": 73, + "id": 77, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", @@ -101845,7 +111398,7 @@ "defaultValue": "\"eu-west-2\"" }, { - "id": 74, + "id": 78, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", @@ -101864,7 +111417,7 @@ "defaultValue": "\"eu-west-3\"" }, { - "id": 75, + "id": 79, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", @@ -101883,7 +111436,7 @@ "defaultValue": "\"sa-east-1\"" }, { - "id": 76, + "id": 80, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", @@ -101902,7 +111455,7 @@ "defaultValue": "\"us-east-1\"" }, { - "id": 77, + "id": 81, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", @@ -101921,7 +111474,7 @@ "defaultValue": "\"us-west-1\"" }, { - "id": 78, + "id": 82, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", @@ -101945,8 +111498,8 @@ "title": "Enumeration Members", "kind": 16, "children": [ - 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, - 78 + 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, + 82 ] } ], @@ -101965,7 +111518,7 @@ { "title": "Properties", "kind": 1024, - "children": [38, 32, 36, 37] + "children": [44, 38, 42, 43] } ], "sources": [ @@ -101987,11 +111540,11 @@ "typeArguments": [ { "type": "reference", - "id": 61, + "id": 83, "typeArguments": [ { "type": "reference", - "id": 27, + "id": 33, "name": "T" } ], @@ -102006,7 +111559,7 @@ ] }, { - "id": 22, + "id": 28, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -102020,7 +111573,7 @@ ], "signatures": [ { - "id": 23, + "id": 29, "name": "setAuth", "kind": 4096, "kindString": "Call signature", @@ -102030,7 +111583,7 @@ }, "parameters": [ { - "id": 24, + "id": 30, "name": "token", "kind": 32768, "kindString": "Parameter", @@ -102061,12 +111614,12 @@ { "title": "Properties", "kind": 1024, - "children": [17, 15, 16, 14] + "children": [20, 18, 19, 17] }, { "title": "Methods", "kind": 2048, - "children": [25, 22] + "children": [31, 28] } ], "sources": [ @@ -102078,14 +111631,14 @@ ] }, { - "id": 39, + "id": 45, "name": "FunctionsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 40, + "id": 46, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -102099,14 +111652,14 @@ ], "signatures": [ { - "id": 41, + "id": 47, "name": "new FunctionsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 42, + "id": 48, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -102117,7 +111670,7 @@ } }, { - "id": 43, + "id": 49, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -102129,7 +111682,7 @@ "defaultValue": "'FunctionsError'" }, { - "id": 44, + "id": 50, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -102144,7 +111697,7 @@ ], "type": { "type": "reference", - "id": 39, + "id": 45, "name": "FunctionsError" }, "overwrites": { @@ -102159,7 +111712,7 @@ } }, { - "id": 45, + "id": 51, "name": "context", "kind": 1024, "kindString": "Property", @@ -102181,12 +111734,12 @@ { "title": "Constructors", "kind": 512, - "children": [40] + "children": [46] }, { "title": "Properties", "kind": 1024, - "children": [45] + "children": [51] } ], "sources": [ @@ -102207,30 +111760,30 @@ "extendedBy": [ { "type": "reference", - "id": 46, + "id": 52, "name": "FunctionsFetchError" }, { "type": "reference", - "id": 51, + "id": 57, "name": "FunctionsHttpError" }, { "type": "reference", - "id": 56, + "id": 62, "name": "FunctionsRelayError" } ] }, { - "id": 46, + "id": 52, "name": "FunctionsFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 47, + "id": 53, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -102244,14 +111797,14 @@ ], "signatures": [ { - "id": 48, + "id": 54, "name": "new FunctionsFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 49, + "id": 55, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -102264,24 +111817,24 @@ ], "type": { "type": "reference", - "id": 46, + "id": 52, "name": "FunctionsFetchError" }, "overwrites": { "type": "reference", - "id": 41, + "id": 47, "name": "FunctionsError.constructor" } } ], "overwrites": { "type": "reference", - "id": 40, + "id": 46, "name": "FunctionsError.constructor" } }, { - "id": 50, + "id": 56, "name": "context", "kind": 1024, "kindString": "Property", @@ -102299,7 +111852,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 45, + "id": 51, "name": "FunctionsError.context" } } @@ -102308,12 +111861,12 @@ { "title": "Constructors", "kind": 512, - "children": [47] + "children": [53] }, { "title": "Properties", "kind": 1024, - "children": [50] + "children": [56] } ], "sources": [ @@ -102326,20 +111879,20 @@ "extendedTypes": [ { "type": "reference", - "id": 39, + "id": 45, "name": "FunctionsError" } ] }, { - "id": 51, + "id": 57, "name": "FunctionsHttpError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 52, + "id": 58, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -102353,14 +111906,14 @@ ], "signatures": [ { - "id": 53, + "id": 59, "name": "new FunctionsHttpError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 54, + "id": 60, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -102373,24 +111926,24 @@ ], "type": { "type": "reference", - "id": 51, + "id": 57, "name": "FunctionsHttpError" }, "overwrites": { "type": "reference", - "id": 41, + "id": 47, "name": "FunctionsError.constructor" } } ], "overwrites": { "type": "reference", - "id": 40, + "id": 46, "name": "FunctionsError.constructor" } }, { - "id": 55, + "id": 61, "name": "context", "kind": 1024, "kindString": "Property", @@ -102408,7 +111961,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 45, + "id": 51, "name": "FunctionsError.context" } } @@ -102417,12 +111970,12 @@ { "title": "Constructors", "kind": 512, - "children": [52] + "children": [58] }, { "title": "Properties", "kind": 1024, - "children": [55] + "children": [61] } ], "sources": [ @@ -102435,20 +111988,20 @@ "extendedTypes": [ { "type": "reference", - "id": 39, + "id": 45, "name": "FunctionsError" } ] }, { - "id": 56, + "id": 62, "name": "FunctionsRelayError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 57, + "id": 63, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -102462,14 +112015,14 @@ ], "signatures": [ { - "id": 58, + "id": 64, "name": "new FunctionsRelayError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 59, + "id": 65, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -102482,24 +112035,24 @@ ], "type": { "type": "reference", - "id": 56, + "id": 62, "name": "FunctionsRelayError" }, "overwrites": { "type": "reference", - "id": 41, + "id": 47, "name": "FunctionsError.constructor" } } ], "overwrites": { "type": "reference", - "id": 40, + "id": 46, "name": "FunctionsError.constructor" } }, { - "id": 60, + "id": 66, "name": "context", "kind": 1024, "kindString": "Property", @@ -102517,7 +112070,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 45, + "id": 51, "name": "FunctionsError.context" } } @@ -102526,12 +112079,12 @@ { "title": "Constructors", "kind": 512, - "children": [57] + "children": [63] }, { "title": "Properties", "kind": 1024, - "children": [60] + "children": [66] } ], "sources": [ @@ -102544,13 +112097,13 @@ "extendedTypes": [ { "type": "reference", - "id": 39, + "id": 45, "name": "FunctionsError" } ] }, { - "id": 30, + "id": 36, "name": "FunctionInvokeOptions", "kind": 4194304, "kindString": "Type alias", @@ -102565,14 +112118,14 @@ "type": { "type": "reflection", "declaration": { - "id": 31, + "id": 37, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 38, + "id": 44, "name": "body", "kind": 1024, "kindString": "Property", @@ -102654,7 +112207,7 @@ } }, { - "id": 32, + "id": 38, "name": "headers", "kind": 1024, "kindString": "Property", @@ -102674,7 +112227,7 @@ "type": { "type": "reflection", "declaration": { - "id": 33, + "id": 39, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -102687,14 +112240,14 @@ } ], "indexSignature": { - "id": 34, + "id": 40, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 35, + "id": 41, "name": "key", "kind": 32768, "flags": {}, @@ -102713,7 +112266,7 @@ } }, { - "id": 36, + "id": 42, "name": "method", "kind": 1024, "kindString": "Property", @@ -102757,7 +112310,7 @@ } }, { - "id": 37, + "id": 43, "name": "region", "kind": 1024, "kindString": "Property", @@ -102776,17 +112329,17 @@ ], "type": { "type": "reference", - "id": 63, + "id": 67, "name": "FunctionRegion", "dereferenced": { - "id": 63, + "id": 67, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 64, + "id": 68, "name": "Any", "kind": 16, "kindString": "Enumeration Member", @@ -102805,7 +112358,7 @@ "defaultValue": "\"any\"" }, { - "id": 65, + "id": 69, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", @@ -102824,7 +112377,7 @@ "defaultValue": "\"ap-northeast-1\"" }, { - "id": 66, + "id": 70, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", @@ -102843,7 +112396,7 @@ "defaultValue": "\"ap-northeast-2\"" }, { - "id": 67, + "id": 71, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", @@ -102862,7 +112415,7 @@ "defaultValue": "\"ap-south-1\"" }, { - "id": 68, + "id": 72, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", @@ -102881,7 +112434,7 @@ "defaultValue": "\"ap-southeast-1\"" }, { - "id": 69, + "id": 73, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", @@ -102900,7 +112453,7 @@ "defaultValue": "\"ap-southeast-2\"" }, { - "id": 70, + "id": 74, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -102919,7 +112472,7 @@ "defaultValue": "\"ca-central-1\"" }, { - "id": 71, + "id": 75, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -102938,7 +112491,7 @@ "defaultValue": "\"eu-central-1\"" }, { - "id": 72, + "id": 76, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", @@ -102957,7 +112510,7 @@ "defaultValue": "\"eu-west-1\"" }, { - "id": 73, + "id": 77, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", @@ -102976,7 +112529,7 @@ "defaultValue": "\"eu-west-2\"" }, { - "id": 74, + "id": 78, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", @@ -102995,7 +112548,7 @@ "defaultValue": "\"eu-west-3\"" }, { - "id": 75, + "id": 79, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", @@ -103014,7 +112567,7 @@ "defaultValue": "\"sa-east-1\"" }, { - "id": 76, + "id": 80, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", @@ -103033,7 +112586,7 @@ "defaultValue": "\"us-east-1\"" }, { - "id": 77, + "id": 81, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", @@ -103052,7 +112605,7 @@ "defaultValue": "\"us-west-1\"" }, { - "id": 78, + "id": 82, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", @@ -103075,7 +112628,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78] + "children": [68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82] } ], "sources": [ @@ -103093,7 +112646,7 @@ { "title": "Properties", "kind": 1024, - "children": [38, 32, 36, 37] + "children": [44, 38, 42, 43] } ], "sources": [ @@ -103107,7 +112660,7 @@ } }, { - "id": 61, + "id": 83, "name": "FunctionsResponse", "kind": 4194304, "kindString": "Type alias", @@ -103121,7 +112674,7 @@ ], "typeParameter": [ { - "id": 62, + "id": 84, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -103138,17 +112691,17 @@ { "title": "Enumerations", "kind": 8, - "children": [63] + "children": [67] }, { "title": "Classes", "kind": 128, - "children": [1, 39, 46, 51, 56] + "children": [1, 45, 52, 57, 62] }, { "title": "Type Aliases", "kind": 4194304, - "children": [30, 61] + "children": [36, 83] } ], "sources": [ diff --git a/apps/docs/spec/enrichments/tsdoc_v2/functions.json b/apps/docs/spec/enrichments/tsdoc_v2/functions.json index 1f803bf6e96..9e27366a175 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/functions.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/functions.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 63, + "id": 67, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 64, + "id": 68, "name": "Any", "kind": 16, "kindString": "Enumeration Member", @@ -33,7 +33,7 @@ "defaultValue": "\"any\"" }, { - "id": 65, + "id": 69, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", @@ -52,7 +52,7 @@ "defaultValue": "\"ap-northeast-1\"" }, { - "id": 66, + "id": 70, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", @@ -71,7 +71,7 @@ "defaultValue": "\"ap-northeast-2\"" }, { - "id": 67, + "id": 71, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", @@ -90,7 +90,7 @@ "defaultValue": "\"ap-south-1\"" }, { - "id": 68, + "id": 72, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", @@ -109,7 +109,7 @@ "defaultValue": "\"ap-southeast-1\"" }, { - "id": 69, + "id": 73, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", @@ -128,7 +128,7 @@ "defaultValue": "\"ap-southeast-2\"" }, { - "id": 70, + "id": 74, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -147,7 +147,7 @@ "defaultValue": "\"ca-central-1\"" }, { - "id": 71, + "id": 75, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -166,7 +166,7 @@ "defaultValue": "\"eu-central-1\"" }, { - "id": 72, + "id": 76, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", @@ -185,7 +185,7 @@ "defaultValue": "\"eu-west-1\"" }, { - "id": 73, + "id": 77, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", @@ -204,7 +204,7 @@ "defaultValue": "\"eu-west-2\"" }, { - "id": 74, + "id": 78, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", @@ -223,7 +223,7 @@ "defaultValue": "\"eu-west-3\"" }, { - "id": 75, + "id": 79, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", @@ -242,7 +242,7 @@ "defaultValue": "\"sa-east-1\"" }, { - "id": 76, + "id": 80, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", @@ -261,7 +261,7 @@ "defaultValue": "\"us-east-1\"" }, { - "id": 77, + "id": 81, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", @@ -280,7 +280,7 @@ "defaultValue": "\"us-west-1\"" }, { - "id": 78, + "id": 82, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", @@ -303,7 +303,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78] + "children": [68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82] } ], "sources": [ @@ -453,6 +453,72 @@ "package": "typescript", "name": "Promise" } + }, + { + "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": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "qualifiedName": "Request", + "package": "typescript", + "name": "Request" + }, + { + "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" + } } ] } @@ -491,7 +557,7 @@ } }, { - "id": 13, + "id": 16, "name": "region", "kind": 1024, "kindString": "Property", @@ -507,7 +573,7 @@ ], "type": { "type": "reference", - "id": 63, + "id": 67, "name": "FunctionRegion" } } @@ -516,7 +582,7 @@ { "title": "Properties", "kind": 1024, - "children": [8, 7, 13] + "children": [8, 7, 16] } ] } @@ -533,7 +599,7 @@ ] }, { - "id": 17, + "id": 20, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -550,21 +616,21 @@ "type": { "type": "reflection", "declaration": { - "id": 18, + "id": 21, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 19, + "id": 22, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 20, + "id": 23, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -588,7 +654,73 @@ } }, { - "id": 21, + "id": 24, + "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": 25, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 26, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "qualifiedName": "Request", + "package": "typescript", + "name": "Request" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 27, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -623,7 +755,7 @@ } }, { - "id": 15, + "id": 18, "name": "headers", "kind": 1024, "kindString": "Property", @@ -655,7 +787,7 @@ } }, { - "id": 16, + "id": 19, "name": "region", "kind": 1024, "kindString": "Property", @@ -671,12 +803,12 @@ ], "type": { "type": "reference", - "id": 63, + "id": 67, "name": "FunctionRegion" } }, { - "id": 14, + "id": 17, "name": "url", "kind": 1024, "kindString": "Property", @@ -696,7 +828,7 @@ } }, { - "id": 25, + "id": 31, "name": "invoke", "kind": 2048, "kindString": "Method", @@ -710,7 +842,7 @@ ], "signatures": [ { - "id": 26, + "id": 32, "name": "invoke", "kind": 4096, "kindString": "Call signature", @@ -720,7 +852,7 @@ }, "typeParameter": [ { - "id": 27, + "id": 33, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -733,7 +865,7 @@ ], "parameters": [ { - "id": 28, + "id": 34, "name": "functionName", "kind": 32768, "kindString": "Parameter", @@ -747,7 +879,7 @@ } }, { - "id": 29, + "id": 35, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -757,7 +889,7 @@ }, "type": { "type": "reference", - "id": 30, + "id": 36, "name": "FunctionInvokeOptions" }, "defaultValue": "{}" @@ -768,11 +900,11 @@ "typeArguments": [ { "type": "reference", - "id": 61, + "id": 83, "typeArguments": [ { "type": "reference", - "id": 27, + "id": 33, "name": "T" } ], @@ -787,7 +919,7 @@ ] }, { - "id": 22, + "id": 28, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -801,7 +933,7 @@ ], "signatures": [ { - "id": 23, + "id": 29, "name": "setAuth", "kind": 4096, "kindString": "Call signature", @@ -811,7 +943,7 @@ }, "parameters": [ { - "id": 24, + "id": 30, "name": "token", "kind": 32768, "kindString": "Parameter", @@ -842,12 +974,12 @@ { "title": "Properties", "kind": 1024, - "children": [17, 15, 16, 14] + "children": [20, 18, 19, 17] }, { "title": "Methods", "kind": 2048, - "children": [25, 22] + "children": [31, 28] } ], "sources": [ @@ -859,14 +991,14 @@ ] }, { - "id": 39, + "id": 45, "name": "FunctionsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 40, + "id": 46, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -880,14 +1012,14 @@ ], "signatures": [ { - "id": 41, + "id": 47, "name": "new FunctionsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 42, + "id": 48, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -898,7 +1030,7 @@ } }, { - "id": 43, + "id": 49, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -910,7 +1042,7 @@ "defaultValue": "'FunctionsError'" }, { - "id": 44, + "id": 50, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -925,7 +1057,7 @@ ], "type": { "type": "reference", - "id": 39, + "id": 45, "name": "FunctionsError" }, "overwrites": { @@ -940,7 +1072,7 @@ } }, { - "id": 45, + "id": 51, "name": "context", "kind": 1024, "kindString": "Property", @@ -962,12 +1094,12 @@ { "title": "Constructors", "kind": 512, - "children": [40] + "children": [46] }, { "title": "Properties", "kind": 1024, - "children": [45] + "children": [51] } ], "sources": [ @@ -988,30 +1120,30 @@ "extendedBy": [ { "type": "reference", - "id": 46, + "id": 52, "name": "FunctionsFetchError" }, { "type": "reference", - "id": 51, + "id": 57, "name": "FunctionsHttpError" }, { "type": "reference", - "id": 56, + "id": 62, "name": "FunctionsRelayError" } ] }, { - "id": 46, + "id": 52, "name": "FunctionsFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 47, + "id": 53, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1025,14 +1157,14 @@ ], "signatures": [ { - "id": 48, + "id": 54, "name": "new FunctionsFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 49, + "id": 55, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -1045,24 +1177,24 @@ ], "type": { "type": "reference", - "id": 46, + "id": 52, "name": "FunctionsFetchError" }, "overwrites": { "type": "reference", - "id": 41, + "id": 47, "name": "FunctionsError.constructor" } } ], "overwrites": { "type": "reference", - "id": 40, + "id": 46, "name": "FunctionsError.constructor" } }, { - "id": 50, + "id": 56, "name": "context", "kind": 1024, "kindString": "Property", @@ -1080,7 +1212,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 45, + "id": 51, "name": "FunctionsError.context" } } @@ -1089,12 +1221,12 @@ { "title": "Constructors", "kind": 512, - "children": [47] + "children": [53] }, { "title": "Properties", "kind": 1024, - "children": [50] + "children": [56] } ], "sources": [ @@ -1107,20 +1239,20 @@ "extendedTypes": [ { "type": "reference", - "id": 39, + "id": 45, "name": "FunctionsError" } ] }, { - "id": 51, + "id": 57, "name": "FunctionsHttpError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 52, + "id": 58, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1134,14 +1266,14 @@ ], "signatures": [ { - "id": 53, + "id": 59, "name": "new FunctionsHttpError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 54, + "id": 60, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -1154,24 +1286,24 @@ ], "type": { "type": "reference", - "id": 51, + "id": 57, "name": "FunctionsHttpError" }, "overwrites": { "type": "reference", - "id": 41, + "id": 47, "name": "FunctionsError.constructor" } } ], "overwrites": { "type": "reference", - "id": 40, + "id": 46, "name": "FunctionsError.constructor" } }, { - "id": 55, + "id": 61, "name": "context", "kind": 1024, "kindString": "Property", @@ -1189,7 +1321,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 45, + "id": 51, "name": "FunctionsError.context" } } @@ -1198,12 +1330,12 @@ { "title": "Constructors", "kind": 512, - "children": [52] + "children": [58] }, { "title": "Properties", "kind": 1024, - "children": [55] + "children": [61] } ], "sources": [ @@ -1216,20 +1348,20 @@ "extendedTypes": [ { "type": "reference", - "id": 39, + "id": 45, "name": "FunctionsError" } ] }, { - "id": 56, + "id": 62, "name": "FunctionsRelayError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 57, + "id": 63, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1243,14 +1375,14 @@ ], "signatures": [ { - "id": 58, + "id": 64, "name": "new FunctionsRelayError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 59, + "id": 65, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -1263,24 +1395,24 @@ ], "type": { "type": "reference", - "id": 56, + "id": 62, "name": "FunctionsRelayError" }, "overwrites": { "type": "reference", - "id": 41, + "id": 47, "name": "FunctionsError.constructor" } } ], "overwrites": { "type": "reference", - "id": 40, + "id": 46, "name": "FunctionsError.constructor" } }, { - "id": 60, + "id": 66, "name": "context", "kind": 1024, "kindString": "Property", @@ -1298,7 +1430,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 45, + "id": 51, "name": "FunctionsError.context" } } @@ -1307,12 +1439,12 @@ { "title": "Constructors", "kind": 512, - "children": [57] + "children": [63] }, { "title": "Properties", "kind": 1024, - "children": [60] + "children": [66] } ], "sources": [ @@ -1325,13 +1457,13 @@ "extendedTypes": [ { "type": "reference", - "id": 39, + "id": 45, "name": "FunctionsError" } ] }, { - "id": 30, + "id": 36, "name": "FunctionInvokeOptions", "kind": 4194304, "kindString": "Type alias", @@ -1346,14 +1478,14 @@ "type": { "type": "reflection", "declaration": { - "id": 31, + "id": 37, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 38, + "id": 44, "name": "body", "kind": 1024, "kindString": "Property", @@ -1435,7 +1567,7 @@ } }, { - "id": 32, + "id": 38, "name": "headers", "kind": 1024, "kindString": "Property", @@ -1455,7 +1587,7 @@ "type": { "type": "reflection", "declaration": { - "id": 33, + "id": 39, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1468,14 +1600,14 @@ } ], "indexSignature": { - "id": 34, + "id": 40, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 35, + "id": 41, "name": "key", "kind": 32768, "flags": {}, @@ -1494,7 +1626,7 @@ } }, { - "id": 36, + "id": 42, "name": "method", "kind": 1024, "kindString": "Property", @@ -1538,7 +1670,7 @@ } }, { - "id": 37, + "id": 43, "name": "region", "kind": 1024, "kindString": "Property", @@ -1557,7 +1689,7 @@ ], "type": { "type": "reference", - "id": 63, + "id": 67, "name": "FunctionRegion" } } @@ -1566,7 +1698,7 @@ { "title": "Properties", "kind": 1024, - "children": [38, 32, 36, 37] + "children": [44, 38, 42, 43] } ], "sources": [ @@ -1580,7 +1712,7 @@ } }, { - "id": 61, + "id": 83, "name": "FunctionsResponse", "kind": 4194304, "kindString": "Type alias", @@ -1594,7 +1726,7 @@ ], "typeParameter": [ { - "id": 62, + "id": 84, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -1609,7 +1741,7 @@ "typeArguments": [ { "type": "reference", - "id": 62, + "id": 84, "name": "T" } ], @@ -1627,17 +1759,17 @@ { "title": "Enumerations", "kind": 8, - "children": [63] + "children": [67] }, { "title": "Classes", "kind": 128, - "children": [1, 39, 46, 51, 56] + "children": [1, 45, 52, 57, 62] }, { "title": "Type Aliases", "kind": 4194304, - "children": [30, 61] + "children": [36, 83] } ], "sources": [ diff --git a/apps/docs/spec/enrichments/tsdoc_v2/functions_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/functions_dereferenced.json index 7f390da771e..89c4d5f7ecf 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/functions_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/functions_dereferenced.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 63, + "id": 67, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 64, + "id": 68, "name": "Any", "kind": 16, "kindString": "Enumeration Member", @@ -33,7 +33,7 @@ "defaultValue": "\"any\"" }, { - "id": 65, + "id": 69, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", @@ -52,7 +52,7 @@ "defaultValue": "\"ap-northeast-1\"" }, { - "id": 66, + "id": 70, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", @@ -71,7 +71,7 @@ "defaultValue": "\"ap-northeast-2\"" }, { - "id": 67, + "id": 71, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", @@ -90,7 +90,7 @@ "defaultValue": "\"ap-south-1\"" }, { - "id": 68, + "id": 72, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", @@ -109,7 +109,7 @@ "defaultValue": "\"ap-southeast-1\"" }, { - "id": 69, + "id": 73, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", @@ -128,7 +128,7 @@ "defaultValue": "\"ap-southeast-2\"" }, { - "id": 70, + "id": 74, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -147,7 +147,7 @@ "defaultValue": "\"ca-central-1\"" }, { - "id": 71, + "id": 75, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -166,7 +166,7 @@ "defaultValue": "\"eu-central-1\"" }, { - "id": 72, + "id": 76, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", @@ -185,7 +185,7 @@ "defaultValue": "\"eu-west-1\"" }, { - "id": 73, + "id": 77, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", @@ -204,7 +204,7 @@ "defaultValue": "\"eu-west-2\"" }, { - "id": 74, + "id": 78, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", @@ -223,7 +223,7 @@ "defaultValue": "\"eu-west-3\"" }, { - "id": 75, + "id": 79, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", @@ -242,7 +242,7 @@ "defaultValue": "\"sa-east-1\"" }, { - "id": 76, + "id": 80, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", @@ -261,7 +261,7 @@ "defaultValue": "\"us-east-1\"" }, { - "id": 77, + "id": 81, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", @@ -280,7 +280,7 @@ "defaultValue": "\"us-west-1\"" }, { - "id": 78, + "id": 82, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", @@ -303,7 +303,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78] + "children": [68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82] } ], "sources": [ @@ -453,6 +453,72 @@ "package": "typescript", "name": "Promise" } + }, + { + "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": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "qualifiedName": "Request", + "package": "typescript", + "name": "Request" + }, + { + "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" + } } ] } @@ -491,7 +557,7 @@ } }, { - "id": 13, + "id": 16, "name": "region", "kind": 1024, "kindString": "Property", @@ -507,17 +573,17 @@ ], "type": { "type": "reference", - "id": 63, + "id": 67, "name": "FunctionRegion", "dereferenced": { - "id": 63, + "id": 67, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 64, + "id": 68, "name": "Any", "kind": 16, "kindString": "Enumeration Member", @@ -536,7 +602,7 @@ "defaultValue": "\"any\"" }, { - "id": 65, + "id": 69, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", @@ -555,7 +621,7 @@ "defaultValue": "\"ap-northeast-1\"" }, { - "id": 66, + "id": 70, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", @@ -574,7 +640,7 @@ "defaultValue": "\"ap-northeast-2\"" }, { - "id": 67, + "id": 71, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", @@ -593,7 +659,7 @@ "defaultValue": "\"ap-south-1\"" }, { - "id": 68, + "id": 72, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", @@ -612,7 +678,7 @@ "defaultValue": "\"ap-southeast-1\"" }, { - "id": 69, + "id": 73, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", @@ -631,7 +697,7 @@ "defaultValue": "\"ap-southeast-2\"" }, { - "id": 70, + "id": 74, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -650,7 +716,7 @@ "defaultValue": "\"ca-central-1\"" }, { - "id": 71, + "id": 75, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -669,7 +735,7 @@ "defaultValue": "\"eu-central-1\"" }, { - "id": 72, + "id": 76, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", @@ -688,7 +754,7 @@ "defaultValue": "\"eu-west-1\"" }, { - "id": 73, + "id": 77, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", @@ -707,7 +773,7 @@ "defaultValue": "\"eu-west-2\"" }, { - "id": 74, + "id": 78, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", @@ -726,7 +792,7 @@ "defaultValue": "\"eu-west-3\"" }, { - "id": 75, + "id": 79, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", @@ -745,7 +811,7 @@ "defaultValue": "\"sa-east-1\"" }, { - "id": 76, + "id": 80, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", @@ -764,7 +830,7 @@ "defaultValue": "\"us-east-1\"" }, { - "id": 77, + "id": 81, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", @@ -783,7 +849,7 @@ "defaultValue": "\"us-west-1\"" }, { - "id": 78, + "id": 82, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", @@ -807,7 +873,7 @@ "title": "Enumeration Members", "kind": 16, "children": [ - 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78 + 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82 ] } ], @@ -826,7 +892,7 @@ { "title": "Properties", "kind": 1024, - "children": [8, 7, 13] + "children": [8, 7, 16] } ] } @@ -843,7 +909,7 @@ ] }, { - "id": 17, + "id": 20, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -860,21 +926,21 @@ "type": { "type": "reflection", "declaration": { - "id": 18, + "id": 21, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 19, + "id": 22, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 20, + "id": 23, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -898,7 +964,73 @@ } }, { - "id": 21, + "id": 24, + "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": 25, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 26, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "qualifiedName": "Request", + "package": "typescript", + "name": "Request" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] + } + }, + { + "id": 27, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -933,7 +1065,7 @@ } }, { - "id": 15, + "id": 18, "name": "headers", "kind": 1024, "kindString": "Property", @@ -965,7 +1097,7 @@ } }, { - "id": 16, + "id": 19, "name": "region", "kind": 1024, "kindString": "Property", @@ -981,17 +1113,17 @@ ], "type": { "type": "reference", - "id": 63, + "id": 67, "name": "FunctionRegion", "dereferenced": { - "id": 63, + "id": 67, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 64, + "id": 68, "name": "Any", "kind": 16, "kindString": "Enumeration Member", @@ -1010,7 +1142,7 @@ "defaultValue": "\"any\"" }, { - "id": 65, + "id": 69, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", @@ -1029,7 +1161,7 @@ "defaultValue": "\"ap-northeast-1\"" }, { - "id": 66, + "id": 70, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", @@ -1048,7 +1180,7 @@ "defaultValue": "\"ap-northeast-2\"" }, { - "id": 67, + "id": 71, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", @@ -1067,7 +1199,7 @@ "defaultValue": "\"ap-south-1\"" }, { - "id": 68, + "id": 72, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", @@ -1086,7 +1218,7 @@ "defaultValue": "\"ap-southeast-1\"" }, { - "id": 69, + "id": 73, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", @@ -1105,7 +1237,7 @@ "defaultValue": "\"ap-southeast-2\"" }, { - "id": 70, + "id": 74, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -1124,7 +1256,7 @@ "defaultValue": "\"ca-central-1\"" }, { - "id": 71, + "id": 75, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -1143,7 +1275,7 @@ "defaultValue": "\"eu-central-1\"" }, { - "id": 72, + "id": 76, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", @@ -1162,7 +1294,7 @@ "defaultValue": "\"eu-west-1\"" }, { - "id": 73, + "id": 77, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", @@ -1181,7 +1313,7 @@ "defaultValue": "\"eu-west-2\"" }, { - "id": 74, + "id": 78, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", @@ -1200,7 +1332,7 @@ "defaultValue": "\"eu-west-3\"" }, { - "id": 75, + "id": 79, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", @@ -1219,7 +1351,7 @@ "defaultValue": "\"sa-east-1\"" }, { - "id": 76, + "id": 80, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", @@ -1238,7 +1370,7 @@ "defaultValue": "\"us-east-1\"" }, { - "id": 77, + "id": 81, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", @@ -1257,7 +1389,7 @@ "defaultValue": "\"us-west-1\"" }, { - "id": 78, + "id": 82, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", @@ -1280,7 +1412,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78] + "children": [68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82] } ], "sources": [ @@ -1294,7 +1426,7 @@ } }, { - "id": 14, + "id": 17, "name": "url", "kind": 1024, "kindString": "Property", @@ -1314,7 +1446,7 @@ } }, { - "id": 25, + "id": 31, "name": "invoke", "kind": 2048, "kindString": "Method", @@ -1328,7 +1460,7 @@ ], "signatures": [ { - "id": 26, + "id": 32, "name": "invoke", "kind": 4096, "kindString": "Call signature", @@ -1338,7 +1470,7 @@ }, "typeParameter": [ { - "id": 27, + "id": 33, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -1351,7 +1483,7 @@ ], "parameters": [ { - "id": 28, + "id": 34, "name": "functionName", "kind": 32768, "kindString": "Parameter", @@ -1365,7 +1497,7 @@ } }, { - "id": 29, + "id": 35, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -1375,10 +1507,10 @@ }, "type": { "type": "reference", - "id": 30, + "id": 36, "name": "FunctionInvokeOptions", "dereferenced": { - "id": 30, + "id": 36, "name": "FunctionInvokeOptions", "kind": 4194304, "kindString": "Type alias", @@ -1393,14 +1525,14 @@ "type": { "type": "reflection", "declaration": { - "id": 31, + "id": 37, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 38, + "id": 44, "name": "body", "kind": 1024, "kindString": "Property", @@ -1482,7 +1614,7 @@ } }, { - "id": 32, + "id": 38, "name": "headers", "kind": 1024, "kindString": "Property", @@ -1502,7 +1634,7 @@ "type": { "type": "reflection", "declaration": { - "id": 33, + "id": 39, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1515,14 +1647,14 @@ } ], "indexSignature": { - "id": 34, + "id": 40, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 35, + "id": 41, "name": "key", "kind": 32768, "flags": {}, @@ -1541,7 +1673,7 @@ } }, { - "id": 36, + "id": 42, "name": "method", "kind": 1024, "kindString": "Property", @@ -1585,7 +1717,7 @@ } }, { - "id": 37, + "id": 43, "name": "region", "kind": 1024, "kindString": "Property", @@ -1604,17 +1736,17 @@ ], "type": { "type": "reference", - "id": 63, + "id": 67, "name": "FunctionRegion", "dereferenced": { - "id": 63, + "id": 67, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 64, + "id": 68, "name": "Any", "kind": 16, "kindString": "Enumeration Member", @@ -1633,7 +1765,7 @@ "defaultValue": "\"any\"" }, { - "id": 65, + "id": 69, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", @@ -1652,7 +1784,7 @@ "defaultValue": "\"ap-northeast-1\"" }, { - "id": 66, + "id": 70, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", @@ -1671,7 +1803,7 @@ "defaultValue": "\"ap-northeast-2\"" }, { - "id": 67, + "id": 71, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", @@ -1690,7 +1822,7 @@ "defaultValue": "\"ap-south-1\"" }, { - "id": 68, + "id": 72, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", @@ -1709,7 +1841,7 @@ "defaultValue": "\"ap-southeast-1\"" }, { - "id": 69, + "id": 73, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", @@ -1728,7 +1860,7 @@ "defaultValue": "\"ap-southeast-2\"" }, { - "id": 70, + "id": 74, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -1747,7 +1879,7 @@ "defaultValue": "\"ca-central-1\"" }, { - "id": 71, + "id": 75, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -1766,7 +1898,7 @@ "defaultValue": "\"eu-central-1\"" }, { - "id": 72, + "id": 76, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", @@ -1785,7 +1917,7 @@ "defaultValue": "\"eu-west-1\"" }, { - "id": 73, + "id": 77, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", @@ -1804,7 +1936,7 @@ "defaultValue": "\"eu-west-2\"" }, { - "id": 74, + "id": 78, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", @@ -1823,7 +1955,7 @@ "defaultValue": "\"eu-west-3\"" }, { - "id": 75, + "id": 79, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", @@ -1842,7 +1974,7 @@ "defaultValue": "\"sa-east-1\"" }, { - "id": 76, + "id": 80, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", @@ -1861,7 +1993,7 @@ "defaultValue": "\"us-east-1\"" }, { - "id": 77, + "id": 81, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", @@ -1880,7 +2012,7 @@ "defaultValue": "\"us-west-1\"" }, { - "id": 78, + "id": 82, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", @@ -1904,7 +2036,7 @@ "title": "Enumeration Members", "kind": 16, "children": [ - 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78 + 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82 ] } ], @@ -1923,7 +2055,7 @@ { "title": "Properties", "kind": 1024, - "children": [38, 32, 36, 37] + "children": [44, 38, 42, 43] } ], "sources": [ @@ -1945,11 +2077,11 @@ "typeArguments": [ { "type": "reference", - "id": 61, + "id": 83, "typeArguments": [ { "type": "reference", - "id": 27, + "id": 33, "name": "T" } ], @@ -1964,7 +2096,7 @@ ] }, { - "id": 22, + "id": 28, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -1978,7 +2110,7 @@ ], "signatures": [ { - "id": 23, + "id": 29, "name": "setAuth", "kind": 4096, "kindString": "Call signature", @@ -1988,7 +2120,7 @@ }, "parameters": [ { - "id": 24, + "id": 30, "name": "token", "kind": 32768, "kindString": "Parameter", @@ -2019,12 +2151,12 @@ { "title": "Properties", "kind": 1024, - "children": [17, 15, 16, 14] + "children": [20, 18, 19, 17] }, { "title": "Methods", "kind": 2048, - "children": [25, 22] + "children": [31, 28] } ], "sources": [ @@ -2036,14 +2168,14 @@ ] }, { - "id": 39, + "id": 45, "name": "FunctionsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 40, + "id": 46, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2057,14 +2189,14 @@ ], "signatures": [ { - "id": 41, + "id": 47, "name": "new FunctionsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 42, + "id": 48, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2075,7 +2207,7 @@ } }, { - "id": 43, + "id": 49, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -2087,7 +2219,7 @@ "defaultValue": "'FunctionsError'" }, { - "id": 44, + "id": 50, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -2102,7 +2234,7 @@ ], "type": { "type": "reference", - "id": 39, + "id": 45, "name": "FunctionsError" }, "overwrites": { @@ -2117,7 +2249,7 @@ } }, { - "id": 45, + "id": 51, "name": "context", "kind": 1024, "kindString": "Property", @@ -2139,12 +2271,12 @@ { "title": "Constructors", "kind": 512, - "children": [40] + "children": [46] }, { "title": "Properties", "kind": 1024, - "children": [45] + "children": [51] } ], "sources": [ @@ -2165,30 +2297,30 @@ "extendedBy": [ { "type": "reference", - "id": 46, + "id": 52, "name": "FunctionsFetchError" }, { "type": "reference", - "id": 51, + "id": 57, "name": "FunctionsHttpError" }, { "type": "reference", - "id": 56, + "id": 62, "name": "FunctionsRelayError" } ] }, { - "id": 46, + "id": 52, "name": "FunctionsFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 47, + "id": 53, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2202,14 +2334,14 @@ ], "signatures": [ { - "id": 48, + "id": 54, "name": "new FunctionsFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 49, + "id": 55, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -2222,24 +2354,24 @@ ], "type": { "type": "reference", - "id": 46, + "id": 52, "name": "FunctionsFetchError" }, "overwrites": { "type": "reference", - "id": 41, + "id": 47, "name": "FunctionsError.constructor" } } ], "overwrites": { "type": "reference", - "id": 40, + "id": 46, "name": "FunctionsError.constructor" } }, { - "id": 50, + "id": 56, "name": "context", "kind": 1024, "kindString": "Property", @@ -2257,7 +2389,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 45, + "id": 51, "name": "FunctionsError.context" } } @@ -2266,12 +2398,12 @@ { "title": "Constructors", "kind": 512, - "children": [47] + "children": [53] }, { "title": "Properties", "kind": 1024, - "children": [50] + "children": [56] } ], "sources": [ @@ -2284,20 +2416,20 @@ "extendedTypes": [ { "type": "reference", - "id": 39, + "id": 45, "name": "FunctionsError" } ] }, { - "id": 51, + "id": 57, "name": "FunctionsHttpError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 52, + "id": 58, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2311,14 +2443,14 @@ ], "signatures": [ { - "id": 53, + "id": 59, "name": "new FunctionsHttpError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 54, + "id": 60, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -2331,24 +2463,24 @@ ], "type": { "type": "reference", - "id": 51, + "id": 57, "name": "FunctionsHttpError" }, "overwrites": { "type": "reference", - "id": 41, + "id": 47, "name": "FunctionsError.constructor" } } ], "overwrites": { "type": "reference", - "id": 40, + "id": 46, "name": "FunctionsError.constructor" } }, { - "id": 55, + "id": 61, "name": "context", "kind": 1024, "kindString": "Property", @@ -2366,7 +2498,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 45, + "id": 51, "name": "FunctionsError.context" } } @@ -2375,12 +2507,12 @@ { "title": "Constructors", "kind": 512, - "children": [52] + "children": [58] }, { "title": "Properties", "kind": 1024, - "children": [55] + "children": [61] } ], "sources": [ @@ -2393,20 +2525,20 @@ "extendedTypes": [ { "type": "reference", - "id": 39, + "id": 45, "name": "FunctionsError" } ] }, { - "id": 56, + "id": 62, "name": "FunctionsRelayError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 57, + "id": 63, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2420,14 +2552,14 @@ ], "signatures": [ { - "id": 58, + "id": 64, "name": "new FunctionsRelayError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 59, + "id": 65, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -2440,24 +2572,24 @@ ], "type": { "type": "reference", - "id": 56, + "id": 62, "name": "FunctionsRelayError" }, "overwrites": { "type": "reference", - "id": 41, + "id": 47, "name": "FunctionsError.constructor" } } ], "overwrites": { "type": "reference", - "id": 40, + "id": 46, "name": "FunctionsError.constructor" } }, { - "id": 60, + "id": 66, "name": "context", "kind": 1024, "kindString": "Property", @@ -2475,7 +2607,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 45, + "id": 51, "name": "FunctionsError.context" } } @@ -2484,12 +2616,12 @@ { "title": "Constructors", "kind": 512, - "children": [57] + "children": [63] }, { "title": "Properties", "kind": 1024, - "children": [60] + "children": [66] } ], "sources": [ @@ -2502,13 +2634,13 @@ "extendedTypes": [ { "type": "reference", - "id": 39, + "id": 45, "name": "FunctionsError" } ] }, { - "id": 30, + "id": 36, "name": "FunctionInvokeOptions", "kind": 4194304, "kindString": "Type alias", @@ -2523,14 +2655,14 @@ "type": { "type": "reflection", "declaration": { - "id": 31, + "id": 37, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 38, + "id": 44, "name": "body", "kind": 1024, "kindString": "Property", @@ -2612,7 +2744,7 @@ } }, { - "id": 32, + "id": 38, "name": "headers", "kind": 1024, "kindString": "Property", @@ -2632,7 +2764,7 @@ "type": { "type": "reflection", "declaration": { - "id": 33, + "id": 39, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2645,14 +2777,14 @@ } ], "indexSignature": { - "id": 34, + "id": 40, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 35, + "id": 41, "name": "key", "kind": 32768, "flags": {}, @@ -2671,7 +2803,7 @@ } }, { - "id": 36, + "id": 42, "name": "method", "kind": 1024, "kindString": "Property", @@ -2715,7 +2847,7 @@ } }, { - "id": 37, + "id": 43, "name": "region", "kind": 1024, "kindString": "Property", @@ -2734,17 +2866,17 @@ ], "type": { "type": "reference", - "id": 63, + "id": 67, "name": "FunctionRegion", "dereferenced": { - "id": 63, + "id": 67, "name": "FunctionRegion", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 64, + "id": 68, "name": "Any", "kind": 16, "kindString": "Enumeration Member", @@ -2763,7 +2895,7 @@ "defaultValue": "\"any\"" }, { - "id": 65, + "id": 69, "name": "ApNortheast1", "kind": 16, "kindString": "Enumeration Member", @@ -2782,7 +2914,7 @@ "defaultValue": "\"ap-northeast-1\"" }, { - "id": 66, + "id": 70, "name": "ApNortheast2", "kind": 16, "kindString": "Enumeration Member", @@ -2801,7 +2933,7 @@ "defaultValue": "\"ap-northeast-2\"" }, { - "id": 67, + "id": 71, "name": "ApSouth1", "kind": 16, "kindString": "Enumeration Member", @@ -2820,7 +2952,7 @@ "defaultValue": "\"ap-south-1\"" }, { - "id": 68, + "id": 72, "name": "ApSoutheast1", "kind": 16, "kindString": "Enumeration Member", @@ -2839,7 +2971,7 @@ "defaultValue": "\"ap-southeast-1\"" }, { - "id": 69, + "id": 73, "name": "ApSoutheast2", "kind": 16, "kindString": "Enumeration Member", @@ -2858,7 +2990,7 @@ "defaultValue": "\"ap-southeast-2\"" }, { - "id": 70, + "id": 74, "name": "CaCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -2877,7 +3009,7 @@ "defaultValue": "\"ca-central-1\"" }, { - "id": 71, + "id": 75, "name": "EuCentral1", "kind": 16, "kindString": "Enumeration Member", @@ -2896,7 +3028,7 @@ "defaultValue": "\"eu-central-1\"" }, { - "id": 72, + "id": 76, "name": "EuWest1", "kind": 16, "kindString": "Enumeration Member", @@ -2915,7 +3047,7 @@ "defaultValue": "\"eu-west-1\"" }, { - "id": 73, + "id": 77, "name": "EuWest2", "kind": 16, "kindString": "Enumeration Member", @@ -2934,7 +3066,7 @@ "defaultValue": "\"eu-west-2\"" }, { - "id": 74, + "id": 78, "name": "EuWest3", "kind": 16, "kindString": "Enumeration Member", @@ -2953,7 +3085,7 @@ "defaultValue": "\"eu-west-3\"" }, { - "id": 75, + "id": 79, "name": "SaEast1", "kind": 16, "kindString": "Enumeration Member", @@ -2972,7 +3104,7 @@ "defaultValue": "\"sa-east-1\"" }, { - "id": 76, + "id": 80, "name": "UsEast1", "kind": 16, "kindString": "Enumeration Member", @@ -2991,7 +3123,7 @@ "defaultValue": "\"us-east-1\"" }, { - "id": 77, + "id": 81, "name": "UsWest1", "kind": 16, "kindString": "Enumeration Member", @@ -3010,7 +3142,7 @@ "defaultValue": "\"us-west-1\"" }, { - "id": 78, + "id": 82, "name": "UsWest2", "kind": 16, "kindString": "Enumeration Member", @@ -3033,7 +3165,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78] + "children": [68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82] } ], "sources": [ @@ -3051,7 +3183,7 @@ { "title": "Properties", "kind": 1024, - "children": [38, 32, 36, 37] + "children": [44, 38, 42, 43] } ], "sources": [ @@ -3065,7 +3197,7 @@ } }, { - "id": 61, + "id": 83, "name": "FunctionsResponse", "kind": 4194304, "kindString": "Type alias", @@ -3079,7 +3211,7 @@ ], "typeParameter": [ { - "id": 62, + "id": 84, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -3096,17 +3228,17 @@ { "title": "Enumerations", "kind": 8, - "children": [63] + "children": [67] }, { "title": "Classes", "kind": 128, - "children": [1, 39, 46, 51, 56] + "children": [1, 45, 52, 57, 62] }, { "title": "Type Aliases", "kind": 4194304, - "children": [30, 61] + "children": [36, 83] } ], "sources": [ diff --git a/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json b/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json index 46bc04db480..d051fcba473 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 1065, + "id": 1121, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1066, + "id": 1122, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -22,20 +22,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 21, + "line": 33, "character": 2 } ], "signatures": [ { - "id": 1067, + "id": 1123, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1068, + "id": 1124, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -46,7 +46,7 @@ } }, { - "id": 1069, + "id": 1125, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -55,36 +55,113 @@ "type": "intrinsic", "name": "number" } + }, + { + "id": 1126, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } } ], "type": { "type": "reference", - "id": 1065, + "id": 1121, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 1060, + "id": 1113, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1059, + "id": 1112, "name": "AuthError.constructor" } }, { - "id": 1070, + "id": 1128, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1129, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1117, + "name": "AuthError.code" + } + }, + { + "id": 1127, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 19, + "line": 31, "character": 2 } ], @@ -94,151 +171,47 @@ }, "overwrites": { "type": "reference", - "id": 1063, + "id": 1119, "name": "AuthError.status" } - }, - { - "id": 1071, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 27, - "character": 2 - } - ], - "signatures": [ - { - "id": 1072, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1073, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1075, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 30, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1074, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 29, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1076, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 31, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1075, 1074, 1076] - } - ] - } - } - } - ] } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1066] + "children": [1122] }, { "title": "Properties", "kind": 1024, - "children": [1070] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1071] + "children": [1128, 1127] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 18, + "line": 30, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] }, { - "id": 1058, + "id": 1111, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1059, + "id": 1112, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -246,20 +219,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 7, + "line": 18, "character": 2 } ], "signatures": [ { - "id": 1060, + "id": 1113, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1061, + "id": 1114, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -270,7 +243,7 @@ } }, { - "id": 1062, + "id": 1115, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -281,11 +254,24 @@ "type": "intrinsic", "name": "number" } + }, + { + "id": 1116, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" }, "overwrites": { @@ -300,15 +286,67 @@ } }, { - "id": 1063, + "id": 1117, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1118, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + } + }, + { + "id": 1119, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 4, + "line": 14, "character": 2 } ], @@ -331,18 +369,18 @@ { "title": "Constructors", "kind": 512, - "children": [1059] + "children": [1112] }, { "title": "Properties", "kind": 1024, - "children": [1063] + "children": [1117, 1119] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 3, + "line": 4, "character": 13 } ], @@ -357,30 +395,30 @@ "extendedBy": [ { "type": "reference", - "id": 1065, + "id": 1121, "name": "AuthApiError" }, { "type": "reference", - "id": 1078, + "id": 1131, "name": "AuthUnknownError" }, { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1138, + "id": 1178, "name": "AuthImplicitGrantRedirectError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1139, + "id": 1179, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -388,20 +426,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 88, + "line": 90, "character": 2 } ], "signatures": [ { - "id": 1140, + "id": 1180, "name": "new AuthImplicitGrantRedirectError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1141, + "id": 1181, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -412,7 +450,7 @@ } }, { - "id": 1142, + "id": 1182, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -427,14 +465,14 @@ { "type": "reflection", "declaration": { - "id": 1143, + "id": 1183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1145, + "id": 1185, "name": "code", "kind": 1024, "kindString": "Property", @@ -442,7 +480,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 88, + "line": 90, "character": 57 } ], @@ -452,7 +490,7 @@ } }, { - "id": 1144, + "id": 1184, "name": "error", "kind": 1024, "kindString": "Property", @@ -460,7 +498,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 88, + "line": 90, "character": 42 } ], @@ -474,7 +512,7 @@ { "title": "Properties", "kind": 1024, - "children": [1145, 1144] + "children": [1185, 1184] } ] } @@ -486,24 +524,78 @@ ], "type": { "type": "reference", - "id": 1138, + "id": 1178, "name": "AuthImplicitGrantRedirectError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1146, + "id": 1202, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1203, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1186, "name": "details", "kind": 1024, "kindString": "Property", @@ -511,7 +603,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 2 } ], @@ -525,14 +617,14 @@ { "type": "reflection", "declaration": { - "id": 1147, + "id": 1187, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1149, + "id": 1189, "name": "code", "kind": 1024, "kindString": "Property", @@ -540,7 +632,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 28 } ], @@ -550,7 +642,7 @@ } }, { - "id": 1148, + "id": 1188, "name": "error", "kind": 1024, "kindString": "Property", @@ -558,7 +650,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 13 } ], @@ -572,7 +664,7 @@ { "title": "Properties", "kind": 1024, - "children": [1149, 1148] + "children": [1189, 1188] } ] } @@ -582,7 +674,7 @@ "defaultValue": "null" }, { - "id": 1160, + "id": 1200, "name": "name", "kind": 1024, "kindString": "Property", @@ -590,7 +682,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -600,20 +692,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1161, + "id": 1201, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -623,12 +718,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } }, { - "id": 1150, + "id": 1190, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -636,13 +731,13 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 93, + "line": 95, "character": 2 } ], "signatures": [ { - "id": 1151, + "id": 1191, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -650,14 +745,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1152, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1156, + "id": 1196, "name": "details", "kind": 1024, "kindString": "Property", @@ -665,7 +760,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 98, + "line": 100, "character": 6 } ], @@ -679,14 +774,14 @@ { "type": "reflection", "declaration": { - "id": 1157, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1159, + "id": 1199, "name": "code", "kind": 1024, "kindString": "Property", @@ -694,7 +789,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 28 } ], @@ -704,7 +799,7 @@ } }, { - "id": 1158, + "id": 1198, "name": "error", "kind": 1024, "kindString": "Property", @@ -712,7 +807,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 13 } ], @@ -726,7 +821,7 @@ { "title": "Properties", "kind": 1024, - "children": [1159, 1158] + "children": [1199, 1198] } ] } @@ -736,7 +831,7 @@ "defaultValue": "..." }, { - "id": 1154, + "id": 1194, "name": "message", "kind": 1024, "kindString": "Property", @@ -744,7 +839,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 96, + "line": 98, "character": 6 } ], @@ -755,30 +850,11 @@ "defaultValue": "..." }, { - "id": 1153, + "id": 1193, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 95, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1155, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", @@ -786,6 +862,25 @@ "character": 6 } ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1195, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 99, + "character": 6 + } + ], "type": { "type": "intrinsic", "name": "number" @@ -797,66 +892,56 @@ { "title": "Properties", "kind": 1024, - "children": [1156, 1154, 1153, 1155] + "children": [1196, 1194, 1193, 1195] } ] } - }, - "overwrites": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" } } - ], - "overwrites": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } + ] } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1139] + "children": [1179] }, { "title": "Properties", "kind": 1024, - "children": [1146, 1160, 1161] + "children": [1202, 1186, 1200, 1201] }, { "title": "Methods", "kind": 2048, - "children": [1150] + "children": [1190] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 86, + "line": 88, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1125, + "id": 1169, "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1126, + "id": 1170, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -864,20 +949,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 81, + "line": 83, "character": 2 } ], "signatures": [ { - "id": 1127, + "id": 1171, "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1128, + "id": 1172, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -890,24 +975,78 @@ ], "type": { "type": "reference", - "id": 1125, + "id": 1169, "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1129, + "id": 1175, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1176, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1173, "name": "name", "kind": 1024, "kindString": "Property", @@ -915,7 +1054,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -925,20 +1064,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1130, + "id": 1174, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -948,161 +1090,47 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } - }, - { - "id": 1131, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1132, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1135, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1134, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1136, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1135, 1134, 1136] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1126] + "children": [1170] }, { "title": "Properties", "kind": 1024, - "children": [1129, 1130] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1131] + "children": [1175, 1173, 1174] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 80, + "line": 82, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1113, + "id": 1161, "name": "AuthInvalidTokenResponseError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1114, + "id": 1162, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1110,37 +1138,91 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 75, + "line": 77, "character": 2 } ], "signatures": [ { - "id": 1115, + "id": 1163, "name": "new AuthInvalidTokenResponseError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1113, + "id": 1161, "name": "AuthInvalidTokenResponseError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1116, + "id": 1166, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1167, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1164, "name": "name", "kind": 1024, "kindString": "Property", @@ -1148,7 +1230,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -1158,20 +1240,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1117, + "id": 1165, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -1181,161 +1266,47 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } - }, - { - "id": 1118, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1119, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1120, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1122, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1121, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1123, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1122, 1121, 1123] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1114] + "children": [1162] }, { "title": "Properties", "kind": 1024, - "children": [1116, 1117] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1118] + "children": [1166, 1164, 1165] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 74, + "line": 76, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1163, + "id": 1205, "name": "AuthPKCEGrantCodeExchangeError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1164, + "id": 1206, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1343,20 +1314,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 105, + "line": 114, "character": 2 } ], "signatures": [ { - "id": 1165, + "id": 1207, "name": "new AuthPKCEGrantCodeExchangeError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1166, + "id": 1208, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1367,7 +1338,7 @@ } }, { - "id": 1167, + "id": 1209, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -1382,14 +1353,14 @@ { "type": "reflection", "declaration": { - "id": 1168, + "id": 1210, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1170, + "id": 1212, "name": "code", "kind": 1024, "kindString": "Property", @@ -1397,7 +1368,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 105, + "line": 114, "character": 57 } ], @@ -1407,7 +1378,7 @@ } }, { - "id": 1169, + "id": 1211, "name": "error", "kind": 1024, "kindString": "Property", @@ -1415,7 +1386,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 105, + "line": 114, "character": 42 } ], @@ -1429,7 +1400,7 @@ { "title": "Properties", "kind": 1024, - "children": [1170, 1169] + "children": [1212, 1211] } ] } @@ -1441,24 +1412,78 @@ ], "type": { "type": "reference", - "id": 1163, + "id": 1205, "name": "AuthPKCEGrantCodeExchangeError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1171, + "id": 1229, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1230, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1213, "name": "details", "kind": 1024, "kindString": "Property", @@ -1466,7 +1491,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 2 } ], @@ -1480,14 +1505,14 @@ { "type": "reflection", "declaration": { - "id": 1172, + "id": 1214, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1174, + "id": 1216, "name": "code", "kind": 1024, "kindString": "Property", @@ -1495,7 +1520,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 28 } ], @@ -1505,7 +1530,7 @@ } }, { - "id": 1173, + "id": 1215, "name": "error", "kind": 1024, "kindString": "Property", @@ -1513,7 +1538,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 13 } ], @@ -1527,7 +1552,7 @@ { "title": "Properties", "kind": 1024, - "children": [1174, 1173] + "children": [1216, 1215] } ] } @@ -1537,7 +1562,7 @@ "defaultValue": "null" }, { - "id": 1185, + "id": 1227, "name": "name", "kind": 1024, "kindString": "Property", @@ -1545,7 +1570,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -1555,20 +1580,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1186, + "id": 1228, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -1578,12 +1606,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } }, { - "id": 1175, + "id": 1217, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1591,13 +1619,13 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 110, + "line": 119, "character": 2 } ], "signatures": [ { - "id": 1176, + "id": 1218, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1605,14 +1633,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1177, + "id": 1219, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1181, + "id": 1223, "name": "details", "kind": 1024, "kindString": "Property", @@ -1620,7 +1648,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 115, + "line": 124, "character": 6 } ], @@ -1634,14 +1662,14 @@ { "type": "reflection", "declaration": { - "id": 1182, + "id": 1224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1184, + "id": 1226, "name": "code", "kind": 1024, "kindString": "Property", @@ -1649,7 +1677,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 28 } ], @@ -1659,7 +1687,7 @@ } }, { - "id": 1183, + "id": 1225, "name": "error", "kind": 1024, "kindString": "Property", @@ -1667,7 +1695,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 13 } ], @@ -1681,7 +1709,7 @@ { "title": "Properties", "kind": 1024, - "children": [1184, 1183] + "children": [1226, 1225] } ] } @@ -1691,7 +1719,7 @@ "defaultValue": "..." }, { - "id": 1179, + "id": 1221, "name": "message", "kind": 1024, "kindString": "Property", @@ -1699,7 +1727,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 113, + "line": 122, "character": 6 } ], @@ -1710,7 +1738,7 @@ "defaultValue": "..." }, { - "id": 1178, + "id": 1220, "name": "name", "kind": 1024, "kindString": "Property", @@ -1718,7 +1746,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 112, + "line": 121, "character": 6 } ], @@ -1729,7 +1757,7 @@ "defaultValue": "..." }, { - "id": 1180, + "id": 1222, "name": "status", "kind": 1024, "kindString": "Property", @@ -1737,7 +1765,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 114, + "line": 123, "character": 6 } ], @@ -1752,66 +1780,56 @@ { "title": "Properties", "kind": 1024, - "children": [1181, 1179, 1178, 1180] + "children": [1223, 1221, 1220, 1222] } ] } - }, - "overwrites": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" } } - ], - "overwrites": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } + ] } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1164] + "children": [1206] }, { "title": "Properties", "kind": 1024, - "children": [1171, 1185, 1186] + "children": [1229, 1213, 1227, 1228] }, { "title": "Methods", "kind": 2048, - "children": [1175] + "children": [1217] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 103, + "line": 111, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1188, + "id": 1232, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1189, + "id": 1233, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1819,20 +1837,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 121, + "line": 130, "character": 2 } ], "signatures": [ { - "id": 1190, + "id": 1234, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1191, + "id": 1235, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1843,7 +1861,7 @@ } }, { - "id": 1192, + "id": 1236, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -1856,24 +1874,78 @@ ], "type": { "type": "reference", - "id": 1188, + "id": 1232, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1193, + "id": 1239, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1240, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1237, "name": "name", "kind": 1024, "kindString": "Property", @@ -1881,7 +1953,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -1891,20 +1963,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1194, + "id": 1238, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -1914,161 +1989,47 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } - }, - { - "id": 1195, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1196, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1197, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1199, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1198, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1200, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1199, 1198, 1200] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1189] + "children": [1233] }, { "title": "Properties", "kind": 1024, - "children": [1193, 1194] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1195] + "children": [1239, 1237, 1238] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 120, + "line": 129, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1101, + "id": 1153, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1102, + "id": 1154, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2076,37 +2037,91 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 69, + "line": 67, "character": 2 } ], "signatures": [ { - "id": 1103, + "id": 1155, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1101, + "id": 1153, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1104, + "id": 1158, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1159, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1156, "name": "name", "kind": 1024, "kindString": "Property", @@ -2114,7 +2129,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -2124,20 +2139,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1105, + "id": 1157, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -2147,161 +2165,47 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } - }, - { - "id": 1106, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1107, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1110, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1109, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1111, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1110, 1109, 1111] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1102] + "children": [1154] }, { "title": "Properties", "kind": 1024, - "children": [1104, 1105] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1106] + "children": [1158, 1156, 1157] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 68, + "line": 66, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1078, + "id": 1131, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1079, + "id": 1132, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2309,20 +2213,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 43, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 1080, + "id": 1133, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1081, + "id": 1134, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2333,7 +2237,7 @@ } }, { - "id": 1082, + "id": 1135, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -2346,24 +2250,78 @@ ], "type": { "type": "reference", - "id": 1078, + "id": 1131, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 1060, + "id": 1113, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1059, + "id": 1112, "name": "AuthError.constructor" } }, { - "id": 1083, + "id": 1137, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1138, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1117, + "name": "AuthError.code" + } + }, + { + "id": 1136, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -2371,7 +2329,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 41, + "line": 46, "character": 2 } ], @@ -2381,15 +2339,18 @@ } }, { - "id": 1084, + "id": 1139, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 4, + "line": 14, "character": 2 } ], @@ -2408,7 +2369,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1063, + "id": 1119, "name": "AuthError.status" } } @@ -2417,31 +2378,31 @@ { "title": "Constructors", "kind": 512, - "children": [1079] + "children": [1132] }, { "title": "Properties", "kind": 1024, - "children": [1083, 1084] + "children": [1137, 1136, 1139] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 40, + "line": 45, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] }, { - "id": 1202, + "id": 1242, "name": "AuthWeakPasswordError", "kind": 128, "kindString": "Class", @@ -2451,7 +2412,7 @@ }, "children": [ { - "id": 1203, + "id": 1243, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2459,20 +2420,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 141, + "line": 150, "character": 2 } ], "signatures": [ { - "id": 1204, + "id": 1244, "name": "new AuthWeakPasswordError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1205, + "id": 1245, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2483,7 +2444,7 @@ } }, { - "id": 1206, + "id": 1246, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2494,7 +2455,7 @@ } }, { - "id": 1207, + "id": 1247, "name": "reasons", "kind": 32768, "kindString": "Parameter", @@ -2510,24 +2471,78 @@ ], "type": { "type": "reference", - "id": 1202, + "id": 1242, "name": "AuthWeakPasswordError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1209, + "id": 1251, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1252, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1249, "name": "name", "kind": 1024, "kindString": "Property", @@ -2535,7 +2550,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -2545,12 +2560,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1208, + "id": 1248, "name": "reasons", "kind": 1024, "kindString": "Property", @@ -2561,28 +2576,32 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 139, + "line": 148, "character": 2 } ], "type": { "type": "array", "elementType": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "id": 526, + "name": "WeakPasswordReasons" } } }, { - "id": 1210, + "id": 1250, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -2592,15 +2611,50 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1243] }, { - "id": 1211, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", + "title": "Properties", + "kind": 1024, + "children": [1251, 1249, 1248, 1250] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 144, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1141, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1141, + "name": "CustomAuthError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1142, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, "sources": [ { @@ -2611,163 +2665,14 @@ ], "signatures": [ { - "id": 1212, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1213, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1215, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1214, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1216, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1215, 1214, 1216] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1203] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1209, 1208, 1210] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1211] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 135, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1086, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1086, - "name": "CustomAuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1087, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 2 - } - ], - "signatures": [ - { - "id": 1088, + "id": 1143, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1089, + "id": 1144, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2778,7 +2683,7 @@ } }, { - "id": 1090, + "id": 1145, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -2789,7 +2694,7 @@ } }, { - "id": 1091, + "id": 1146, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2798,28 +2703,102 @@ "type": "intrinsic", "name": "number" } + }, + { + "id": 1147, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } } ], "type": { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 1060, + "id": 1113, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1059, + "id": 1112, "name": "AuthError.constructor" } }, { - "id": 1092, + "id": 1150, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1151, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1117, + "name": "AuthError.code" + } + }, + { + "id": 1148, "name": "name", "kind": 1024, "kindString": "Property", @@ -2827,7 +2806,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -2841,15 +2820,18 @@ } }, { - "id": 1093, + "id": 1149, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -2859,175 +2841,71 @@ }, "overwrites": { "type": "reference", - "id": 1063, + "id": 1119, "name": "AuthError.status" } - }, - { - "id": 1094, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1095, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1096, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1098, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1097, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1099, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1098, 1097, 1099] - } - ] - } - } - } - ] } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1087] + "children": [1142] }, { "title": "Properties", "kind": 1024, - "children": [1092, 1093] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1094] + "children": [1150, 1148, 1149] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 50, + "line": 55, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 1101, + "id": 1153, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 1113, + "id": 1161, "name": "AuthInvalidTokenResponseError" }, { "type": "reference", - "id": 1125, + "id": 1169, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 1138, + "id": 1178, "name": "AuthImplicitGrantRedirectError" }, { "type": "reference", - "id": 1163, + "id": 1205, "name": "AuthPKCEGrantCodeExchangeError" }, { "type": "reference", - "id": 1188, + "id": 1232, "name": "AuthRetryableFetchError" }, { "type": "reference", - "id": 1202, + "id": 1242, "name": "AuthWeakPasswordError" } ] @@ -3270,7 +3148,7 @@ ], "type": { "type": "reference", - "id": 1012, + "id": 1021, "name": "GoTrueAdminMFAApi" } }, @@ -3306,7 +3184,7 @@ "flags": {}, "type": { "type": "reference", - "id": 685, + "id": 705, "name": "AdminUserAttributes" } } @@ -3316,7 +3194,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -3372,7 +3250,7 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If true, then the user will be soft-deleted (setting `deleted_at` to the current timestamp and disabling their account while preserving their data) from the auth schema.\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.\n" + "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.\n" }, "type": { "type": "intrinsic", @@ -3386,7 +3264,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -3429,7 +3307,7 @@ "flags": {}, "type": { "type": "reference", - "id": 855, + "id": 876, "name": "GenerateLinkParams" } } @@ -3439,7 +3317,7 @@ "typeArguments": [ { "type": "reference", - "id": 856, + "id": 877, "name": "GenerateLinkResponse" } ], @@ -3494,7 +3372,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -3625,7 +3503,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -3674,7 +3552,7 @@ }, "type": { "type": "reference", - "id": 1039, + "id": 1048, "name": "PageParams" } } @@ -3754,7 +3632,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } } @@ -3771,7 +3649,7 @@ }, { "type": "reference", - "id": 1032, + "id": 1041, "name": "Pagination" } ] @@ -3879,7 +3757,7 @@ ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -4022,7 +3900,7 @@ }, { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] @@ -4092,7 +3970,7 @@ }, "type": { "type": "reference", - "id": 685, + "id": 705, "name": "AdminUserAttributes" } } @@ -4102,7 +3980,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -4155,7 +4033,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 175, + "line": 182, "character": 2 } ], @@ -4178,7 +4056,7 @@ "flags": {}, "type": { "type": "reference", - "id": 490, + "id": 505, "name": "GoTrueClientOptions" } } @@ -4203,7 +4081,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 125, + "line": 132, "character": 2 } ], @@ -4225,18 +4103,18 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 129, + "line": 136, "character": 2 } ], "type": { "type": "reference", - "id": 967, + "id": 972, "name": "GoTrueMFAApi" } }, { - "id": 143, + "id": 144, "name": "exchangeCodeForSession", "kind": 2048, "kindString": "Method", @@ -4244,13 +4122,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 571, + "line": 584, "character": 8 } ], "signatures": [ { - "id": 144, + "id": 145, "name": "exchangeCodeForSession", "kind": 4096, "kindString": "Call signature", @@ -4260,7 +4138,7 @@ }, "parameters": [ { - "id": 145, + "id": 146, "name": "authCode", "kind": 32768, "kindString": "Parameter", @@ -4276,7 +4154,7 @@ "typeArguments": [ { "type": "reference", - "id": 557, + "id": 574, "name": "AuthTokenResponse" } ], @@ -4288,7 +4166,7 @@ ] }, { - "id": 182, + "id": 183, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -4296,13 +4174,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 926, + "line": 935, "character": 8 } ], "signatures": [ { - "id": 183, + "id": 184, "name": "getSession", "kind": 4096, "kindString": "Call signature", @@ -4320,14 +4198,14 @@ { "type": "reflection", "declaration": { - "id": 184, + "id": 185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 185, + "id": 186, "name": "data", "kind": 1024, "kindString": "Property", @@ -4342,14 +4220,14 @@ "type": { "type": "reflection", "declaration": { - "id": 186, + "id": 187, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 187, + "id": 188, "name": "session", "kind": 1024, "kindString": "Property", @@ -4363,7 +4241,7 @@ ], "type": { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } } @@ -4372,14 +4250,14 @@ { "title": "Properties", "kind": 1024, - "children": [187] + "children": [188] } ] } } }, { - "id": 188, + "id": 189, "name": "error", "kind": 1024, "kindString": "Property", @@ -4401,7 +4279,7 @@ { "title": "Properties", "kind": 1024, - "children": [185, 188] + "children": [186, 189] } ] } @@ -4409,14 +4287,14 @@ { "type": "reflection", "declaration": { - "id": 189, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 190, + "id": 191, "name": "data", "kind": 1024, "kindString": "Property", @@ -4431,14 +4309,14 @@ "type": { "type": "reflection", "declaration": { - "id": 191, + "id": 192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 192, + "id": 193, "name": "session", "kind": 1024, "kindString": "Property", @@ -4460,14 +4338,14 @@ { "title": "Properties", "kind": 1024, - "children": [192] + "children": [193] } ] } } }, { - "id": 193, + "id": 194, "name": "error", "kind": 1024, "kindString": "Property", @@ -4481,7 +4359,7 @@ ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -4490,7 +4368,7 @@ { "title": "Properties", "kind": 1024, - "children": [190, 193] + "children": [191, 194] } ] } @@ -4498,14 +4376,14 @@ { "type": "reflection", "declaration": { - "id": 194, + "id": 195, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 195, + "id": 196, "name": "data", "kind": 1024, "kindString": "Property", @@ -4520,14 +4398,14 @@ "type": { "type": "reflection", "declaration": { - "id": 196, + "id": 197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 197, + "id": 198, "name": "session", "kind": 1024, "kindString": "Property", @@ -4549,14 +4427,14 @@ { "title": "Properties", "kind": 1024, - "children": [197] + "children": [198] } ] } } }, { - "id": 198, + "id": 199, "name": "error", "kind": 1024, "kindString": "Property", @@ -4578,7 +4456,7 @@ { "title": "Properties", "kind": 1024, - "children": [195, 198] + "children": [196, 199] } ] } @@ -4594,7 +4472,7 @@ ] }, { - "id": 245, + "id": 246, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -4608,7 +4486,7 @@ ], "signatures": [ { - "id": 246, + "id": 247, "name": "getUser", "kind": 4096, "kindString": "Call signature", @@ -4618,7 +4496,7 @@ }, "parameters": [ { - "id": 247, + "id": 248, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -4639,7 +4517,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -4651,7 +4529,7 @@ ] }, { - "id": 349, + "id": 362, "name": "getUserIdentities", "kind": 2048, "kindString": "Method", @@ -4659,13 +4537,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1710, + "line": 1735, "character": 8 } ], "signatures": [ { - "id": 350, + "id": 363, "name": "getUserIdentities", "kind": 4096, "kindString": "Call signature", @@ -4682,14 +4560,14 @@ { "type": "reflection", "declaration": { - "id": 351, + "id": 364, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 352, + "id": 365, "name": "data", "kind": 1024, "kindString": "Property", @@ -4697,21 +4575,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1712, + "line": 1737, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 353, + "id": 366, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 367, "name": "identities", "kind": 1024, "kindString": "Property", @@ -4719,7 +4597,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1713, + "line": 1738, "character": 10 } ], @@ -4727,7 +4605,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 630, + "id": 648, "name": "UserIdentity" } } @@ -4737,14 +4615,14 @@ { "title": "Properties", "kind": 1024, - "children": [354] + "children": [367] } ] } } }, { - "id": 355, + "id": 368, "name": "error", "kind": 1024, "kindString": "Property", @@ -4752,7 +4630,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1715, + "line": 1740, "character": 8 } ], @@ -4766,7 +4644,7 @@ { "title": "Properties", "kind": 1024, - "children": [352, 355] + "children": [365, 368] } ] } @@ -4774,14 +4652,14 @@ { "type": "reflection", "declaration": { - "id": 356, + "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 370, "name": "data", "kind": 1024, "kindString": "Property", @@ -4789,7 +4667,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1717, + "line": 1742, "character": 8 } ], @@ -4799,7 +4677,7 @@ } }, { - "id": 358, + "id": 371, "name": "error", "kind": 1024, "kindString": "Property", @@ -4807,13 +4685,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1717, + "line": 1742, "character": 20 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -4822,7 +4700,7 @@ { "title": "Properties", "kind": 1024, - "children": [357, 358] + "children": [370, 371] } ] } @@ -4838,7 +4716,7 @@ ] }, { - "id": 127, + "id": 128, "name": "initialize", "kind": 2048, "kindString": "Method", @@ -4846,13 +4724,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 278, + "line": 286, "character": 8 } ], "signatures": [ { - "id": 128, + "id": 129, "name": "initialize", "kind": 4096, "kindString": "Call signature", @@ -4865,7 +4743,7 @@ "typeArguments": [ { "type": "reference", - "id": 1022, + "id": 1031, "name": "InitializeResult" } ], @@ -4877,7 +4755,7 @@ ] }, { - "id": 359, + "id": 372, "name": "linkIdentity", "kind": 2048, "kindString": "Method", @@ -4885,13 +4763,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1734, + "line": 1759, "character": 8 } ], "signatures": [ { - "id": 360, + "id": 373, "name": "linkIdentity", "kind": 4096, "kindString": "Call signature", @@ -4901,14 +4779,14 @@ }, "parameters": [ { - "id": 361, + "id": 374, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials" } } @@ -4918,7 +4796,7 @@ "typeArguments": [ { "type": "reference", - "id": 585, + "id": 602, "name": "OAuthResponse" } ], @@ -4930,7 +4808,7 @@ ] }, { - "id": 321, + "id": 334, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -4938,13 +4816,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1608, + "line": 1633, "character": 2 } ], "signatures": [ { - "id": 322, + "id": 335, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -4954,7 +4832,7 @@ }, "parameters": [ { - "id": 323, + "id": 336, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -4965,33 +4843,33 @@ "type": { "type": "reflection", "declaration": { - "id": 324, + "id": 337, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 325, + "id": 338, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 326, + "id": 339, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 480, + "id": 495, "name": "AuthChangeEvent" } }, { - "id": 327, + "id": 340, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -5005,7 +4883,7 @@ }, { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } ] @@ -5042,14 +4920,14 @@ "type": { "type": "reflection", "declaration": { - "id": 328, + "id": 341, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 329, + "id": 342, "name": "data", "kind": 1024, "kindString": "Property", @@ -5057,21 +4935,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1611, + "line": 1636, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 330, + "id": 343, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 331, + "id": 344, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -5079,13 +4957,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1611, + "line": 1636, "character": 12 } ], "type": { "type": "reference", - "id": 696, + "id": 718, "name": "Subscription" } } @@ -5094,7 +4972,7 @@ { "title": "Properties", "kind": 1024, - "children": [331] + "children": [344] } ] } @@ -5105,7 +4983,7 @@ { "title": "Properties", "kind": 1024, - "children": [329] + "children": [342] } ] } @@ -5114,7 +4992,7 @@ ] }, { - "id": 175, + "id": 176, "name": "reauthenticate", "kind": 2048, "kindString": "Method", @@ -5122,13 +5000,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 838, + "line": 851, "character": 8 } ], "signatures": [ { - "id": 176, + "id": 177, "name": "reauthenticate", "kind": 4096, "kindString": "Call signature", @@ -5141,7 +5019,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -5153,7 +5031,7 @@ ] }, { - "id": 282, + "id": 283, "name": "refreshSession", "kind": 2048, "kindString": "Method", @@ -5161,13 +5039,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1374, + "line": 1382, "character": 8 } ], "signatures": [ { - "id": 283, + "id": 284, "name": "refreshSession", "kind": 4096, "kindString": "Call signature", @@ -5177,7 +5055,7 @@ }, "parameters": [ { - "id": 284, + "id": 285, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -5190,14 +5068,14 @@ "type": { "type": "reflection", "declaration": { - "id": 285, + "id": 286, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 286, + "id": 287, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -5205,7 +5083,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1374, + "line": 1382, "character": 42 } ], @@ -5219,7 +5097,7 @@ { "title": "Properties", "kind": 1024, - "children": [286] + "children": [287] } ] } @@ -5231,7 +5109,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -5243,7 +5121,7 @@ ] }, { - "id": 179, + "id": 180, "name": "resend", "kind": 2048, "kindString": "Method", @@ -5251,13 +5129,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 873, + "line": 886, "character": 8 } ], "signatures": [ { - "id": 180, + "id": 181, "name": "resend", "kind": 4096, "kindString": "Call signature", @@ -5267,14 +5145,14 @@ }, "parameters": [ { - "id": 181, + "id": 182, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 803, + "id": 824, "name": "ResendParams" } } @@ -5284,7 +5162,7 @@ "typeArguments": [ { "type": "reference", - "id": 542, + "id": 559, "name": "AuthOtpResponse" } ], @@ -5296,7 +5174,7 @@ ] }, { - "id": 335, + "id": 348, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", @@ -5304,13 +5182,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1664, + "line": 1689, "character": 8 } ], "signatures": [ { - "id": 336, + "id": 349, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", @@ -5320,7 +5198,7 @@ }, "parameters": [ { - "id": 337, + "id": 350, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -5334,7 +5212,7 @@ } }, { - "id": 338, + "id": 351, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5342,14 +5220,14 @@ "type": { "type": "reflection", "declaration": { - "id": 339, + "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 341, + "id": 354, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -5362,7 +5240,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1668, + "line": 1693, "character": 6 } ], @@ -5372,7 +5250,7 @@ } }, { - "id": 340, + "id": 353, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -5385,7 +5263,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1667, + "line": 1692, "character": 6 } ], @@ -5399,7 +5277,7 @@ { "title": "Properties", "kind": 1024, - "children": [341, 340] + "children": [354, 353] } ] } @@ -5416,14 +5294,14 @@ { "type": "reflection", "declaration": { - "id": 342, + "id": 355, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 343, + "id": 356, "name": "data", "kind": 1024, "kindString": "Property", @@ -5431,14 +5309,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1672, + "line": 1697, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 344, + "id": 357, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5447,7 +5325,7 @@ } }, { - "id": 345, + "id": 358, "name": "error", "kind": 1024, "kindString": "Property", @@ -5455,7 +5333,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1673, + "line": 1698, "character": 8 } ], @@ -5469,7 +5347,7 @@ { "title": "Properties", "kind": 1024, - "children": [343, 345] + "children": [356, 358] } ] } @@ -5477,14 +5355,14 @@ { "type": "reflection", "declaration": { - "id": 346, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 347, + "id": 360, "name": "data", "kind": 1024, "kindString": "Property", @@ -5492,7 +5370,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1675, + "line": 1700, "character": 8 } ], @@ -5502,7 +5380,7 @@ } }, { - "id": 348, + "id": 361, "name": "error", "kind": 1024, "kindString": "Property", @@ -5510,13 +5388,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1675, + "line": 1700, "character": 20 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -5525,7 +5403,7 @@ { "title": "Properties", "kind": 1024, - "children": [347, 348] + "children": [360, 361] } ] } @@ -5541,7 +5419,7 @@ ] }, { - "id": 270, + "id": 271, "name": "setSession", "kind": 2048, "kindString": "Method", @@ -5549,13 +5427,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1299, + "line": 1307, "character": 8 } ], "signatures": [ { - "id": 271, + "id": 272, "name": "setSession", "kind": 4096, "kindString": "Call signature", @@ -5565,7 +5443,7 @@ }, "parameters": [ { - "id": 272, + "id": 273, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -5576,14 +5454,14 @@ "type": { "type": "reflection", "declaration": { - "id": 273, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 274, + "id": 275, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -5591,7 +5469,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1300, + "line": 1308, "character": 4 } ], @@ -5601,7 +5479,7 @@ } }, { - "id": 275, + "id": 276, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -5609,7 +5487,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1301, + "line": 1309, "character": 4 } ], @@ -5623,7 +5501,7 @@ { "title": "Properties", "kind": 1024, - "children": [274, 275] + "children": [275, 276] } ] } @@ -5635,7 +5513,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -5647,7 +5525,7 @@ ] }, { - "id": 131, + "id": 132, "name": "signInAnonymously", "kind": 2048, "kindString": "Method", @@ -5655,13 +5533,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 368, + "line": 389, "character": 8 } ], "signatures": [ { - "id": 132, + "id": 133, "name": "signInAnonymously", "kind": 4096, "kindString": "Call signature", @@ -5672,7 +5550,7 @@ }, "parameters": [ { - "id": 133, + "id": 134, "name": "credentials", "kind": 32768, "kindString": "Parameter", @@ -5681,7 +5559,7 @@ }, "type": { "type": "reference", - "id": 706, + "id": 726, "name": "SignInAnonymouslyCredentials" } } @@ -5691,7 +5569,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -5703,7 +5581,7 @@ ] }, { - "id": 163, + "id": 164, "name": "signInWithIdToken", "kind": 2048, "kindString": "Method", @@ -5711,13 +5589,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 621, + "line": 644, "character": 8 } ], "signatures": [ { - "id": 164, + "id": 165, "name": "signInWithIdToken", "kind": 4096, "kindString": "Call signature", @@ -5727,14 +5605,14 @@ }, "parameters": [ { - "id": 165, + "id": 166, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 772, + "id": 792, "name": "SignInWithIdTokenCredentials" } } @@ -5744,7 +5622,7 @@ "typeArguments": [ { "type": "reference", - "id": 557, + "id": 574, "name": "AuthTokenResponse" } ], @@ -5756,7 +5634,7 @@ ] }, { - "id": 140, + "id": 141, "name": "signInWithOAuth", "kind": 2048, "kindString": "Method", @@ -5764,13 +5642,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 557, + "line": 572, "character": 8 } ], "signatures": [ { - "id": 141, + "id": 142, "name": "signInWithOAuth", "kind": 4096, "kindString": "Call signature", @@ -5780,14 +5658,14 @@ }, "parameters": [ { - "id": 142, + "id": 143, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials" } } @@ -5797,7 +5675,7 @@ "typeArguments": [ { "type": "reference", - "id": 585, + "id": 602, "name": "OAuthResponse" } ], @@ -5809,7 +5687,7 @@ ] }, { - "id": 166, + "id": 167, "name": "signInWithOtp", "kind": 2048, "kindString": "Method", @@ -5817,13 +5695,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 678, + "line": 699, "character": 8 } ], "signatures": [ { - "id": 167, + "id": 168, "name": "signInWithOtp", "kind": 4096, "kindString": "Call signature", @@ -5834,14 +5712,14 @@ }, "parameters": [ { - "id": 168, + "id": 169, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 742, + "id": 762, "name": "SignInWithPasswordlessCredentials" } } @@ -5851,7 +5729,7 @@ "typeArguments": [ { "type": "reference", - "id": 542, + "id": 559, "name": "AuthOtpResponse" } ], @@ -5863,7 +5741,7 @@ ] }, { - "id": 137, + "id": 138, "name": "signInWithPassword", "kind": 2048, "kindString": "Method", @@ -5871,13 +5749,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 492, + "line": 509, "character": 8 } ], "signatures": [ { - "id": 138, + "id": 139, "name": "signInWithPassword", "kind": 4096, "kindString": "Call signature", @@ -5888,14 +5766,14 @@ }, "parameters": [ { - "id": 139, + "id": 140, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 729, + "id": 749, "name": "SignInWithPasswordCredentials" } } @@ -5905,7 +5783,7 @@ "typeArguments": [ { "type": "reference", - "id": 570, + "id": 587, "name": "AuthTokenResponsePassword" } ], @@ -5917,7 +5795,7 @@ ] }, { - "id": 172, + "id": 173, "name": "signInWithSSO", "kind": 2048, "kindString": "Method", @@ -5925,13 +5803,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 799, + "line": 813, "character": 8 } ], "signatures": [ { - "id": 173, + "id": 174, "name": "signInWithSSO", "kind": 4096, "kindString": "Call signature", @@ -5942,14 +5820,14 @@ }, "parameters": [ { - "id": 174, + "id": 175, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 817, + "id": 838, "name": "SignInWithSSO" } } @@ -5959,7 +5837,7 @@ "typeArguments": [ { "type": "reference", - "id": 598, + "id": 615, "name": "SSOResponse" } ], @@ -5971,7 +5849,7 @@ ] }, { - "id": 311, + "id": 324, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -5979,13 +5857,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1568, + "line": 1589, "character": 8 } ], "signatures": [ { - "id": 312, + "id": 325, "name": "signOut", "kind": 4096, "kindString": "Call signature", @@ -5996,14 +5874,14 @@ }, "parameters": [ { - "id": 313, + "id": 326, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1043, + "id": 1052, "name": "SignOut" }, "defaultValue": "..." @@ -6015,14 +5893,14 @@ { "type": "reflection", "declaration": { - "id": 314, + "id": 327, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 315, + "id": 328, "name": "error", "kind": 1024, "kindString": "Property", @@ -6030,7 +5908,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1568, + "line": 1589, "character": 67 } ], @@ -6043,7 +5921,7 @@ }, { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] @@ -6054,7 +5932,7 @@ { "title": "Properties", "kind": 1024, - "children": [315] + "children": [328] } ] } @@ -6068,7 +5946,7 @@ ] }, { - "id": 134, + "id": 135, "name": "signUp", "kind": 2048, "kindString": "Method", @@ -6076,13 +5954,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 413, + "line": 432, "character": 8 } ], "signatures": [ { - "id": 135, + "id": 136, "name": "signUp", "kind": 4096, "kindString": "Call signature", @@ -6094,14 +5972,14 @@ }, "parameters": [ { - "id": 136, + "id": 137, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 712, + "id": 732, "name": "SignUpWithPasswordCredentials" } } @@ -6111,7 +5989,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -6123,7 +6001,7 @@ ] }, { - "id": 417, + "id": 430, "name": "startAutoRefresh", "kind": 2048, "kindString": "Method", @@ -6131,13 +6009,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 2142, + "line": 2174, "character": 8 } ], "signatures": [ { - "id": 418, + "id": 431, "name": "startAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -6162,7 +6040,7 @@ ] }, { - "id": 419, + "id": 432, "name": "stopAutoRefresh", "kind": 2048, "kindString": "Method", @@ -6170,13 +6048,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 2155, + "line": 2187, "character": 8 } ], "signatures": [ { - "id": 420, + "id": 433, "name": "stopAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -6201,7 +6079,7 @@ ] }, { - "id": 362, + "id": 375, "name": "unlinkIdentity", "kind": 2048, "kindString": "Method", @@ -6209,13 +6087,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1770, + "line": 1795, "character": 8 } ], "signatures": [ { - "id": 363, + "id": 376, "name": "unlinkIdentity", "kind": 4096, "kindString": "Call signature", @@ -6225,14 +6103,14 @@ }, "parameters": [ { - "id": 364, + "id": 377, "name": "identity", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 630, + "id": 648, "name": "UserIdentity" } } @@ -6246,14 +6124,14 @@ { "type": "reflection", "declaration": { - "id": 365, + "id": 378, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 366, + "id": 379, "name": "data", "kind": 1024, "kindString": "Property", @@ -6261,14 +6139,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1772, + "line": 1797, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 367, + "id": 380, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6277,7 +6155,7 @@ } }, { - "id": 368, + "id": 381, "name": "error", "kind": 1024, "kindString": "Property", @@ -6285,7 +6163,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1773, + "line": 1798, "character": 8 } ], @@ -6299,7 +6177,7 @@ { "title": "Properties", "kind": 1024, - "children": [366, 368] + "children": [379, 381] } ] } @@ -6307,14 +6185,14 @@ { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 370, + "id": 383, "name": "data", "kind": 1024, "kindString": "Property", @@ -6322,7 +6200,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1775, + "line": 1800, "character": 8 } ], @@ -6332,7 +6210,7 @@ } }, { - "id": 371, + "id": 384, "name": "error", "kind": 1024, "kindString": "Property", @@ -6340,13 +6218,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1775, + "line": 1800, "character": 20 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -6355,7 +6233,7 @@ { "title": "Properties", "kind": 1024, - "children": [370, 371] + "children": [383, 384] } ] } @@ -6371,7 +6249,7 @@ ] }, { - "id": 251, + "id": 252, "name": "updateUser", "kind": 2048, "kindString": "Method", @@ -6379,13 +6257,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1219, + "line": 1227, "character": 8 } ], "signatures": [ { - "id": 252, + "id": 253, "name": "updateUser", "kind": 4096, "kindString": "Call signature", @@ -6395,19 +6273,19 @@ }, "parameters": [ { - "id": 253, + "id": 254, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes" } }, { - "id": 254, + "id": 255, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6415,14 +6293,14 @@ "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 256, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 256, + "id": 257, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -6432,7 +6310,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1222, + "line": 1230, "character": 6 } ], @@ -6446,7 +6324,7 @@ { "title": "Properties", "kind": 1024, - "children": [256] + "children": [257] } ] } @@ -6459,7 +6337,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -6471,7 +6349,7 @@ ] }, { - "id": 169, + "id": 170, "name": "verifyOtp", "kind": 2048, "kindString": "Method", @@ -6479,13 +6357,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 733, + "line": 752, "character": 8 } ], "signatures": [ { - "id": 170, + "id": 171, "name": "verifyOtp", "kind": 4096, "kindString": "Call signature", @@ -6495,14 +6373,14 @@ }, "parameters": [ { - "id": 171, + "id": 172, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 781, + "id": 802, "name": "VerifyOtpParams" } } @@ -6512,7 +6390,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -6539,42 +6417,42 @@ "title": "Methods", "kind": 2048, "children": [ - 143, 182, 245, 349, 127, 359, 321, 175, 282, 179, 335, 270, 131, 163, 140, 166, 137, - 172, 311, 134, 417, 419, 362, 251, 169 + 144, 183, 246, 362, 128, 372, 334, 176, 283, 180, 348, 271, 132, 164, 141, 167, 138, + 173, 324, 135, 430, 432, 375, 252, 170 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 116, + "line": 123, "character": 21 } ] }, { - "id": 470, + "id": 485, "name": "NavigatorLockAcquireTimeoutError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 471, + "id": 486, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 472, + "id": 487, "name": "new NavigatorLockAcquireTimeoutError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 473, + "id": 488, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -6587,7 +6465,7 @@ ], "type": { "type": "reference", - "id": 470, + "id": 485, "name": "NavigatorLockAcquireTimeoutError" }, "inheritedFrom": { @@ -6602,7 +6480,7 @@ } }, { - "id": 474, + "id": 489, "name": "isAcquireTimeout", "kind": 1024, "kindString": "Property", @@ -6632,12 +6510,12 @@ { "title": "Constructors", "kind": 512, - "children": [471] + "children": [486] }, { "title": "Properties", "kind": 1024, - "children": [474] + "children": [489] } ], "sources": [ @@ -6655,7 +6533,7 @@ ] }, { - "id": 627, + "id": 644, "name": "AMREntry", "kind": 256, "kindString": "Interface", @@ -6672,7 +6550,7 @@ }, "children": [ { - "id": 628, + "id": 645, "name": "method", "kind": 1024, "kindString": "Property", @@ -6683,17 +6561,53 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 262, + "line": 268, "character": 2 } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "literal", + "value": "password" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 646, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "literal", + "value": "otp" + }, + { + "type": "literal", + "value": "oauth" + }, + { + "type": "literal", + "value": "mfa/totp" + } + ] } }, { - "id": 629, + "id": 647, "name": "timestamp", "kind": 1024, "kindString": "Property", @@ -6704,7 +6618,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 268, + "line": 274, "character": 2 } ], @@ -6718,26 +6632,26 @@ { "title": "Properties", "kind": 1024, - "children": [628, 629] + "children": [645, 647] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 260, + "line": 266, "character": 17 } ] }, { - "id": 685, + "id": 705, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 687, + "id": 707, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -6751,7 +6665,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 398, + "line": 404, "character": 2 } ], @@ -6761,7 +6675,7 @@ } }, { - "id": 690, + "id": 710, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -6775,7 +6689,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 424, + "line": 430, "character": 2 } ], @@ -6785,7 +6699,7 @@ } }, { - "id": 694, + "id": 717, "name": "email", "kind": 1024, "kindString": "Property", @@ -6798,7 +6712,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -6812,7 +6726,7 @@ } }, { - "id": 688, + "id": 708, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -6826,7 +6740,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 411, "character": 2 } ], @@ -6836,7 +6750,31 @@ } }, { - "id": 693, + "id": 713, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `id` for the user.", + "text": "Allows you to overwrite the default `id` set for the user.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 455, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 715, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -6850,7 +6788,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -6864,7 +6802,7 @@ } }, { - "id": 692, + "id": 714, "name": "password", "kind": 1024, "kindString": "Property", @@ -6877,7 +6815,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -6891,7 +6829,31 @@ } }, { - "id": 695, + "id": 712, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `password_hash` for the user's password.", + "text": "Allows 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.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 716, "name": "phone", "kind": 1024, "kindString": "Property", @@ -6904,7 +6866,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -6918,7 +6880,7 @@ } }, { - "id": 689, + "id": 709, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -6932,7 +6894,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 412, + "line": 418, "character": 2 } ], @@ -6942,7 +6904,7 @@ } }, { - "id": 691, + "id": 711, "name": "role", "kind": 1024, "kindString": "Property", @@ -6956,7 +6918,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 439, "character": 2 } ], @@ -6966,7 +6928,7 @@ } }, { - "id": 686, + "id": 706, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -6980,7 +6942,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 388, + "line": 394, "character": 2 } ], @@ -6994,13 +6956,13 @@ { "title": "Properties", "kind": 1024, - "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] + "children": [707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 377, + "line": 383, "character": 17 } ], @@ -7010,7 +6972,7 @@ "typeArguments": [ { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes" }, { @@ -7025,7 +6987,7 @@ ] }, { - "id": 642, + "id": 660, "name": "Factor", "kind": 256, "kindString": "Interface", @@ -7049,7 +7011,7 @@ }, "children": [ { - "id": 647, + "id": 666, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -7057,7 +7019,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 307, + "line": 312, "character": 2 } ], @@ -7067,13 +7029,64 @@ } }, { - "id": 645, + "id": 663, "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." + "shortText": "Type of factor. `totp` and `phone` supported with this version" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 307, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 664, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] + } + }, + { + "id": 662, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." }, "sources": [ { @@ -7088,30 +7101,7 @@ } }, { - "id": 644, - "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": 296, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 643, + "id": 661, "name": "id", "kind": 1024, "kindString": "Property", @@ -7122,7 +7112,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 293, + "line": 299, "character": 2 } ], @@ -7132,7 +7122,7 @@ } }, { - "id": 646, + "id": 665, "name": "status", "kind": 1024, "kindString": "Property", @@ -7143,7 +7133,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 305, + "line": 310, "character": 2 } ], @@ -7162,7 +7152,7 @@ } }, { - "id": 648, + "id": 667, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -7170,7 +7160,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 308, + "line": 313, "character": 2 } ], @@ -7184,26 +7174,26 @@ { "title": "Properties", "kind": 1024, - "children": [647, 645, 644, 643, 646, 648] + "children": [666, 663, 662, 661, 665, 667] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 291, + "line": 297, "character": 17 } ] }, { - "id": 852, + "id": 873, "name": "GenerateLinkOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 853, + "id": 874, "name": "data", "kind": 1024, "kindString": "Property", @@ -7217,7 +7207,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 728, + "line": 746, "character": 2 } ], @@ -7227,7 +7217,7 @@ } }, { - "id": 854, + "id": 875, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -7240,7 +7230,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 730, + "line": 748, "character": 2 } ], @@ -7254,19 +7244,19 @@ { "title": "Properties", "kind": 1024, - "children": [853, 854] + "children": [874, 875] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 722, + "line": 740, "character": 17 } ] }, { - "id": 1012, + "id": 1021, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -7282,14 +7272,14 @@ }, "children": [ { - "id": 1016, + "id": 1025, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1017, + "id": 1026, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -7309,14 +7299,14 @@ }, "parameters": [ { - "id": 1018, + "id": 1027, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams" } } @@ -7326,7 +7316,7 @@ "typeArguments": [ { "type": "reference", - "id": 987, + "id": 996, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -7338,14 +7328,14 @@ ] }, { - "id": 1013, + "id": 1022, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1014, + "id": 1023, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -7355,14 +7345,14 @@ }, "parameters": [ { - "id": 1015, + "id": 1024, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams" } } @@ -7372,7 +7362,7 @@ "typeArguments": [ { "type": "reference", - "id": 1000, + "id": 1009, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -7388,19 +7378,19 @@ { "title": "Methods", "kind": 2048, - "children": [1016, 1013] + "children": [1025, 1022] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1062, + "line": 1049, "character": 17 } ] }, { - "id": 967, + "id": 972, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -7410,14 +7400,14 @@ }, "children": [ { - "id": 971, + "id": 980, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 972, + "id": 981, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -7427,14 +7417,14 @@ }, "parameters": [ { - "id": 973, + "id": 982, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 890, + "id": 907, "name": "MFAChallengeParams" } } @@ -7444,7 +7434,7 @@ "typeArguments": [ { "type": "reference", - "id": 935, + "id": 938, "name": "AuthMFAChallengeResponse" } ], @@ -7456,14 +7446,14 @@ ] }, { - "id": 980, + "id": 989, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 981, + "id": 990, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -7473,14 +7463,14 @@ }, "parameters": [ { - "id": 982, + "id": 991, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 893, + "id": 911, "name": "MFAChallengeAndVerifyParams" } } @@ -7490,7 +7480,7 @@ "typeArguments": [ { "type": "reference", - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse" } ], @@ -7502,14 +7492,14 @@ ] }, { - "id": 968, + "id": 973, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 969, + "id": 974, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -7520,14 +7510,82 @@ }, "parameters": [ { - "id": 970, + "id": 975, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 877, + "id": 1055, + "name": "MFAEnrollTOTPParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1065, + "name": "AuthMFAEnrollTOTPResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + }, + { + "id": 976, + "name": "enroll", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 977, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 1060, + "name": "MFAEnrollPhoneParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1081, + "name": "AuthMFAEnrollPhoneResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + }, + { + "id": 978, + "name": "enroll", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 979, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 898, "name": "MFAEnrollParams" } } @@ -7537,7 +7595,7 @@ "typeArguments": [ { "type": "reference", - "id": 910, + "id": 928, "name": "AuthMFAEnrollResponse" } ], @@ -7549,14 +7607,14 @@ ] }, { - "id": 985, + "id": 994, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 986, + "id": 995, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -7570,7 +7628,7 @@ "typeArguments": [ { "type": "reference", - "id": 956, + "id": 961, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -7582,14 +7640,14 @@ ] }, { - "id": 983, + "id": 992, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 984, + "id": 993, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -7616,7 +7674,7 @@ "typeArguments": [ { "type": "reference", - "id": 945, + "id": 949, "name": "AuthMFAListFactorsResponse" } ], @@ -7628,14 +7686,14 @@ ] }, { - "id": 977, + "id": 986, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 978, + "id": 987, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -7645,14 +7703,14 @@ }, "parameters": [ { - "id": 979, + "id": 988, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 882, + "id": 899, "name": "MFAUnenrollParams" } } @@ -7662,7 +7720,7 @@ "typeArguments": [ { "type": "reference", - "id": 926, + "id": 929, "name": "AuthMFAUnenrollResponse" } ], @@ -7674,14 +7732,14 @@ ] }, { - "id": 974, + "id": 983, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 975, + "id": 984, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -7691,14 +7749,14 @@ }, "parameters": [ { - "id": 976, + "id": 985, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 885, + "id": 902, "name": "MFAVerifyParams" } } @@ -7708,7 +7766,7 @@ "typeArguments": [ { "type": "reference", - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse" } ], @@ -7724,26 +7782,26 @@ { "title": "Methods", "kind": 2048, - "children": [971, 980, 968, 985, 983, 977, 974] + "children": [980, 989, 973, 994, 992, 986, 983] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 949, + "line": 934, "character": 17 } ] }, { - "id": 618, + "id": 635, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 621, + "id": 638, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -7754,7 +7812,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 241, "character": 2 } ], @@ -7764,7 +7822,7 @@ } }, { - "id": 624, + "id": 641, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -7777,7 +7835,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 247, + "line": 253, "character": 2 } ], @@ -7787,7 +7845,7 @@ } }, { - "id": 623, + "id": 640, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -7798,7 +7856,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 243, + "line": 249, "character": 2 } ], @@ -7808,7 +7866,7 @@ } }, { - "id": 620, + "id": 637, "name": "provider_refresh_token", "kind": 1024, "kindString": "Property", @@ -7821,7 +7879,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 231, + "line": 237, "character": 2 } ], @@ -7840,7 +7898,7 @@ } }, { - "id": 619, + "id": 636, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -7853,7 +7911,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 226, + "line": 232, "character": 2 } ], @@ -7872,7 +7930,7 @@ } }, { - "id": 622, + "id": 639, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -7883,7 +7941,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 245, "character": 2 } ], @@ -7893,7 +7951,7 @@ } }, { - "id": 625, + "id": 642, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -7901,7 +7959,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 248, + "line": 254, "character": 2 } ], @@ -7911,7 +7969,7 @@ } }, { - "id": 626, + "id": 643, "name": "user", "kind": 1024, "kindString": "Property", @@ -7919,13 +7977,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 249, + "line": 255, "character": 2 } ], "type": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } } @@ -7934,26 +7992,26 @@ { "title": "Properties", "kind": 1024, - "children": [621, 624, 623, 620, 619, 622, 625, 626] + "children": [638, 641, 640, 637, 636, 639, 642, 643] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 222, + "line": 228, "character": 17 } ] }, { - "id": 696, + "id": 718, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 697, + "id": 719, "name": "id", "kind": 1024, "kindString": "Property", @@ -7964,7 +8022,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 462, "character": 2 } ], @@ -7974,7 +8032,7 @@ } }, { - "id": 698, + "id": 720, "name": "callback", "kind": 2048, "kindString": "Method", @@ -7982,13 +8040,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 444, + "line": 466, "character": 2 } ], "signatures": [ { - "id": 699, + "id": 721, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -7998,19 +8056,19 @@ }, "parameters": [ { - "id": 700, + "id": 722, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 480, + "id": 495, "name": "AuthChangeEvent" } }, { - "id": 701, + "id": 723, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -8024,7 +8082,7 @@ }, { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } ] @@ -8039,7 +8097,7 @@ ] }, { - "id": 702, + "id": 724, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -8047,13 +8105,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 448, + "line": 470, "character": 2 } ], "signatures": [ { - "id": 703, + "id": 725, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -8073,233 +8131,37 @@ { "title": "Properties", "kind": 1024, - "children": [697] + "children": [719] }, { "title": "Methods", "kind": 2048, - "children": [698, 702] + "children": [720, 724] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 436, + "line": 458, "character": 17 } ] }, { - "id": 704, - "name": "UpdatableFactorAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 705, - "name": "friendlyName", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 452, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [705] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 451, - "character": 17 - } - ] - }, - { - "id": 656, + "id": 675, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 667, + "id": 686, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 331, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 322, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 649, - "name": "UserAppMetadata" - } - }, - { - "id": 660, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 324, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 661, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 325, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 671, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 335, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 670, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 334, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 668, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 332, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 663, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 327, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 672, - "name": "email_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -8313,39 +8175,34 @@ } }, { - "id": 678, - "name": "factors", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 642, - "name": "Factor" - } - } - }, - { - "id": 657, - "name": "id", + "id": 677, + "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 321, + "line": 327, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 668, + "name": "UserAppMetadata" + } + }, + { + "id": 679, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 329, "character": 2 } ], @@ -8355,32 +8212,8 @@ } }, { - "id": 677, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 341, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 630, - "name": "UserIdentity" - } - } - }, - { - "id": 666, - "name": "invited_at", + "id": 680, + "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", "flags": { @@ -8399,148 +8232,8 @@ } }, { - "id": 674, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 338, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 328, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "new_phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 329, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 669, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 333, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 673, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 337, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 662, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 326, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 675, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 339, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 676, - "name": "updated_at", + "id": 690, + "name": "confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -8559,7 +8252,351 @@ } }, { - "id": 659, + "id": 689, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 339, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 687, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 337, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 682, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 332, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 691, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 341, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 698, + "name": "factors", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 348, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + }, + { + "id": 676, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 326, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 696, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 346, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 648, + "name": "UserIdentity" + } + } + }, + { + "id": 685, + "name": "invited_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 335, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 697, + "name": "is_anonymous", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 347, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 693, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 343, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 683, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 333, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 684, + "name": "new_phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 334, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 688, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 338, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 692, + "name": "phone_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 342, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 681, + "name": "recovery_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 331, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 694, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 344, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 695, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 345, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 678, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -8567,13 +8604,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 323, + "line": 328, "character": 2 } ], "type": { "type": "reference", - "id": 653, + "id": 672, "name": "UserMetadata" } } @@ -8583,28 +8620,28 @@ "title": "Properties", "kind": 1024, "children": [ - 667, 658, 660, 661, 671, 670, 668, 663, 672, 678, 657, 677, 666, 674, 664, 665, 669, - 673, 662, 675, 676, 659 + 686, 677, 679, 680, 690, 689, 687, 682, 691, 698, 676, 696, 685, 697, 693, 683, 684, + 688, 692, 681, 694, 695, 678 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 320, + "line": 325, "character": 17 } ] }, { - "id": 649, + "id": 668, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 650, + "id": 669, "name": "provider", "kind": 1024, "kindString": "Property", @@ -8614,7 +8651,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 312, + "line": 317, "character": 2 } ], @@ -8628,25 +8665,25 @@ { "title": "Properties", "kind": 1024, - "children": [650] + "children": [669] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 311, + "line": 316, "character": 17 } ], "indexSignature": { - "id": 651, + "id": 670, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 652, + "id": 671, "name": "key", "kind": 32768, "flags": {}, @@ -8663,14 +8700,14 @@ } }, { - "id": 679, + "id": 699, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 684, + "id": 704, "name": "data", "kind": 1024, "kindString": "Property", @@ -8684,7 +8721,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 374, + "line": 380, "character": 2 } ], @@ -8694,7 +8731,7 @@ } }, { - "id": 680, + "id": 700, "name": "email", "kind": 1024, "kindString": "Property", @@ -8707,7 +8744,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -8717,7 +8754,7 @@ } }, { - "id": 683, + "id": 703, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -8731,7 +8768,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -8741,7 +8778,7 @@ } }, { - "id": 682, + "id": 702, "name": "password", "kind": 1024, "kindString": "Property", @@ -8754,7 +8791,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -8764,7 +8801,7 @@ } }, { - "id": 681, + "id": 701, "name": "phone", "kind": 1024, "kindString": "Property", @@ -8777,7 +8814,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -8791,26 +8828,26 @@ { "title": "Properties", "kind": 1024, - "children": [684, 680, 683, 682, 681] + "children": [704, 700, 703, 702, 701] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 345, + "line": 351, "character": 17 } ] }, { - "id": 630, + "id": 648, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 639, + "id": 657, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -8820,7 +8857,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 279, + "line": 285, "character": 2 } ], @@ -8830,7 +8867,7 @@ } }, { - "id": 631, + "id": 649, "name": "id", "kind": 1024, "kindString": "Property", @@ -8838,7 +8875,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 272, + "line": 278, "character": 2 } ], @@ -8848,7 +8885,7 @@ } }, { - "id": 633, + "id": 651, "name": "identity_data", "kind": 1024, "kindString": "Property", @@ -8858,27 +8895,27 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 274, + "line": 280, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 634, + "id": 652, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 635, + "id": 653, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 636, + "id": 654, "name": "key", "kind": 32768, "flags": {}, @@ -8897,7 +8934,7 @@ } }, { - "id": 637, + "id": 655, "name": "identity_id", "kind": 1024, "kindString": "Property", @@ -8905,7 +8942,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 277, + "line": 283, "character": 2 } ], @@ -8915,7 +8952,7 @@ } }, { - "id": 640, + "id": 658, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -8925,7 +8962,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 280, + "line": 286, "character": 2 } ], @@ -8935,7 +8972,7 @@ } }, { - "id": 638, + "id": 656, "name": "provider", "kind": 1024, "kindString": "Property", @@ -8943,7 +8980,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 284, "character": 2 } ], @@ -8953,7 +8990,7 @@ } }, { - "id": 641, + "id": 659, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -8963,7 +9000,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 281, + "line": 287, "character": 2 } ], @@ -8973,7 +9010,7 @@ } }, { - "id": 632, + "id": 650, "name": "user_id", "kind": 1024, "kindString": "Property", @@ -8981,7 +9018,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 273, + "line": 279, "character": 2 } ], @@ -8995,19 +9032,19 @@ { "title": "Properties", "kind": 1024, - "children": [639, 631, 633, 637, 640, 638, 641, 632] + "children": [657, 649, 651, 655, 658, 656, 659, 650] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 271, + "line": 277, "character": 17 } ] }, { - "id": 653, + "id": 672, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -9015,19 +9052,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 316, + "line": 321, "character": 17 } ], "indexSignature": { - "id": 654, + "id": 673, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 655, + "id": 674, "name": "key", "kind": 32768, "flags": {}, @@ -9044,14 +9081,14 @@ } }, { - "id": 790, + "id": 811, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 791, + "id": 812, "name": "email", "kind": 1024, "kindString": "Property", @@ -9062,7 +9099,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 618, + "line": 636, "character": 2 } ], @@ -9072,7 +9109,7 @@ } }, { - "id": 794, + "id": 815, "name": "options", "kind": 1024, "kindString": "Property", @@ -9082,21 +9119,174 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 623, + "line": 641, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 795, + "id": 816, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 797, + "id": 818, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site.", + "tags": [ + { + "tag": "deprecated", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 649, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 817, + "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": 643, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [818, 817] + } + ] + } + } + }, + { + "id": 813, + "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": 638, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 814, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 640, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 823, + "name": "EmailOtpType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [812, 815, 813, 814] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 634, + "character": 17 + } + ] + }, + { + "id": 803, + "name": "VerifyMobileOtpParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 807, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 622, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 808, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 810, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -9125,7 +9315,7 @@ } }, { - "id": 796, + "id": 809, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -9138,7 +9328,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 625, + "line": 624, "character": 4 } ], @@ -9152,167 +9342,14 @@ { "title": "Properties", "kind": 1024, - "children": [797, 796] + "children": [810, 809] } ] } } }, { - "id": 792, - "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": 620, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 793, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 622, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 802, - "name": "EmailOtpType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [791, 794, 792, 793] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 616, - "character": 17 - } - ] - }, - { - "id": 782, - "name": "VerifyMobileOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 786, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 604, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 787, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 789, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ - { - "tag": "deprecated", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 613, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 788, - "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": 606, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [789, 788] - } - ] - } - } - }, - { - "id": 783, + "id": 804, "name": "phone", "kind": 1024, "kindString": "Property", @@ -9323,7 +9360,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 599, + "line": 617, "character": 2 } ], @@ -9333,7 +9370,7 @@ } }, { - "id": 784, + "id": 805, "name": "token", "kind": 1024, "kindString": "Property", @@ -9344,7 +9381,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 601, + "line": 619, "character": 2 } ], @@ -9354,7 +9391,7 @@ } }, { - "id": 785, + "id": 806, "name": "type", "kind": 1024, "kindString": "Property", @@ -9365,13 +9402,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 603, + "line": 621, "character": 2 } ], "type": { "type": "reference", - "id": 801, + "id": 822, "name": "MobileOtpType" } } @@ -9380,26 +9417,26 @@ { "title": "Properties", "kind": 1024, - "children": [786, 783, 784, 785] + "children": [807, 804, 805, 806] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 597, + "line": 615, "character": 17 } ] }, { - "id": 798, + "id": 819, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 799, + "id": 820, "name": "token_hash", "kind": 1024, "kindString": "Property", @@ -9410,7 +9447,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 637, + "line": 655, "character": 2 } ], @@ -9420,7 +9457,7 @@ } }, { - "id": 800, + "id": 821, "name": "type", "kind": 1024, "kindString": "Property", @@ -9431,13 +9468,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 640, + "line": 658, "character": 2 } ], "type": { "type": "reference", - "id": 802, + "id": 823, "name": "EmailOtpType" } } @@ -9446,19 +9483,19 @@ { "title": "Properties", "kind": 1024, - "children": [799, 800] + "children": [820, 821] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 635, + "line": 653, "character": 17 } ] }, { - "id": 480, + "id": 495, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -9466,7 +9503,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 30, + "line": 31, "character": 12 } ], @@ -9499,14 +9536,14 @@ }, { "type": "reference", - "id": 479, + "id": 494, "name": "AuthChangeEventMFA" } ] } }, { - "id": 479, + "id": 494, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -9514,7 +9551,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 28, + "line": 29, "character": 12 } ], @@ -9524,7 +9561,7 @@ } }, { - "id": 759, + "id": 779, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -9532,7 +9569,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 565, + "line": 583, "character": 12 } ], @@ -9551,7 +9588,7 @@ } }, { - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -9564,96 +9601,6 @@ } ] }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1028, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 997, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 998, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the MFA factor to delete." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1030, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 999, - "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": 1033, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [998, 999] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1028, - "character": 45 - } - ] - } - } - }, - { - "id": 987, - "name": "AuthMFAAdminDeleteFactorResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -9662,182 +9609,77 @@ } ], "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 988, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "type": "reflection", + "declaration": { + "id": 1006, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1007, + "name": "id", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ - { - "id": 989, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1017, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 990, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 991, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was successfully deleted." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1019, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [991] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1017, - "character": 12 - } - ] - } - } - }, - { - "id": 992, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1021, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [989, 992] - } - ], + "comment": { + "shortText": "ID of the MFA factor to delete." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 1016, - "character": 4 + "line": 1017, + "character": 2 } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 993, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1008, + "name": "userId", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ - { - "id": 994, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1023, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 995, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1023, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [994, 995] - } - ], + "comment": { + "shortText": "ID of the user whose factor is being deleted." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 1023, - "character": 4 + "line": 1020, + "character": 2 } - ] + ], + "type": { + "type": "intrinsic", + "name": "string" + } } - } - ] + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1007, 1008] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1015, + "character": 45 + } + ] + } } }, { - "id": 1009, - "name": "AuthMFAAdminListFactorsParams", + "id": 996, + "name": "AuthMFAAdminDeleteFactorResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, @@ -9852,61 +9694,187 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1002, "character": 12 } ], "type": { - "type": "reflection", - "declaration": { - "id": 1010, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1011, - "name": "userId", - "kind": 1024, - "kindString": "Property", + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 997, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "ID of the user." - }, + "children": [ + { + "id": 998, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1004, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 999, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1000, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor that was successfully deleted." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1006, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1000] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1004, + "character": 12 + } + ] + } + } + }, + { + "id": 1001, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1008, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [998, 1001] + } + ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1054, - "character": 2 + "line": 1003, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1002, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1003, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1010, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1004, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1010, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } } ], - "type": { - "type": "intrinsic", - "name": "string" - } + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1003, 1004] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1010, + "character": 4 + } + ] } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1011] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1052, - "character": 44 - } - ] - } + } + ] } }, { - "id": 1000, - "name": "AuthMFAAdminListFactorsResponse", + "id": 1018, + "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, @@ -9925,20 +9893,89 @@ "character": 12 } ], + "type": { + "type": "reflection", + "declaration": { + "id": 1019, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1020, + "name": "userId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1041, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1020] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1039, + "character": 44 + } + ] + } + } + }, + { + "id": 1009, + "name": "AuthMFAAdminListFactorsResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1026, + "character": 12 + } + ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { - "id": 1001, + "id": 1010, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1002, + "id": 1011, "name": "data", "kind": 1024, "kindString": "Property", @@ -9946,21 +9983,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1041, + "line": 1028, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 1003, + "id": 1012, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1004, + "id": 1013, "name": "factors", "kind": 1024, "kindString": "Property", @@ -9971,7 +10008,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1043, + "line": 1030, "character": 8 } ], @@ -9979,7 +10016,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 642, + "id": 660, "name": "Factor" } } @@ -9989,13 +10026,13 @@ { "title": "Properties", "kind": 1024, - "children": [1004] + "children": [1013] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1041, + "line": 1028, "character": 12 } ] @@ -10003,7 +10040,7 @@ } }, { - "id": 1005, + "id": 1014, "name": "error", "kind": 1024, "kindString": "Property", @@ -10011,7 +10048,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1045, + "line": 1032, "character": 6 } ], @@ -10025,13 +10062,13 @@ { "title": "Properties", "kind": 1024, - "children": [1002, 1005] + "children": [1011, 1014] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1040, + "line": 1027, "character": 4 } ] @@ -10040,14 +10077,14 @@ { "type": "reflection", "declaration": { - "id": 1006, + "id": 1015, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1007, + "id": 1016, "name": "data", "kind": 1024, "kindString": "Property", @@ -10055,7 +10092,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1047, + "line": 1034, "character": 6 } ], @@ -10065,7 +10102,7 @@ } }, { - "id": 1008, + "id": 1017, "name": "error", "kind": 1024, "kindString": "Property", @@ -10073,13 +10110,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1047, + "line": 1034, "character": 18 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -10088,13 +10125,13 @@ { "title": "Properties", "kind": 1024, - "children": [1007, 1008] + "children": [1016, 1017] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1047, + "line": 1034, "character": 4 } ] @@ -10104,7 +10141,7 @@ } }, { - "id": 935, + "id": 938, "name": "AuthMFAChallengeResponse", "kind": 4194304, "kindString": "Type alias", @@ -10112,7 +10149,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 872, "character": 12 } ], @@ -10122,14 +10159,14 @@ { "type": "reflection", "declaration": { - "id": 936, + "id": 939, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 937, + "id": 940, "name": "data", "kind": 1024, "kindString": "Property", @@ -10137,21 +10174,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 894, + "line": 874, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 938, + "id": 941, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 940, + "id": 944, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -10162,7 +10199,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 899, + "line": 882, "character": 8 } ], @@ -10172,7 +10209,7 @@ } }, { - "id": 939, + "id": 942, "name": "id", "kind": 1024, "kindString": "Property", @@ -10183,196 +10220,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 896, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [940, 939] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 894, - "character": 12 - } - ] - } - } - }, - { - "id": 941, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 901, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [937, 941] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 893, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 942, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 943, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 903, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 944, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 903, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [943, 944] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 903, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 910, - "name": "AuthMFAEnrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 847, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 911, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 912, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 849, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 913, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 921, - "name": "friendly_name", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 873, + "line": 876, "character": 8 } ], @@ -10382,357 +10230,18 @@ } }, { - "id": 914, - "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": 851, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 916, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "TOTP enrollment information." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 857, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 917, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 918, - "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": 861, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 919, - "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": 866, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 920, - "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": 870, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [918, 919, 920] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 857, - "character": 14 - } - ] - } - } - }, - { - "id": 915, + "id": 943, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor. Only `totp` supported for now." + "shortText": "Factor Type which generated the challenge" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 854, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [921, 914, 916, 915] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 849, - "character": 12 - } - ] - } - } - }, - { - "id": 922, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 875, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [912, 922] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 848, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 923, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 924, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 878, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 925, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 879, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [924, 925] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 877, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 956, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 920, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 957, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 958, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 922, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 959, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 962, - "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": 939, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 627, - "name": "AMREntry" - } - } - }, - { - "id": 960, - "name": "currentLevel", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Current AAL level of the session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 924, + "line": 879, "character": 8 } ], @@ -10740,50 +10249,12 @@ "type": "union", "types": [ { - "type": "reference", - "id": 955, - "name": "AuthenticatorAssuranceLevels" + "type": "literal", + "value": "totp" }, { "type": "literal", - "value": null - } - ] - } - }, - { - "id": 961, - "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": 932, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 955, - "name": "AuthenticatorAssuranceLevels" - }, - { - "type": "literal", - "value": null + "value": "phone" } ] } @@ -10793,13 +10264,13 @@ { "title": "Properties", "kind": 1024, - "children": [962, 960, 961] + "children": [944, 942, 943] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 922, + "line": 874, "character": 12 } ] @@ -10807,7 +10278,7 @@ } }, { - "id": 963, + "id": 945, "name": "error", "kind": 1024, "kindString": "Property", @@ -10815,7 +10286,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 941, + "line": 884, "character": 6 } ], @@ -10829,100 +10300,18 @@ { "title": "Properties", "kind": 1024, - "children": [958, 963] + "children": [940, 945] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 921, + "line": 873, "character": 4 } ] } }, - { - "type": "reflection", - "declaration": { - "id": 964, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 965, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 943, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 966, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 943, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [965, 966] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 943, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 945, - "name": "AuthMFAListFactorsResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 905, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ { "type": "reflection", "declaration": { @@ -10941,89 +10330,17 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 907, + "line": 886, "character": 6 } ], "type": { - "type": "reflection", - "declaration": { - "id": 948, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 949, - "name": "all", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "All available factors (verified and unverified)." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 909, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 642, - "name": "Factor" - } - } - }, - { - "id": 950, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Only verified TOTP factors. (A subset of `all`.)" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 912, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 642, - "name": "Factor" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [949, 950] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 907, - "character": 12 - } - ] - } + "type": "literal", + "value": null } }, { - "id": 951, + "id": 948, "name": "error", "kind": 1024, "kindString": "Property", @@ -11031,7 +10348,197 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 914, + "line": 886, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [947, 948] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 886, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 1081, + "name": "AuthMFAEnrollPhoneResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1181, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1082, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1083, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1183, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1084, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1087, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1191, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1085, + "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": 1185, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1088, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number of the MFA factor in E.164 format. Used to send messages" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1194, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1086, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1188, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1087, 1085, 1088, 1086] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1183, + "character": 12 + } + ] + } + } + }, + { + "id": 1089, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1196, "character": 6 } ], @@ -11045,7 +10552,632 @@ { "title": "Properties", "kind": 1024, - "children": [947, 951] + "children": [1083, 1089] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1182, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1090, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1091, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1199, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1092, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1200, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1091, 1092] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1198, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 928, + "name": "AuthMFAEnrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 860, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 1065, + "name": "AuthMFAEnrollTOTPResponse" + }, + { + "type": "reference", + "id": 1081, + "name": "AuthMFAEnrollPhoneResponse" + } + ] + } + }, + { + "id": 1065, + "name": "AuthMFAEnrollTOTPResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1146, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1066, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1067, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1148, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1068, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1076, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1172, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1069, + "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": 1150, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1071, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "TOTP enrollment information." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1156, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1072, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1073, + "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": 1160, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1074, + "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": 1165, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1075, + "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": 1169, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1073, 1074, 1075] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1156, + "character": 14 + } + ] + } + } + }, + { + "id": 1070, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1153, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1076, 1069, 1071, 1070] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1148, + "character": 12 + } + ] + } + } + }, + { + "id": 1077, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1174, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1067, 1077] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1147, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1078, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1079, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1177, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1080, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1178, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1079, 1080] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1176, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 961, + "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 905, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 962, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 963, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 907, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 964, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 967, + "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": 924, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 644, + "name": "AMREntry" + } + } + }, + { + "id": 965, + "name": "currentLevel", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Current AAL level of the session." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 909, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 960, + "name": "AuthenticatorAssuranceLevels" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 966, + "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": 917, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 960, + "name": "AuthenticatorAssuranceLevels" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [967, 965, 966] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 907, + "character": 12 + } + ] + } + } + }, + { + "id": 968, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 926, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [963, 968] } ], "sources": [ @@ -11060,14 +11192,14 @@ { "type": "reflection", "declaration": { - "id": 952, + "id": 969, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 953, + "id": 970, "name": "data", "kind": 1024, "kindString": "Property", @@ -11075,7 +11207,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 916, + "line": 928, "character": 6 } ], @@ -11085,7 +11217,7 @@ } }, { - "id": 954, + "id": 971, "name": "error", "kind": 1024, "kindString": "Property", @@ -11093,13 +11225,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 916, + "line": 928, "character": 18 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -11108,13 +11240,13 @@ { "title": "Properties", "kind": 1024, - "children": [953, 954] + "children": [970, 971] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 916, + "line": 928, "character": 4 } ] @@ -11124,15 +11256,15 @@ } }, { - "id": 926, - "name": "AuthMFAUnenrollResponse", + "id": 949, + "name": "AuthMFAListFactorsResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 882, + "line": 888, "character": 12 } ], @@ -11142,14 +11274,14 @@ { "type": "reflection", "declaration": { - "id": 927, + "id": 950, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 928, + "id": 951, "name": "data", "kind": 1024, "kindString": "Property", @@ -11157,21 +11289,262 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 884, + "line": 890, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 929, + "id": 952, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 930, + "id": 953, + "name": "all", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "All available factors (verified and unverified)." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 892, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + }, + { + "id": 955, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Only verified Phone factors. (A subset of `all`.)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 897, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + }, + { + "id": 954, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Only verified TOTP factors. (A subset of `all`.)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 895, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [953, 955, 954] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 890, + "character": 12 + } + ] + } + } + }, + { + "id": 956, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 899, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [951, 956] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 889, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 957, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 958, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 901, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 959, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 901, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [958, 959] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 901, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 929, + "name": "AuthMFAUnenrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 862, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 930, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 931, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 864, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 932, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 933, "name": "id", "kind": 1024, "kindString": "Property", @@ -11182,7 +11555,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 886, + "line": 866, "character": 8 } ], @@ -11196,81 +11569,19 @@ { "title": "Properties", "kind": 1024, - "children": [930] + "children": [933] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 884, + "line": 864, "character": 12 } ] } } }, - { - "id": 931, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 888, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [928, 931] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 883, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 932, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 933, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 890, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, { "id": 934, "name": "error", @@ -11280,13 +11591,75 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 890, + "line": 868, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [931, 934] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 863, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 935, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 936, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 870, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 937, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 870, "character": 18 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -11295,13 +11668,13 @@ { "title": "Properties", "kind": 1024, - "children": [933, 934] + "children": [936, 937] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 890, + "line": 870, "character": 4 } ] @@ -11311,7 +11684,7 @@ } }, { - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse", "kind": 4194304, "kindString": "Type alias", @@ -11319,7 +11692,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 822, + "line": 835, "character": 12 } ], @@ -11329,14 +11702,14 @@ { "type": "reflection", "declaration": { - "id": 898, + "id": 916, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 899, + "id": 917, "name": "data", "kind": 1024, "kindString": "Property", @@ -11344,21 +11717,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 824, + "line": 837, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 900, + "id": 918, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 901, + "id": 919, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -11369,7 +11742,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 826, + "line": 839, "character": 8 } ], @@ -11379,7 +11752,7 @@ } }, { - "id": 903, + "id": 921, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -11390,7 +11763,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 832, + "line": 845, "character": 8 } ], @@ -11400,7 +11773,7 @@ } }, { - "id": 904, + "id": 922, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -11411,7 +11784,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 835, + "line": 848, "character": 8 } ], @@ -11421,7 +11794,7 @@ } }, { - "id": 902, + "id": 920, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -11432,7 +11805,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 829, + "line": 842, "character": 8 } ], @@ -11442,7 +11815,7 @@ } }, { - "id": 905, + "id": 923, "name": "user", "kind": 1024, "kindString": "Property", @@ -11453,13 +11826,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 838, + "line": 851, "character": 8 } ], "type": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } } @@ -11468,13 +11841,13 @@ { "title": "Properties", "kind": 1024, - "children": [901, 903, 904, 902, 905] + "children": [919, 921, 922, 920, 923] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 824, + "line": 837, "character": 12 } ] @@ -11482,7 +11855,7 @@ } }, { - "id": 906, + "id": 924, "name": "error", "kind": 1024, "kindString": "Property", @@ -11490,7 +11863,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 840, + "line": 853, "character": 6 } ], @@ -11504,13 +11877,13 @@ { "title": "Properties", "kind": 1024, - "children": [899, 906] + "children": [917, 924] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 823, + "line": 836, "character": 4 } ] @@ -11519,14 +11892,14 @@ { "type": "reflection", "declaration": { - "id": 907, + "id": 925, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 908, + "id": 926, "name": "data", "kind": 1024, "kindString": "Property", @@ -11534,7 +11907,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 843, + "line": 856, "character": 6 } ], @@ -11544,7 +11917,7 @@ } }, { - "id": 909, + "id": 927, "name": "error", "kind": 1024, "kindString": "Property", @@ -11552,13 +11925,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 844, + "line": 857, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -11567,13 +11940,13 @@ { "title": "Properties", "kind": 1024, - "children": [908, 909] + "children": [926, 927] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 842, + "line": 855, "character": 4 } ] @@ -11583,19 +11956,19 @@ } }, { - "id": 542, + "id": 559, "name": "AuthOtpResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "AuthOtpResponse is returned when OTP is used.", - "text": "{@see AuthRsponse}\n" + "text": "{@see AuthResponse}\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 129, + "line": 135, "character": 12 } ], @@ -11605,14 +11978,14 @@ { "type": "reflection", "declaration": { - "id": 543, + "id": 560, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 544, + "id": 561, "name": "data", "kind": 1024, "kindString": "Property", @@ -11620,21 +11993,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 545, + "id": 562, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 548, + "id": 565, "name": "messageId", "kind": 1024, "kindString": "Property", @@ -11644,7 +12017,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 41 } ], @@ -11663,7 +12036,7 @@ } }, { - "id": 547, + "id": 564, "name": "session", "kind": 1024, "kindString": "Property", @@ -11671,7 +12044,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 26 } ], @@ -11681,7 +12054,7 @@ } }, { - "id": 546, + "id": 563, "name": "user", "kind": 1024, "kindString": "Property", @@ -11689,7 +12062,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 14 } ], @@ -11703,13 +12076,13 @@ { "title": "Properties", "kind": 1024, - "children": [548, 547, 546] + "children": [565, 564, 563] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 12 } ] @@ -11717,7 +12090,7 @@ } }, { - "id": 549, + "id": 566, "name": "error", "kind": 1024, "kindString": "Property", @@ -11725,7 +12098,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 132, + "line": 138, "character": 6 } ], @@ -11739,13 +12112,13 @@ { "title": "Properties", "kind": 1024, - "children": [544, 549] + "children": [561, 566] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 136, "character": 4 } ] @@ -11754,773 +12127,14 @@ { "type": "reflection", "declaration": { - "id": 550, + "id": 567, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 551, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 552, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 555, - "name": "messageId", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 41 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 554, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 26 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 553, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [555, 554, 553] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 12 - } - ] - } - } - }, - { - "id": 556, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 136, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [551, 556] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 134, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 515, - "name": "AuthResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 91, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 516, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 517, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 518, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 95, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 618, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 519, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 94, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 656, - "name": "User" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [520, 519] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 12 - } - ] - } - } - }, - { - "id": 521, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 97, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [517, 521] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 92, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 522, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 523, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 524, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 526, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 102, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 525, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [526, 525] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 12 - } - ] - } - } - }, - { - "id": 527, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 104, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [523, 527] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 99, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 528, - "name": "AuthResponsePassword", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 107, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 529, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 530, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 531, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 533, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 618, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 532, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 110, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 656, - "name": "User" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 534, - "name": "weak_password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 112, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 511, - "name": "WeakPassword" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [533, 532, 534] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 12 - } - ] - } - } - }, - { - "id": 535, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 114, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [530, 535] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 536, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 537, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 117, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 538, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 540, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 119, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 539, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 118, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [540, 539] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 117, - "character": 12 - } - ] - } - } - }, - { - "id": 541, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 121, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [537, 541] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 116, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 557, - "name": "AuthTokenResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 139, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 558, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 559, + "id": 568, "name": "data", "kind": 1024, "kindString": "Property", @@ -12535,14 +12149,43 @@ "type": { "type": "reflection", "declaration": { - "id": 560, + "id": 569, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 562, + "id": 572, + "name": "messageId", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 141, + "character": 41 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 571, "name": "session", "kind": 1024, "kindString": "Property", @@ -12550,18 +12193,17 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 143, - "character": 8 + "line": 141, + "character": 26 } ], "type": { - "type": "reference", - "id": 618, - "name": "Session" + "type": "literal", + "value": null } }, { - "id": 561, + "id": 570, "name": "user", "kind": 1024, "kindString": "Property", @@ -12569,14 +12211,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 142, - "character": 8 + "line": 141, + "character": 14 } ], "type": { - "type": "reference", - "id": 656, - "name": "User" + "type": "literal", + "value": null } } ], @@ -12584,7 +12225,7 @@ { "title": "Properties", "kind": 1024, - "children": [562, 561] + "children": [572, 571, 570] } ], "sources": [ @@ -12598,7 +12239,7 @@ } }, { - "id": 563, + "id": 573, "name": "error", "kind": 1024, "kindString": "Property", @@ -12606,7 +12247,167 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 145, + "line": 142, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [568, 573] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 140, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 532, + "name": "AuthResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 97, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 533, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 534, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 99, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 535, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 537, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 101, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 635, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 536, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 675, + "name": "User" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [537, 536] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 99, + "character": 12 + } + ] + } + } + }, + { + "id": 538, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 103, "character": 6 } ], @@ -12620,13 +12421,13 @@ { "title": "Properties", "kind": 1024, - "children": [559, 563] + "children": [534, 538] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 140, + "line": 98, "character": 4 } ] @@ -12635,14 +12436,14 @@ { "type": "reflection", "declaration": { - "id": 564, + "id": 539, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 565, + "id": 540, "name": "data", "kind": 1024, "kindString": "Property", @@ -12650,21 +12451,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 148, + "line": 106, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 566, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 568, + "id": 543, "name": "session", "kind": 1024, "kindString": "Property", @@ -12672,7 +12473,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 150, + "line": 108, "character": 8 } ], @@ -12682,11 +12483,443 @@ } }, { - "id": 567, + "id": 542, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 107, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [543, 542] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 106, + "character": 12 + } + ] + } + } + }, + { + "id": 544, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 110, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [540, 544] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 105, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 545, + "name": "AuthResponsePassword", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 546, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 547, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 548, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 550, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 117, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 635, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 549, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 116, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 675, + "name": "User" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 551, + "name": "weak_password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 118, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 528, + "name": "WeakPassword" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [550, 549, 551] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 12 + } + ] + } + } + }, + { + "id": 552, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 120, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [547, 552] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 114, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 553, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 554, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 123, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 555, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 557, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 125, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 556, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 124, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [557, 556] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 123, + "character": 12 + } + ] + } + } + }, + { + "id": 558, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 127, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [554, 558] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 122, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 574, + "name": "AuthTokenResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 145, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 575, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 576, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 147, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 577, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 579, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -12694,136 +12927,14 @@ "character": 8 } ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [568, 567] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 148, - "character": 12 - } - ] - } - } - }, - { - "id": 569, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 152, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [565, 569] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 147, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 570, - "name": "AuthTokenResponsePassword", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 155, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 571, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 572, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 573, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 575, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 159, - "character": 8 - } - ], "type": { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } }, { - "id": 574, + "id": 578, "name": "user", "kind": 1024, "kindString": "Property", @@ -12831,49 +12942,28 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 158, + "line": 148, "character": 8 } ], "type": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } - }, - { - "id": 576, - "name": "weakPassword", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 160, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 511, - "name": "WeakPassword" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [575, 574, 576] + "children": [579, 578] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 157, + "line": 147, "character": 12 } ] @@ -12881,7 +12971,7 @@ } }, { - "id": 577, + "id": 580, "name": "error", "kind": 1024, "kindString": "Property", @@ -12889,7 +12979,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 162, + "line": 151, "character": 6 } ], @@ -12903,13 +12993,13 @@ { "title": "Properties", "kind": 1024, - "children": [572, 577] + "children": [576, 580] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 156, + "line": 146, "character": 4 } ] @@ -12918,14 +13008,14 @@ { "type": "reflection", "declaration": { - "id": 578, + "id": 581, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 579, + "id": 582, "name": "data", "kind": 1024, "kindString": "Property", @@ -12933,21 +13023,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 154, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 583, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 585, "name": "session", "kind": 1024, "kindString": "Property", @@ -12955,7 +13045,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 167, + "line": 156, "character": 8 } ], @@ -12965,7 +13055,7 @@ } }, { - "id": 581, + "id": 584, "name": "user", "kind": 1024, "kindString": "Property", @@ -12973,27 +13063,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 166, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 583, - "name": "weakPassword", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 168, + "line": 155, "character": 8 } ], @@ -13007,13 +13077,13 @@ { "title": "Properties", "kind": 1024, - "children": [582, 581, 583] + "children": [585, 584] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 154, "character": 12 } ] @@ -13021,7 +13091,7 @@ } }, { - "id": 584, + "id": 586, "name": "error", "kind": 1024, "kindString": "Property", @@ -13029,13 +13099,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 170, + "line": 158, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -13044,13 +13114,13 @@ { "title": "Properties", "kind": 1024, - "children": [579, 584] + "children": [582, 586] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 164, + "line": 153, "character": 4 } ] @@ -13060,7 +13130,310 @@ } }, { - "id": 955, + "id": 587, + "name": "AuthTokenResponsePassword", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 161, + "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": 163, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 590, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 592, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 165, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 635, + "name": "Session" + } + }, + { + "id": 591, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 164, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 675, + "name": "User" + } + }, + { + "id": 593, + "name": "weakPassword", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 166, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 528, + "name": "WeakPassword" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [592, 591, 593] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 163, + "character": 12 + } + ] + } + } + }, + { + "id": 594, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 168, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [589, 594] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 162, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 595, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 596, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 171, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 597, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 599, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 173, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 598, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 172, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 600, + "name": "weakPassword", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 174, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [599, 598, 600] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 171, + "character": 12 + } + ] + } + } + }, + { + "id": 601, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 176, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [596, 601] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 170, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 960, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -13068,7 +13441,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 918, + "line": 903, "character": 12 } ], @@ -13087,7 +13460,7 @@ } }, { - "id": 1025, + "id": 1034, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -13095,7 +13468,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1104, + "line": 1091, "character": 12 } ], @@ -13105,14 +13478,14 @@ { "type": "reflection", "declaration": { - "id": 1026, + "id": 1035, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1028, + "id": 1037, "name": "error", "kind": 1024, "kindString": "Property", @@ -13120,7 +13493,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1107, + "line": 1094, "character": 6 } ], @@ -13130,7 +13503,7 @@ } }, { - "id": 1027, + "id": 1036, "name": "session", "kind": 1024, "kindString": "Property", @@ -13138,13 +13511,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1106, + "line": 1093, "character": 6 } ], "type": { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } } @@ -13153,13 +13526,13 @@ { "title": "Properties", "kind": 1024, - "children": [1028, 1027] + "children": [1037, 1036] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1105, + "line": 1092, "character": 4 } ] @@ -13168,14 +13541,14 @@ { "type": "reflection", "declaration": { - "id": 1029, + "id": 1038, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1031, + "id": 1040, "name": "error", "kind": 1024, "kindString": "Property", @@ -13183,18 +13556,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1111, + "line": 1098, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } }, { - "id": 1030, + "id": 1039, "name": "session", "kind": 1024, "kindString": "Property", @@ -13202,7 +13575,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1110, + "line": 1097, "character": 6 } ], @@ -13216,13 +13589,13 @@ { "title": "Properties", "kind": 1024, - "children": [1031, 1030] + "children": [1040, 1039] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1109, + "line": 1096, "character": 4 } ] @@ -13232,7 +13605,7 @@ } }, { - "id": 802, + "id": 823, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -13240,7 +13613,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 662, "character": 12 } ], @@ -13275,7 +13648,7 @@ } }, { - "id": 846, + "id": 867, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -13283,21 +13656,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 847, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 849, + "id": 870, "name": "email", "kind": 1024, "kindString": "Property", @@ -13308,7 +13681,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 714, + "line": 732, "character": 2 } ], @@ -13318,7 +13691,7 @@ } }, { - "id": 850, + "id": 871, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -13329,7 +13702,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 718, + "line": 736, "character": 2 } ], @@ -13339,7 +13712,7 @@ } }, { - "id": 851, + "id": 872, "name": "options", "kind": 1024, "kindString": "Property", @@ -13349,7 +13722,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 719, + "line": 737, "character": 2 } ], @@ -13358,7 +13731,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -13372,7 +13745,7 @@ } }, { - "id": 848, + "id": 869, "name": "type", "kind": 1024, "kindString": "Property", @@ -13380,7 +13753,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 712, + "line": 730, "character": 2 } ], @@ -13403,13 +13776,13 @@ { "title": "Properties", "kind": 1024, - "children": [849, 850, 851, 848] + "children": [870, 871, 872, 869] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 44 } ] @@ -13417,7 +13790,7 @@ } }, { - "id": 836, + "id": 857, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -13425,21 +13798,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 837, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 839, + "id": 860, "name": "email", "kind": 1024, "kindString": "Property", @@ -13450,7 +13823,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 700, + "line": 718, "character": 2 } ], @@ -13460,7 +13833,7 @@ } }, { - "id": 840, + "id": 861, "name": "options", "kind": 1024, "kindString": "Property", @@ -13470,7 +13843,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 701, + "line": 719, "character": 2 } ], @@ -13479,7 +13852,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -13502,7 +13875,7 @@ } }, { - "id": 838, + "id": 859, "name": "type", "kind": 1024, "kindString": "Property", @@ -13510,7 +13883,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 698, + "line": 716, "character": 2 } ], @@ -13533,13 +13906,13 @@ { "title": "Properties", "kind": 1024, - "children": [839, 840, 838] + "children": [860, 861, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 46 } ] @@ -13547,7 +13920,7 @@ } }, { - "id": 855, + "id": 876, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -13555,7 +13928,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 733, + "line": 751, "character": 12 } ], @@ -13564,29 +13937,29 @@ "types": [ { "type": "reference", - "id": 830, + "id": 851, "name": "GenerateSignupLinkParams" }, { "type": "reference", - "id": 836, + "id": 857, "name": "GenerateInviteOrMagiclinkParams" }, { "type": "reference", - "id": 841, + "id": 862, "name": "GenerateRecoveryLinkParams" }, { "type": "reference", - "id": 846, + "id": 867, "name": "GenerateEmailChangeLinkParams" } ] } }, { - "id": 869, + "id": 890, "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", @@ -13597,21 +13970,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 756, + "line": 774, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 870, + "id": 891, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 871, + "id": 892, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -13622,7 +13995,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 761, + "line": 779, "character": 2 } ], @@ -13632,7 +14005,7 @@ } }, { - "id": 872, + "id": 893, "name": "email_otp", "kind": 1024, "kindString": "Property", @@ -13643,7 +14016,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 766, + "line": 784, "character": 2 } ], @@ -13653,7 +14026,7 @@ } }, { - "id": 873, + "id": 894, "name": "hashed_token", "kind": 1024, "kindString": "Property", @@ -13664,7 +14037,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 770, + "line": 788, "character": 2 } ], @@ -13674,7 +14047,7 @@ } }, { - "id": 874, + "id": 895, "name": "redirect_to", "kind": 1024, "kindString": "Property", @@ -13685,7 +14058,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 772, + "line": 790, "character": 2 } ], @@ -13695,7 +14068,7 @@ } }, { - "id": 875, + "id": 896, "name": "verification_type", "kind": 1024, "kindString": "Property", @@ -13706,13 +14079,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 774, + "line": 792, "character": 2 } ], "type": { "type": "reference", - "id": 876, + "id": 897, "name": "GenerateLinkType" } } @@ -13721,13 +14094,13 @@ { "title": "Properties", "kind": 1024, - "children": [871, 872, 873, 874, 875] + "children": [892, 893, 894, 895, 896] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 756, + "line": 774, "character": 37 } ] @@ -13735,7 +14108,7 @@ } }, { - "id": 856, + "id": 877, "name": "GenerateLinkResponse", "kind": 4194304, "kindString": "Type alias", @@ -13743,7 +14116,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 739, + "line": 757, "character": 12 } ], @@ -13753,14 +14126,14 @@ { "type": "reflection", "declaration": { - "id": 857, + "id": 878, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 858, + "id": 879, "name": "data", "kind": 1024, "kindString": "Property", @@ -13768,21 +14141,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 741, + "line": 759, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 859, + "id": 880, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 860, + "id": 881, "name": "properties", "kind": 1024, "kindString": "Property", @@ -13790,18 +14163,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 742, + "line": 760, "character": 8 } ], "type": { "type": "reference", - "id": 869, + "id": 890, "name": "GenerateLinkProperties" } }, { - "id": 861, + "id": 882, "name": "user", "kind": 1024, "kindString": "Property", @@ -13809,13 +14182,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 743, + "line": 761, "character": 8 } ], "type": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } } @@ -13824,13 +14197,13 @@ { "title": "Properties", "kind": 1024, - "children": [860, 861] + "children": [881, 882] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 741, + "line": 759, "character": 12 } ] @@ -13838,7 +14211,7 @@ } }, { - "id": 862, + "id": 883, "name": "error", "kind": 1024, "kindString": "Property", @@ -13846,7 +14219,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 745, + "line": 763, "character": 6 } ], @@ -13860,13 +14233,13 @@ { "title": "Properties", "kind": 1024, - "children": [858, 862] + "children": [879, 883] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 740, + "line": 758, "character": 4 } ] @@ -13875,14 +14248,14 @@ { "type": "reflection", "declaration": { - "id": 863, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 864, + "id": 885, "name": "data", "kind": 1024, "kindString": "Property", @@ -13890,21 +14263,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 748, + "line": 766, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 865, + "id": 886, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 866, + "id": 887, "name": "properties", "kind": 1024, "kindString": "Property", @@ -13912,7 +14285,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 749, + "line": 767, "character": 8 } ], @@ -13922,7 +14295,7 @@ } }, { - "id": 867, + "id": 888, "name": "user", "kind": 1024, "kindString": "Property", @@ -13930,7 +14303,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 750, + "line": 768, "character": 8 } ], @@ -13944,13 +14317,13 @@ { "title": "Properties", "kind": 1024, - "children": [866, 867] + "children": [887, 888] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 748, + "line": 766, "character": 12 } ] @@ -13958,7 +14331,7 @@ } }, { - "id": 868, + "id": 889, "name": "error", "kind": 1024, "kindString": "Property", @@ -13966,13 +14339,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 752, + "line": 770, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -13981,13 +14354,13 @@ { "title": "Properties", "kind": 1024, - "children": [864, 868] + "children": [885, 889] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 747, + "line": 765, "character": 4 } ] @@ -13997,7 +14370,7 @@ } }, { - "id": 876, + "id": 897, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -14005,7 +14378,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 777, + "line": 795, "character": 12 } ], @@ -14040,7 +14413,7 @@ } }, { - "id": 841, + "id": 862, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -14048,21 +14421,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "email", "kind": 1024, "kindString": "Property", @@ -14073,7 +14446,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 707, + "line": 725, "character": 2 } ], @@ -14083,7 +14456,7 @@ } }, { - "id": 845, + "id": 866, "name": "options", "kind": 1024, "kindString": "Property", @@ -14093,7 +14466,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 708, + "line": 726, "character": 2 } ], @@ -14102,7 +14475,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -14116,7 +14489,7 @@ } }, { - "id": 843, + "id": 864, "name": "type", "kind": 1024, "kindString": "Property", @@ -14124,7 +14497,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 705, + "line": 723, "character": 2 } ], @@ -14138,13 +14511,13 @@ { "title": "Properties", "kind": 1024, - "children": [844, 845, 843] + "children": [865, 866, 864] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 41 } ] @@ -14152,7 +14525,7 @@ } }, { - "id": 830, + "id": 851, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -14160,21 +14533,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 831, + "id": 852, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 854, "name": "email", "kind": 1024, "kindString": "Property", @@ -14182,7 +14555,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 692, + "line": 710, "character": 2 } ], @@ -14192,7 +14565,7 @@ } }, { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -14202,7 +14575,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 694, + "line": 712, "character": 2 } ], @@ -14211,7 +14584,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -14234,7 +14607,7 @@ } }, { - "id": 834, + "id": 855, "name": "password", "kind": 1024, "kindString": "Property", @@ -14242,7 +14615,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 693, + "line": 711, "character": 2 } ], @@ -14252,7 +14625,7 @@ } }, { - "id": 832, + "id": 853, "name": "type", "kind": 1024, "kindString": "Property", @@ -14260,7 +14633,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 691, + "line": 709, "character": 2 } ], @@ -14274,13 +14647,13 @@ { "title": "Properties", "kind": 1024, - "children": [833, 835, 834, 832] + "children": [854, 856, 855, 853] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 39 } ] @@ -14288,7 +14661,7 @@ } }, { - "id": 490, + "id": 505, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -14296,21 +14669,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 491, + "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 499, + "id": 514, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -14320,7 +14693,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 66, + "line": 67, "character": 2 } ], @@ -14330,7 +14703,7 @@ } }, { - "id": 504, + "id": 519, "name": "debug", "kind": 1024, "kindString": "Property", @@ -14340,7 +14713,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 76, + "line": 77, "character": 2 } ], @@ -14354,7 +14727,7 @@ { "type": "reflection", "declaration": { - "id": 505, + "id": 520, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -14362,20 +14735,20 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 76, + "line": 77, "character": 21 } ], "signatures": [ { - "id": 506, + "id": 521, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 522, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -14386,7 +14759,7 @@ } }, { - "id": 508, + "id": 523, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -14414,7 +14787,7 @@ } }, { - "id": 498, + "id": 513, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -14424,7 +14797,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 65, "character": 2 } ], @@ -14434,7 +14807,7 @@ } }, { - "id": 502, + "id": 517, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -14444,7 +14817,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 72, + "line": 73, "character": 2 } ], @@ -14454,7 +14827,7 @@ } }, { - "id": 503, + "id": 518, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -14464,18 +14837,47 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 75, "character": 2 } ], "type": { "type": "reference", - "id": 759, + "id": 779, "name": "AuthFlowType" } }, { - "id": 493, + "id": 525, + "name": "hasCustomAuthorizationHeader", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set to \"true\" if there is a custom authorization header set globally.", + "tags": [ + { + "tag": "experimental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 508, "name": "headers", "kind": 1024, "kindString": "Property", @@ -14485,14 +14887,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 61, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 494, + "id": 509, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -14500,19 +14902,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 61, "character": 12 } ], "indexSignature": { - "id": 495, + "id": 510, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 496, + "id": 511, "name": "key", "kind": 32768, "flags": {}, @@ -14531,7 +14933,7 @@ } }, { - "id": 509, + "id": 524, "name": "lock", "kind": 1024, "kindString": "Property", @@ -14550,18 +14952,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 83, "character": 2 } ], "type": { "type": "reference", - "id": 481, + "id": 496, "name": "LockFunc" } }, { - "id": 500, + "id": 515, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -14571,7 +14973,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 68, + "line": 69, "character": 2 } ], @@ -14581,7 +14983,7 @@ } }, { - "id": 501, + "id": 516, "name": "storage", "kind": 1024, "kindString": "Property", @@ -14591,18 +14993,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 71, "character": 2 } ], "type": { "type": "reference", - "id": 1019, + "id": 1028, "name": "SupportedStorage" } }, { - "id": 497, + "id": 512, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -14612,7 +15014,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 62, + "line": 63, "character": 2 } ], @@ -14622,7 +15024,7 @@ } }, { - "id": 492, + "id": 507, "name": "url", "kind": 1024, "kindString": "Property", @@ -14632,7 +15034,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, + "line": 59, "character": 2 } ], @@ -14646,13 +15048,13 @@ { "title": "Properties", "kind": 1024, - "children": [499, 504, 498, 502, 503, 493, 509, 500, 501, 497, 492] + "children": [514, 519, 513, 517, 518, 525, 508, 524, 515, 516, 512, 507] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 34 } ] @@ -14660,7 +15062,7 @@ } }, { - "id": 1022, + "id": 1031, "name": "InitializeResult", "kind": 4194304, "kindString": "Type alias", @@ -14668,21 +15070,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1102, + "line": 1089, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1023, + "id": 1032, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1024, + "id": 1033, "name": "error", "kind": 1024, "kindString": "Property", @@ -14690,7 +15092,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1102, + "line": 1089, "character": 33 } ], @@ -14699,7 +15101,7 @@ "types": [ { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" }, { @@ -14714,13 +15116,13 @@ { "title": "Properties", "kind": 1024, - "children": [1024] + "children": [1033] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1102, + "line": 1089, "character": 31 } ] @@ -14728,7 +15130,7 @@ } }, { - "id": 481, + "id": 496, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -14736,14 +15138,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 482, + "id": 497, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -14751,13 +15153,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 23 } ], "signatures": [ { - "id": 483, + "id": 498, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -14773,7 +15175,7 @@ }, "typeParameter": [ { - "id": 489, + "id": 504, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -14782,7 +15184,7 @@ ], "parameters": [ { - "id": 484, + "id": 499, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -14796,7 +15198,7 @@ } }, { - "id": 485, + "id": 500, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -14810,7 +15212,7 @@ } }, { - "id": 486, + "id": 501, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -14821,7 +15223,7 @@ "type": { "type": "reflection", "declaration": { - "id": 487, + "id": 502, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -14829,13 +15231,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 69 } ], "signatures": [ { - "id": 488, + "id": 503, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -14845,7 +15247,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -14864,7 +15266,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -14878,7 +15280,7 @@ } }, { - "id": 893, + "id": 911, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -14886,21 +15288,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 894, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 896, + "id": 914, "name": "code", "kind": 1024, "kindString": "Property", @@ -14911,7 +15313,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 819, + "line": 832, "character": 2 } ], @@ -14921,7 +15323,7 @@ } }, { - "id": 895, + "id": 913, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -14932,7 +15334,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 817, + "line": 830, "character": 2 } ], @@ -14946,13 +15348,13 @@ { "title": "Properties", "kind": 1024, - "children": [896, 895] + "children": [914, 913] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 42 } ] @@ -14960,11 +15362,406 @@ } }, { - "id": 890, + "id": 907, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 821, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 908, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 910, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 825, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 909, + "name": "factorId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor to be challenged. Returned in enroll()." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 823, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [910, 909] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 821, + "character": 33 + } + ] + } + } + }, + { + "id": 898, + "name": "MFAEnrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 803, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 1055, + "name": "MFAEnrollTOTPParams" + }, + { + "type": "reference", + "id": 1060, + "name": "MFAEnrollPhoneParams" + } + ] + } + }, + { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + }, + { + "id": 1055, + "name": "MFAEnrollTOTPParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1056, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1057, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1131, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + }, + { + "id": 1059, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1135, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1058, + "name": "issuer", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Domain which the user is enrolled with." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1133, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1057, 1059, 1058] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 34 + } + ] + } + } + }, + { + "id": 899, + "name": "MFAUnenrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 805, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 900, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 901, + "name": "factorId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor being unenrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 807, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [901] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 805, + "character": 32 + } + ] + } + } + }, + { + "id": 902, + "name": "MFAVerifyParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -14975,20 +15772,62 @@ "type": { "type": "reflection", "declaration": { - "id": 891, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 892, + "id": 905, + "name": "challengeId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the challenge being verified. Returned in challenge()." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 815, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 906, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Verification code provided by the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 818, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 904, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor to be challenged. Returned in enroll()." + "shortText": "ID of the factor being verified. Returned in enroll()." }, "sources": [ { @@ -15007,120 +15846,13 @@ { "title": "Properties", "kind": 1024, - "children": [892] + "children": [905, 906, 904] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 810, - "character": 33 - } - ] - } - } - }, - { - "id": 877, - "name": "MFAEnrollParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 785, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 878, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 879, - "name": "factorType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of factor being enrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 787, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - }, - { - "id": 881, - "name": "friendlyName", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Human readable name assigned to the factor." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 791, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 880, - "name": "issuer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Domain which the user is enrolled with." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 789, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [879, 881, 880] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 785, "character": 30 } ] @@ -15128,171 +15860,7 @@ } }, { - "id": 882, - "name": "MFAUnenrollParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 794, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 883, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 884, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being unenrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 796, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [884] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 794, - "character": 32 - } - ] - } - } - }, - { - "id": 885, - "name": "MFAVerifyParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 799, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 886, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 888, - "name": "challengeId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the challenge being verified. Returned in challenge()." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 804, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 889, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Verification code provided by the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 807, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 887, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 801, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [888, 889, 887] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 799, - "character": 30 - } - ] - } - } - }, - { - "id": 801, + "id": 822, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -15300,7 +15868,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 643, + "line": 661, "character": 12 } ], @@ -15319,7 +15887,7 @@ } }, { - "id": 585, + "id": 602, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -15327,7 +15895,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 173, + "line": 179, "character": 12 } ], @@ -15337,14 +15905,14 @@ { "type": "reflection", "declaration": { - "id": 586, + "id": 603, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 587, + "id": 604, "name": "data", "kind": 1024, "kindString": "Property", @@ -15352,21 +15920,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 175, + "line": 181, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 588, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 589, + "id": 606, "name": "provider", "kind": 1024, "kindString": "Property", @@ -15374,18 +15942,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 176, + "line": 182, "character": 8 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider" } }, { - "id": 590, + "id": 607, "name": "url", "kind": 1024, "kindString": "Property", @@ -15393,7 +15961,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 177, + "line": 183, "character": 8 } ], @@ -15407,13 +15975,13 @@ { "title": "Properties", "kind": 1024, - "children": [589, 590] + "children": [606, 607] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 175, + "line": 181, "character": 12 } ] @@ -15421,7 +15989,7 @@ } }, { - "id": 591, + "id": 608, "name": "error", "kind": 1024, "kindString": "Property", @@ -15429,7 +15997,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 179, + "line": 185, "character": 6 } ], @@ -15443,13 +16011,13 @@ { "title": "Properties", "kind": 1024, - "children": [587, 591] + "children": [604, 608] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 174, + "line": 180, "character": 4 } ] @@ -15458,14 +16026,14 @@ { "type": "reflection", "declaration": { - "id": 592, + "id": 609, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 593, + "id": 610, "name": "data", "kind": 1024, "kindString": "Property", @@ -15473,21 +16041,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 182, + "line": 188, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 594, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 595, + "id": 612, "name": "provider", "kind": 1024, "kindString": "Property", @@ -15495,18 +16063,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 183, + "line": 189, "character": 8 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider" } }, { - "id": 596, + "id": 613, "name": "url", "kind": 1024, "kindString": "Property", @@ -15514,7 +16082,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 184, + "line": 190, "character": 8 } ], @@ -15528,13 +16096,13 @@ { "title": "Properties", "kind": 1024, - "children": [595, 596] + "children": [612, 613] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 182, + "line": 188, "character": 12 } ] @@ -15542,7 +16110,7 @@ } }, { - "id": 597, + "id": 614, "name": "error", "kind": 1024, "kindString": "Property", @@ -15550,13 +16118,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 186, + "line": 192, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -15565,13 +16133,13 @@ { "title": "Properties", "kind": 1024, - "children": [593, 597] + "children": [610, 614] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 181, + "line": 187, "character": 4 } ] @@ -15581,7 +16149,7 @@ } }, { - "id": 1039, + "id": 1048, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -15589,21 +16157,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1040, + "id": 1049, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1050, "name": "page", "kind": 1024, "kindString": "Property", @@ -15616,7 +16184,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1123, + "line": 1110, "character": 2 } ], @@ -15626,7 +16194,7 @@ } }, { - "id": 1042, + "id": 1051, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -15639,7 +16207,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1125, + "line": 1112, "character": 2 } ], @@ -15653,13 +16221,13 @@ { "title": "Properties", "kind": 1024, - "children": [1041, 1042] + "children": [1050, 1051] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 25 } ] @@ -15667,7 +16235,7 @@ } }, { - "id": 1032, + "id": 1041, "name": "Pagination", "kind": 4194304, "kindString": "Type alias", @@ -15675,21 +16243,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1114, + "line": 1101, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1033, + "id": 1042, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1035, + "id": 1044, "name": "lastPage", "kind": 1024, "kindString": "Property", @@ -15697,7 +16265,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1117, + "line": 1104, "character": 2 } ], @@ -15707,7 +16275,7 @@ } }, { - "id": 1034, + "id": 1043, "name": "nextPage", "kind": 1024, "kindString": "Property", @@ -15715,7 +16283,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1116, + "line": 1103, "character": 2 } ], @@ -15734,7 +16302,7 @@ } }, { - "id": 1036, + "id": 1045, "name": "total", "kind": 1024, "kindString": "Property", @@ -15742,7 +16310,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1118, + "line": 1105, "character": 2 } ], @@ -15756,25 +16324,25 @@ { "title": "Properties", "kind": 1024, - "children": [1035, 1034, 1036] + "children": [1044, 1043, 1045] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1114, + "line": 1101, "character": 25 } ], "indexSignature": { - "id": 1037, + "id": 1046, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1038, + "id": 1047, "name": "key", "kind": 32768, "flags": {}, @@ -15793,7 +16361,7 @@ } }, { - "id": 478, + "id": 493, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -15871,6 +16439,10 @@ "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -15899,7 +16471,7 @@ } }, { - "id": 803, + "id": 824, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -15907,7 +16479,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 646, + "line": 664, "character": 12 } ], @@ -15917,14 +16489,14 @@ { "type": "reflection", "declaration": { - "id": 804, + "id": 825, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 806, + "id": 827, "name": "email", "kind": 1024, "kindString": "Property", @@ -15932,7 +16504,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 649, + "line": 667, "character": 6 } ], @@ -15942,7 +16514,7 @@ } }, { - "id": 807, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -15952,21 +16524,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 650, + "line": 668, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 808, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -15979,7 +16551,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 654, + "line": 672, "character": 8 } ], @@ -15989,7 +16561,7 @@ } }, { - "id": 809, + "id": 830, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -16002,7 +16574,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 670, "character": 8 } ], @@ -16016,13 +16588,13 @@ { "title": "Properties", "kind": 1024, - "children": [810, 809] + "children": [831, 830] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 650, + "line": 668, "character": 16 } ] @@ -16030,7 +16602,7 @@ } }, { - "id": 805, + "id": 826, "name": "type", "kind": 1024, "kindString": "Property", @@ -16038,7 +16610,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 648, + "line": 666, "character": 6 } ], @@ -16047,7 +16619,7 @@ "typeArguments": [ { "type": "reference", - "id": 802, + "id": 823, "name": "EmailOtpType" }, { @@ -16074,13 +16646,13 @@ { "title": "Properties", "kind": 1024, - "children": [806, 807, 805] + "children": [827, 828, 826] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 647, + "line": 665, "character": 4 } ] @@ -16089,14 +16661,14 @@ { "type": "reflection", "declaration": { - "id": 811, + "id": 832, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 814, + "id": 835, "name": "options", "kind": 1024, "kindString": "Property", @@ -16106,21 +16678,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 660, + "line": 678, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 815, + "id": 836, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 816, + "id": 837, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16133,7 +16705,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 662, + "line": 680, "character": 8 } ], @@ -16147,13 +16719,13 @@ { "title": "Properties", "kind": 1024, - "children": [816] + "children": [837] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 660, + "line": 678, "character": 16 } ] @@ -16161,7 +16733,7 @@ } }, { - "id": 813, + "id": 834, "name": "phone", "kind": 1024, "kindString": "Property", @@ -16169,7 +16741,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 659, + "line": 677, "character": 6 } ], @@ -16179,7 +16751,7 @@ } }, { - "id": 812, + "id": 833, "name": "type", "kind": 1024, "kindString": "Property", @@ -16187,7 +16759,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 658, + "line": 676, "character": 6 } ], @@ -16196,7 +16768,7 @@ "typeArguments": [ { "type": "reference", - "id": 801, + "id": 822, "name": "MobileOtpType" }, { @@ -16223,13 +16795,13 @@ { "title": "Properties", "kind": 1024, - "children": [814, 813, 812] + "children": [835, 834, 833] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 675, "character": 4 } ] @@ -16239,7 +16811,7 @@ } }, { - "id": 598, + "id": 615, "name": "SSOResponse", "kind": 4194304, "kindString": "Type alias", @@ -16247,7 +16819,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 189, + "line": 195, "character": 12 } ], @@ -16257,14 +16829,14 @@ { "type": "reflection", "declaration": { - "id": 599, + "id": 616, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 600, + "id": 617, "name": "data", "kind": 1024, "kindString": "Property", @@ -16272,21 +16844,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 191, + "line": 197, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 601, + "id": 618, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 602, + "id": 619, "name": "url", "kind": 1024, "kindString": "Property", @@ -16298,7 +16870,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 199, + "line": 205, "character": 8 } ], @@ -16312,13 +16884,13 @@ { "title": "Properties", "kind": 1024, - "children": [602] + "children": [619] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 191, + "line": 197, "character": 12 } ] @@ -16326,7 +16898,7 @@ } }, { - "id": 603, + "id": 620, "name": "error", "kind": 1024, "kindString": "Property", @@ -16334,7 +16906,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 201, + "line": 207, "character": 6 } ], @@ -16348,13 +16920,13 @@ { "title": "Properties", "kind": 1024, - "children": [600, 603] + "children": [617, 620] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 190, + "line": 196, "character": 4 } ] @@ -16363,14 +16935,14 @@ { "type": "reflection", "declaration": { - "id": 604, + "id": 621, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 605, + "id": 622, "name": "data", "kind": 1024, "kindString": "Property", @@ -16378,7 +16950,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 204, + "line": 210, "character": 6 } ], @@ -16388,7 +16960,7 @@ } }, { - "id": 606, + "id": 623, "name": "error", "kind": 1024, "kindString": "Property", @@ -16396,13 +16968,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 205, + "line": 211, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -16411,13 +16983,13 @@ { "title": "Properties", "kind": 1024, - "children": [605, 606] + "children": [622, 623] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 203, + "line": 209, "character": 4 } ] @@ -16427,7 +16999,7 @@ } }, { - "id": 706, + "id": 726, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -16435,21 +17007,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 473, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 707, + "id": 727, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 708, + "id": 728, "name": "options", "kind": 1024, "kindString": "Property", @@ -16459,21 +17031,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 456, + "line": 474, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 709, + "id": 729, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 711, + "id": 731, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16486,7 +17058,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 482, "character": 4 } ], @@ -16496,7 +17068,7 @@ } }, { - "id": 710, + "id": 730, "name": "data", "kind": 1024, "kindString": "Property", @@ -16510,7 +17082,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 462, + "line": 480, "character": 4 } ], @@ -16524,13 +17096,13 @@ { "title": "Properties", "kind": 1024, - "children": [711, 710] + "children": [731, 730] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 456, + "line": 474, "character": 12 } ] @@ -16542,13 +17114,13 @@ { "title": "Properties", "kind": 1024, - "children": [708] + "children": [728] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 473, "character": 43 } ] @@ -16556,7 +17128,7 @@ } }, { - "id": 772, + "id": 792, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -16564,21 +17136,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 581, + "line": 599, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 773, + "id": 793, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 776, + "id": 797, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -16591,7 +17163,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 587, + "line": 605, "character": 2 } ], @@ -16601,7 +17173,7 @@ } }, { - "id": 777, + "id": 798, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -16614,7 +17186,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 589, + "line": 607, "character": 2 } ], @@ -16624,7 +17196,7 @@ } }, { - "id": 778, + "id": 799, "name": "options", "kind": 1024, "kindString": "Property", @@ -16634,21 +17206,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 608, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 779, + "id": 800, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 780, + "id": 801, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -16661,7 +17233,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 592, + "line": 610, "character": 4 } ], @@ -16675,13 +17247,13 @@ { "title": "Properties", "kind": 1024, - "children": [780] + "children": [801] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 608, "character": 12 } ] @@ -16689,18 +17261,18 @@ } }, { - "id": 774, + "id": 794, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "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`, `keycloak` (deprecated)." + "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`, `keycloak` (deprecated)." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 583, + "line": 601, "character": 2 } ], @@ -16724,14 +17296,40 @@ "value": "facebook" }, { - "type": "intrinsic", - "name": "string" + "type": "literal", + "value": "kakao" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 795, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 601, + "character": 76 + } + ] + } + } + ] } ] } }, { - "id": 775, + "id": 796, "name": "token", "kind": 1024, "kindString": "Property", @@ -16742,7 +17340,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 585, + "line": 603, "character": 2 } ], @@ -16756,13 +17354,13 @@ { "title": "Properties", "kind": 1024, - "children": [776, 777, 778, 774, 775] + "children": [797, 798, 799, 794, 796] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 581, + "line": 599, "character": 43 } ] @@ -16770,7 +17368,7 @@ } }, { - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -16778,21 +17376,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 761, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 763, + "id": 783, "name": "options", "kind": 1024, "kindString": "Property", @@ -16802,21 +17400,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 764, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 767, + "id": 787, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -16829,14 +17427,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 768, + "id": 788, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -16844,19 +17442,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 18 } ], "indexSignature": { - "id": 769, + "id": 789, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 770, + "id": 790, "name": "key", "kind": 32768, "flags": {}, @@ -16875,7 +17473,7 @@ } }, { - "id": 765, + "id": 785, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -16888,7 +17486,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 571, + "line": 589, "character": 4 } ], @@ -16898,7 +17496,7 @@ } }, { - "id": 766, + "id": 786, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -16911,7 +17509,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 573, + "line": 591, "character": 4 } ], @@ -16921,7 +17519,7 @@ } }, { - "id": 771, + "id": 791, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -16934,7 +17532,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 577, + "line": 595, "character": 4 } ], @@ -16948,13 +17546,13 @@ { "title": "Properties", "kind": 1024, - "children": [767, 765, 766, 771] + "children": [787, 785, 786, 791] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 12 } ] @@ -16962,7 +17560,7 @@ } }, { - "id": 762, + "id": 782, "name": "provider", "kind": 1024, "kindString": "Property", @@ -16973,13 +17571,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 568, + "line": 586, "character": 2 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider" } } @@ -16988,13 +17586,13 @@ { "title": "Properties", "kind": 1024, - "children": [763, 762] + "children": [783, 782] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 41 } ] @@ -17002,7 +17600,7 @@ } }, { - "id": 729, + "id": 749, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -17010,7 +17608,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 523, "character": 12 } ], @@ -17020,14 +17618,14 @@ { "type": "reflection", "declaration": { - "id": 730, + "id": 750, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 731, + "id": 751, "name": "email", "kind": 1024, "kindString": "Property", @@ -17038,7 +17636,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 508, + "line": 526, "character": 6 } ], @@ -17048,7 +17646,7 @@ } }, { - "id": 733, + "id": 753, "name": "options", "kind": 1024, "kindString": "Property", @@ -17058,21 +17656,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 511, + "line": 529, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17085,7 +17683,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 513, + "line": 531, "character": 8 } ], @@ -17099,13 +17697,13 @@ { "title": "Properties", "kind": 1024, - "children": [735] + "children": [755] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 511, + "line": 529, "character": 16 } ] @@ -17113,7 +17711,7 @@ } }, { - "id": 732, + "id": 752, "name": "password", "kind": 1024, "kindString": "Property", @@ -17124,7 +17722,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 510, + "line": 528, "character": 6 } ], @@ -17138,13 +17736,13 @@ { "title": "Properties", "kind": 1024, - "children": [731, 733, 732] + "children": [751, 753, 752] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 524, "character": 4 } ] @@ -17153,14 +17751,14 @@ { "type": "reflection", "declaration": { - "id": 736, + "id": 756, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 739, + "id": 759, "name": "options", "kind": 1024, "kindString": "Property", @@ -17170,21 +17768,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 521, + "line": 539, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 740, + "id": 760, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 741, + "id": 761, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17194,203 +17792,6 @@ "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 523, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [741] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 521, - "character": 16 - } - ] - } - } - }, - { - "id": 738, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 520, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 737, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 518, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [739, 738, 737] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 516, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 742, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 527, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 743, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 744, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 530, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 745, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 531, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 746, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 750, - "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": 543, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 749, - "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.raw_user_meta_data` 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", @@ -17398,103 +17799,139 @@ "character": 8 } ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 747, - "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": 533, - "character": 8 - } - ], "type": { "type": "intrinsic", "name": "string" } - }, - { - "id": 748, - "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": 535, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [750, 749, 747, 748] + "children": [761] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 531, + "line": 539, "character": 16 } ] } } + }, + { + "id": 758, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 538, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 757, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 536, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [744, 745] + "children": [759, 758, 757] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 528, + "line": 534, "character": 4 } ] } - }, + } + ] + } + }, + { + "id": 762, + "name": "SignInWithPasswordlessCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 545, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ { "type": "reflection", "declaration": { - "id": 751, + "id": 763, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 753, + "id": 764, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 548, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 765, "name": "options", "kind": 1024, "kindString": "Property", @@ -17511,14 +17948,14 @@ "type": { "type": "reflection", "declaration": { - "id": 754, + "id": 766, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 757, + "id": 770, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17531,7 +17968,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 559, + "line": 561, "character": 8 } ], @@ -17541,7 +17978,168 @@ } }, { - "id": 758, + "id": 769, + "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.raw_user_meta_data` 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": 559, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 767, + "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": 551, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 768, + "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": 553, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [770, 769, 767, 768] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 549, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [764, 765] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 546, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 771, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 773, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 567, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 774, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 777, + "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": 577, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 778, "name": "channel", "kind": 1024, "kindString": "Property", @@ -17554,7 +18152,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 579, "character": 8 } ], @@ -17573,7 +18171,7 @@ } }, { - "id": 756, + "id": 776, "name": "data", "kind": 1024, "kindString": "Property", @@ -17587,7 +18185,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 557, + "line": 575, "character": 8 } ], @@ -17597,7 +18195,7 @@ } }, { - "id": 755, + "id": 775, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -17610,7 +18208,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 551, + "line": 569, "character": 8 } ], @@ -17624,13 +18222,13 @@ { "title": "Properties", "kind": 1024, - "children": [757, 758, 756, 755] + "children": [777, 778, 776, 775] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 567, "character": 16 } ] @@ -17638,7 +18236,7 @@ } }, { - "id": 752, + "id": 772, "name": "phone", "kind": 1024, "kindString": "Property", @@ -17649,7 +18247,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 548, + "line": 566, "character": 6 } ], @@ -17663,13 +18261,13 @@ { "title": "Properties", "kind": 1024, - "children": [753, 752] + "children": [773, 772] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 564, "character": 4 } ] @@ -17679,7 +18277,7 @@ } }, { - "id": 817, + "id": 838, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -17687,7 +18285,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 666, + "line": 684, "character": 12 } ], @@ -17697,14 +18295,14 @@ { "type": "reflection", "declaration": { - "id": 818, + "id": 839, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 820, + "id": 841, "name": "options", "kind": 1024, "kindString": "Property", @@ -17714,21 +18312,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 671, + "line": 689, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 821, + "id": 842, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 823, + "id": 844, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17741,7 +18339,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 675, + "line": 693, "character": 8 } ], @@ -17751,7 +18349,7 @@ } }, { - "id": 822, + "id": 843, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -17764,7 +18362,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 673, + "line": 691, "character": 8 } ], @@ -17778,13 +18376,13 @@ { "title": "Properties", "kind": 1024, - "children": [823, 822] + "children": [844, 843] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 671, + "line": 689, "character": 16 } ] @@ -17792,7 +18390,7 @@ } }, { - "id": 819, + "id": 840, "name": "providerId", "kind": 1024, "kindString": "Property", @@ -17803,7 +18401,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 669, + "line": 687, "character": 6 } ], @@ -17817,13 +18415,13 @@ { "title": "Properties", "kind": 1024, - "children": [820, 819] + "children": [841, 840] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 667, + "line": 685, "character": 4 } ] @@ -17832,14 +18430,14 @@ { "type": "reflection", "declaration": { - "id": 824, + "id": 845, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 825, + "id": 846, "name": "domain", "kind": 1024, "kindString": "Property", @@ -17850,7 +18448,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 680, + "line": 698, "character": 6 } ], @@ -17860,7 +18458,7 @@ } }, { - "id": 826, + "id": 847, "name": "options", "kind": 1024, "kindString": "Property", @@ -17870,21 +18468,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 682, + "line": 700, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 827, + "id": 848, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 829, + "id": 850, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -17897,7 +18495,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 686, + "line": 704, "character": 8 } ], @@ -17907,7 +18505,7 @@ } }, { - "id": 828, + "id": 849, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -17920,7 +18518,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 684, + "line": 702, "character": 8 } ], @@ -17934,13 +18532,13 @@ { "title": "Properties", "kind": 1024, - "children": [829, 828] + "children": [850, 849] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 682, + "line": 700, "character": 16 } ] @@ -17952,13 +18550,13 @@ { "title": "Properties", "kind": 1024, - "children": [825, 826] + "children": [846, 847] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 678, + "line": 696, "character": 4 } ] @@ -17968,7 +18566,7 @@ } }, { - "id": 1043, + "id": 1052, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -17976,21 +18574,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1128, + "line": 1115, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1044, + "id": 1053, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1045, + "id": 1054, "name": "scope", "kind": 1024, "kindString": "Property", @@ -18003,7 +18601,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1139, + "line": 1126, "character": 2 } ], @@ -18030,13 +18628,13 @@ { "title": "Properties", "kind": 1024, - "children": [1045] + "children": [1054] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1128, + "line": 1115, "character": 22 } ] @@ -18044,7 +18642,7 @@ } }, { - "id": 712, + "id": 732, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -18052,7 +18650,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 468, + "line": 486, "character": 12 } ], @@ -18062,14 +18660,14 @@ { "type": "reflection", "declaration": { - "id": 713, + "id": 733, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 714, + "id": 734, "name": "email", "kind": 1024, "kindString": "Property", @@ -18080,7 +18678,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 471, + "line": 489, "character": 6 } ], @@ -18090,166 +18688,7 @@ } }, { - "id": 716, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 474, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 717, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 720, - "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": 484, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 719, - "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.raw_user_meta_data` 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": 482, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 718, - "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": 476, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [720, 719, 718] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 474, - "character": 16 - } - ] - } - } - }, - { - "id": 715, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 473, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [714, 716, 715] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 469, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 721, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 724, + "id": 736, "name": "options", "kind": 1024, "kindString": "Property", @@ -18266,14 +18705,14 @@ "type": { "type": "reflection", "declaration": { - "id": 725, + "id": 737, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 727, + "id": 740, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -18281,30 +18720,7 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 500, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 728, - "name": "channel", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { @@ -18314,21 +18730,12 @@ } ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] + "type": "intrinsic", + "name": "string" } }, { - "id": 726, + "id": 739, "name": "data", "kind": 1024, "kindString": "Property", @@ -18342,7 +18749,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 498, + "line": 500, "character": 8 } ], @@ -18350,13 +18757,36 @@ "type": "intrinsic", "name": "object" } + }, + { + "id": 738, + "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": 494, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [727, 728, 726] + "children": [740, 739, 738] } ], "sources": [ @@ -18370,7 +18800,7 @@ } }, { - "id": 723, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -18389,9 +18819,177 @@ "type": "intrinsic", "name": "string" } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [734, 736, 735] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 487, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 741, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 744, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 510, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 745, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 747, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 518, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 748, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 746, + "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.raw_user_meta_data` 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": 516, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [747, 748, 746] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 510, + "character": 16 + } + ] + } + } }, { - "id": 722, + "id": 743, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 509, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 742, "name": "phone", "kind": 1024, "kindString": "Property", @@ -18402,7 +19000,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 489, + "line": 507, "character": 6 } ], @@ -18416,13 +19014,13 @@ { "title": "Properties", "kind": 1024, - "children": [724, 723, 722] + "children": [744, 743, 742] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 487, + "line": 505, "character": 4 } ] @@ -18432,7 +19030,7 @@ } }, { - "id": 1019, + "id": 1028, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -18440,7 +19038,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1089, + "line": 1076, "character": 12 } ], @@ -18487,14 +19085,14 @@ { "type": "reflection", "declaration": { - "id": 1020, + "id": 1029, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1021, + "id": 1030, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -18507,7 +19105,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1099, + "line": 1086, "character": 2 } ], @@ -18521,13 +19119,13 @@ { "title": "Properties", "kind": 1024, - "children": [1021] + "children": [1030] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1091, + "line": 1078, "character": 4 } ] @@ -18537,7 +19135,7 @@ } }, { - "id": 607, + "id": 624, "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", @@ -18545,7 +19143,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 208, + "line": 214, "character": 12 } ], @@ -18555,117 +19153,14 @@ { "type": "reflection", "declaration": { - "id": 608, + "id": 625, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 609, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 210, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 610, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 611, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 211, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 656, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [611] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 210, - "character": 12 - } - ] - } - } - }, - { - "id": 612, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 213, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [609, 612] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 209, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 613, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 614, + "id": 626, "name": "data", "kind": 1024, "kindString": "Property", @@ -18680,14 +19175,14 @@ "type": { "type": "reflection", "declaration": { - "id": 615, + "id": 627, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 616, + "id": 628, "name": "user", "kind": 1024, "kindString": "Property", @@ -18700,8 +19195,9 @@ } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 675, + "name": "User" } } ], @@ -18709,7 +19205,7 @@ { "title": "Properties", "kind": 1024, - "children": [616] + "children": [628] } ], "sources": [ @@ -18723,7 +19219,7 @@ } }, { - "id": 617, + "id": 629, "name": "error", "kind": 1024, "kindString": "Property", @@ -18736,9 +19232,8 @@ } ], "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" + "type": "literal", + "value": null } } ], @@ -18746,7 +19241,7 @@ { "title": "Properties", "kind": 1024, - "children": [614, 617] + "children": [626, 629] } ], "sources": [ @@ -18757,12 +19252,115 @@ } ] } + }, + { + "type": "reflection", + "declaration": { + "id": 630, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 631, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 632, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 633, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 223, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [633] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, + "character": 12 + } + ] + } + } + }, + { + "id": 634, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 225, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [631, 634] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 221, + "character": 4 + } + ] + } } ] } }, { - "id": 781, + "id": 802, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -18770,7 +19368,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 596, + "line": 614, "character": 12 } ], @@ -18779,24 +19377,24 @@ "types": [ { "type": "reference", - "id": 782, + "id": 803, "name": "VerifyMobileOtpParams" }, { "type": "reference", - "id": 790, + "id": 811, "name": "VerifyEmailOtpParams" }, { "type": "reference", - "id": 798, + "id": 819, "name": "VerifyTokenHashParams" } ] } }, { - "id": 511, + "id": 528, "name": "WeakPassword", "kind": 4194304, "kindString": "Type alias", @@ -18804,21 +19402,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 92, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 512, + "id": 529, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 514, + "id": 531, "name": "message", "kind": 1024, "kindString": "Property", @@ -18826,7 +19424,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 88, + "line": 94, "character": 2 } ], @@ -18836,7 +19434,7 @@ } }, { - "id": 513, + "id": 530, "name": "reasons", "kind": 1024, "kindString": "Property", @@ -18844,7 +19442,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 87, + "line": 93, "character": 2 } ], @@ -18852,7 +19450,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 510, + "id": 526, "name": "WeakPasswordReasons" } } @@ -18862,13 +19460,13 @@ { "title": "Properties", "kind": 1024, - "children": [514, 513] + "children": [531, 530] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 92, "character": 27 } ] @@ -18876,7 +19474,7 @@ } }, { - "id": 510, + "id": 526, "name": "WeakPasswordReasons", "kind": 4194304, "kindString": "Type alias", @@ -18884,7 +19482,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 85, + "line": 91, "character": 12 } ], @@ -18904,14 +19502,36 @@ "value": "pwned" }, { - "type": "intrinsic", - "name": "string" + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 527, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 91, + "character": 80 + } + ] + } + } + ] } ] } }, { - "id": 460, + "id": 475, "name": "AuthAdminApi", "kind": 32, "kindString": "Variable", @@ -18936,7 +19556,7 @@ "defaultValue": "GoTrueAdminApi" }, { - "id": 461, + "id": 476, "name": "AuthClient", "kind": 32, "kindString": "Variable", @@ -18961,7 +19581,7 @@ "defaultValue": "GoTrueClient" }, { - "id": 475, + "id": 490, "name": "lockInternals", "kind": 32, "kindString": "Variable", @@ -18986,14 +19606,14 @@ "type": { "type": "reflection", "declaration": { - "id": 476, + "id": 491, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 477, + "id": 492, "name": "debug", "kind": 1024, "kindString": "Property", @@ -19024,7 +19644,7 @@ { "title": "Properties", "kind": 1024, - "children": [477] + "children": [492] } ] } @@ -19032,7 +19652,7 @@ "defaultValue": "..." }, { - "id": 1049, + "id": 1096, "name": "isAuthApiError", "kind": 64, "kindString": "Function", @@ -19040,20 +19660,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 36, + "line": 41, "character": 16 } ], "signatures": [ { - "id": 1050, + "id": 1097, "name": "isAuthApiError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1051, + "id": 1098, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -19070,7 +19690,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1065, + "id": 1121, "name": "AuthApiError" } } @@ -19078,7 +19698,7 @@ ] }, { - "id": 1046, + "id": 1093, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -19086,20 +19706,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 14, + "line": 26, "character": 16 } ], "signatures": [ { - "id": 1047, + "id": 1094, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1048, + "id": 1095, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -19116,7 +19736,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -19124,7 +19744,53 @@ ] }, { - "id": 1052, + "id": 1102, + "name": "isAuthImplicitGrantRedirectError", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 105, + "character": 16 + } + ], + "signatures": [ + { + "id": 1103, + "name": "isAuthImplicitGrantRedirectError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 1104, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 1178, + "name": "AuthImplicitGrantRedirectError" + } + } + } + ] + }, + { + "id": 1105, "name": "isAuthRetryableFetchError", "kind": 64, "kindString": "Function", @@ -19132,20 +19798,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 126, + "line": 135, "character": 16 } ], "signatures": [ { - "id": 1053, + "id": 1106, "name": "isAuthRetryableFetchError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1054, + "id": 1107, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -19162,7 +19828,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1188, + "id": 1232, "name": "AuthRetryableFetchError" } } @@ -19170,7 +19836,53 @@ ] }, { - "id": 1055, + "id": 1099, + "name": "isAuthSessionMissingError", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 72, + "character": 16 + } + ], + "signatures": [ + { + "id": 1100, + "name": "isAuthSessionMissingError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 1101, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 1153, + "name": "AuthSessionMissingError" + } + } + } + ] + }, + { + "id": 1108, "name": "isAuthWeakPasswordError", "kind": 64, "kindString": "Function", @@ -19178,20 +19890,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 148, + "line": 157, "character": 16 } ], "signatures": [ { - "id": 1056, + "id": 1109, "name": "isAuthWeakPasswordError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1057, + "id": 1110, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -19208,7 +19920,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1202, + "id": 1242, "name": "AuthWeakPasswordError" } } @@ -19216,7 +19928,7 @@ ] }, { - "id": 462, + "id": 477, "name": "navigatorLock", "kind": 64, "kindString": "Function", @@ -19224,13 +19936,13 @@ "sources": [ { "fileName": "src/lib/locks.ts", - "line": 58, + "line": 59, "character": 22 } ], "signatures": [ { - "id": 463, + "id": 478, "name": "navigatorLock", "kind": 4096, "kindString": "Call signature", @@ -19241,7 +19953,7 @@ }, "typeParameter": [ { - "id": 464, + "id": 479, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -19250,7 +19962,7 @@ ], "parameters": [ { - "id": 465, + "id": 480, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -19264,7 +19976,7 @@ } }, { - "id": 466, + "id": 481, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -19278,7 +19990,7 @@ } }, { - "id": 467, + "id": 482, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -19289,14 +20001,14 @@ "type": { "type": "reflection", "declaration": { - "id": 468, + "id": 483, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 469, + "id": 484, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -19306,7 +20018,7 @@ "typeArguments": [ { "type": "reference", - "id": 464, + "id": 479, "name": "R" } ], @@ -19325,7 +20037,7 @@ "typeArguments": [ { "type": "reference", - "id": 464, + "id": 479, "name": "R" } ], @@ -19341,34 +20053,32 @@ { "title": "Classes", "kind": 128, - "children": [1065, 1058, 1138, 1125, 1113, 1163, 1188, 1101, 1078, 1202, 1086, 1, 78, 470] + "children": [1121, 1111, 1178, 1169, 1161, 1205, 1232, 1153, 1131, 1242, 1141, 1, 78, 485] }, { "title": "Interfaces", "kind": 256, - "children": [ - 627, 685, 642, 852, 1012, 967, 618, 696, 704, 656, 649, 679, 630, 653, 790, 782, 798 - ] + "children": [644, 705, 660, 873, 1021, 972, 635, 718, 675, 668, 699, 648, 672, 811, 803, 819] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 480, 479, 759, 996, 987, 1009, 1000, 935, 910, 956, 945, 926, 897, 542, 515, 528, 557, 570, - 955, 1025, 802, 846, 836, 855, 869, 856, 876, 841, 830, 490, 1022, 481, 893, 890, 877, 882, - 885, 801, 585, 1039, 1032, 478, 803, 598, 706, 772, 760, 729, 742, 817, 1043, 712, 1019, - 607, 781, 511, 510 + 495, 494, 779, 1005, 996, 1018, 1009, 938, 1081, 928, 1065, 961, 949, 929, 915, 559, 532, + 545, 574, 587, 960, 1034, 823, 867, 857, 876, 890, 877, 897, 862, 851, 505, 1031, 496, 911, + 907, 898, 1060, 1055, 899, 902, 822, 602, 1048, 1041, 493, 824, 615, 726, 792, 780, 749, + 762, 838, 1052, 732, 1028, 624, 802, 528, 526 ] }, { "title": "Variables", "kind": 32, - "children": [460, 461, 475] + "children": [475, 476, 490] }, { "title": "Functions", "kind": 64, - "children": [1049, 1046, 1052, 1055, 462] + "children": [1096, 1093, 1102, 1105, 1099, 1108, 477] } ], "sources": [ diff --git a/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json index eaabe8ddafa..a6f4145a128 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 1065, + "id": 1121, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1066, + "id": 1122, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -22,20 +22,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 21, + "line": 33, "character": 2 } ], "signatures": [ { - "id": 1067, + "id": 1123, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1068, + "id": 1124, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -46,7 +46,7 @@ } }, { - "id": 1069, + "id": 1125, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -55,36 +55,113 @@ "type": "intrinsic", "name": "number" } + }, + { + "id": 1126, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } } ], "type": { "type": "reference", - "id": 1065, + "id": 1121, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 1060, + "id": 1113, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1059, + "id": 1112, "name": "AuthError.constructor" } }, { - "id": 1070, + "id": 1128, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1129, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1117, + "name": "AuthError.code" + } + }, + { + "id": 1127, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 19, + "line": 31, "character": 2 } ], @@ -94,151 +171,47 @@ }, "overwrites": { "type": "reference", - "id": 1063, + "id": 1119, "name": "AuthError.status" } - }, - { - "id": 1071, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 27, - "character": 2 - } - ], - "signatures": [ - { - "id": 1072, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1073, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1075, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 30, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1074, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 29, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1076, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 31, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1075, 1074, 1076] - } - ] - } - } - } - ] } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1066] + "children": [1122] }, { "title": "Properties", "kind": 1024, - "children": [1070] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1071] + "children": [1128, 1127] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 18, + "line": 30, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] }, { - "id": 1058, + "id": 1111, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1059, + "id": 1112, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -246,20 +219,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 7, + "line": 18, "character": 2 } ], "signatures": [ { - "id": 1060, + "id": 1113, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1061, + "id": 1114, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -270,7 +243,7 @@ } }, { - "id": 1062, + "id": 1115, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -281,11 +254,24 @@ "type": "intrinsic", "name": "number" } + }, + { + "id": 1116, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" }, "overwrites": { @@ -300,15 +286,67 @@ } }, { - "id": 1063, + "id": 1117, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1118, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + } + }, + { + "id": 1119, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 4, + "line": 14, "character": 2 } ], @@ -331,18 +369,18 @@ { "title": "Constructors", "kind": 512, - "children": [1059] + "children": [1112] }, { "title": "Properties", "kind": 1024, - "children": [1063] + "children": [1117, 1119] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 3, + "line": 4, "character": 13 } ], @@ -357,30 +395,30 @@ "extendedBy": [ { "type": "reference", - "id": 1065, + "id": 1121, "name": "AuthApiError" }, { "type": "reference", - "id": 1078, + "id": 1131, "name": "AuthUnknownError" }, { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1138, + "id": 1178, "name": "AuthImplicitGrantRedirectError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1139, + "id": 1179, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -388,20 +426,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 88, + "line": 90, "character": 2 } ], "signatures": [ { - "id": 1140, + "id": 1180, "name": "new AuthImplicitGrantRedirectError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1141, + "id": 1181, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -412,7 +450,7 @@ } }, { - "id": 1142, + "id": 1182, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -427,14 +465,14 @@ { "type": "reflection", "declaration": { - "id": 1143, + "id": 1183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1145, + "id": 1185, "name": "code", "kind": 1024, "kindString": "Property", @@ -442,7 +480,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 88, + "line": 90, "character": 57 } ], @@ -452,7 +490,7 @@ } }, { - "id": 1144, + "id": 1184, "name": "error", "kind": 1024, "kindString": "Property", @@ -460,7 +498,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 88, + "line": 90, "character": 42 } ], @@ -474,7 +512,7 @@ { "title": "Properties", "kind": 1024, - "children": [1145, 1144] + "children": [1185, 1184] } ] } @@ -486,24 +524,78 @@ ], "type": { "type": "reference", - "id": 1138, + "id": 1178, "name": "AuthImplicitGrantRedirectError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1146, + "id": 1202, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1203, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1186, "name": "details", "kind": 1024, "kindString": "Property", @@ -511,7 +603,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 2 } ], @@ -525,14 +617,14 @@ { "type": "reflection", "declaration": { - "id": 1147, + "id": 1187, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1149, + "id": 1189, "name": "code", "kind": 1024, "kindString": "Property", @@ -540,7 +632,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 28 } ], @@ -550,7 +642,7 @@ } }, { - "id": 1148, + "id": 1188, "name": "error", "kind": 1024, "kindString": "Property", @@ -558,7 +650,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 13 } ], @@ -572,7 +664,7 @@ { "title": "Properties", "kind": 1024, - "children": [1149, 1148] + "children": [1189, 1188] } ] } @@ -582,7 +674,7 @@ "defaultValue": "null" }, { - "id": 1160, + "id": 1200, "name": "name", "kind": 1024, "kindString": "Property", @@ -590,7 +682,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -600,20 +692,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1161, + "id": 1201, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -623,12 +718,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } }, { - "id": 1150, + "id": 1190, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -636,13 +731,13 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 93, + "line": 95, "character": 2 } ], "signatures": [ { - "id": 1151, + "id": 1191, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -650,14 +745,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1152, + "id": 1192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1156, + "id": 1196, "name": "details", "kind": 1024, "kindString": "Property", @@ -665,7 +760,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 98, + "line": 100, "character": 6 } ], @@ -679,14 +774,14 @@ { "type": "reflection", "declaration": { - "id": 1157, + "id": 1197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1159, + "id": 1199, "name": "code", "kind": 1024, "kindString": "Property", @@ -694,7 +789,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 28 } ], @@ -704,7 +799,7 @@ } }, { - "id": 1158, + "id": 1198, "name": "error", "kind": 1024, "kindString": "Property", @@ -712,7 +807,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 87, + "line": 89, "character": 13 } ], @@ -726,7 +821,7 @@ { "title": "Properties", "kind": 1024, - "children": [1159, 1158] + "children": [1199, 1198] } ] } @@ -736,7 +831,7 @@ "defaultValue": "..." }, { - "id": 1154, + "id": 1194, "name": "message", "kind": 1024, "kindString": "Property", @@ -744,7 +839,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 96, + "line": 98, "character": 6 } ], @@ -755,30 +850,11 @@ "defaultValue": "..." }, { - "id": 1153, + "id": 1193, "name": "name", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 95, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1155, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/lib/errors.ts", @@ -786,6 +862,25 @@ "character": 6 } ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 1195, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 99, + "character": 6 + } + ], "type": { "type": "intrinsic", "name": "number" @@ -797,66 +892,56 @@ { "title": "Properties", "kind": 1024, - "children": [1156, 1154, 1153, 1155] + "children": [1196, 1194, 1193, 1195] } ] } - }, - "overwrites": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" } } - ], - "overwrites": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } + ] } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1139] + "children": [1179] }, { "title": "Properties", "kind": 1024, - "children": [1146, 1160, 1161] + "children": [1202, 1186, 1200, 1201] }, { "title": "Methods", "kind": 2048, - "children": [1150] + "children": [1190] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 86, + "line": 88, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1125, + "id": 1169, "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1126, + "id": 1170, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -864,20 +949,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 81, + "line": 83, "character": 2 } ], "signatures": [ { - "id": 1127, + "id": 1171, "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1128, + "id": 1172, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -890,24 +975,78 @@ ], "type": { "type": "reference", - "id": 1125, + "id": 1169, "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1129, + "id": 1175, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1176, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1173, "name": "name", "kind": 1024, "kindString": "Property", @@ -915,7 +1054,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -925,20 +1064,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1130, + "id": 1174, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -948,161 +1090,47 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } - }, - { - "id": 1131, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1132, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1135, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1134, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1136, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1135, 1134, 1136] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1126] + "children": [1170] }, { "title": "Properties", "kind": 1024, - "children": [1129, 1130] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1131] + "children": [1175, 1173, 1174] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 80, + "line": 82, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1113, + "id": 1161, "name": "AuthInvalidTokenResponseError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1114, + "id": 1162, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1110,37 +1138,91 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 75, + "line": 77, "character": 2 } ], "signatures": [ { - "id": 1115, + "id": 1163, "name": "new AuthInvalidTokenResponseError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1113, + "id": 1161, "name": "AuthInvalidTokenResponseError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1116, + "id": 1166, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1167, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1164, "name": "name", "kind": 1024, "kindString": "Property", @@ -1148,7 +1230,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -1158,20 +1240,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1117, + "id": 1165, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -1181,161 +1266,47 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } - }, - { - "id": 1118, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1119, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1120, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1122, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1121, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1123, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1122, 1121, 1123] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1114] + "children": [1162] }, { "title": "Properties", "kind": 1024, - "children": [1116, 1117] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1118] + "children": [1166, 1164, 1165] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 74, + "line": 76, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1163, + "id": 1205, "name": "AuthPKCEGrantCodeExchangeError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1164, + "id": 1206, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1343,20 +1314,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 105, + "line": 114, "character": 2 } ], "signatures": [ { - "id": 1165, + "id": 1207, "name": "new AuthPKCEGrantCodeExchangeError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1166, + "id": 1208, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1367,7 +1338,7 @@ } }, { - "id": 1167, + "id": 1209, "name": "details", "kind": 32768, "kindString": "Parameter", @@ -1382,14 +1353,14 @@ { "type": "reflection", "declaration": { - "id": 1168, + "id": 1210, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1170, + "id": 1212, "name": "code", "kind": 1024, "kindString": "Property", @@ -1397,7 +1368,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 105, + "line": 114, "character": 57 } ], @@ -1407,7 +1378,7 @@ } }, { - "id": 1169, + "id": 1211, "name": "error", "kind": 1024, "kindString": "Property", @@ -1415,7 +1386,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 105, + "line": 114, "character": 42 } ], @@ -1429,7 +1400,7 @@ { "title": "Properties", "kind": 1024, - "children": [1170, 1169] + "children": [1212, 1211] } ] } @@ -1441,24 +1412,78 @@ ], "type": { "type": "reference", - "id": 1163, + "id": 1205, "name": "AuthPKCEGrantCodeExchangeError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1171, + "id": 1229, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1230, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1213, "name": "details", "kind": 1024, "kindString": "Property", @@ -1466,7 +1491,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 2 } ], @@ -1480,14 +1505,14 @@ { "type": "reflection", "declaration": { - "id": 1172, + "id": 1214, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1174, + "id": 1216, "name": "code", "kind": 1024, "kindString": "Property", @@ -1495,7 +1520,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 28 } ], @@ -1505,7 +1530,7 @@ } }, { - "id": 1173, + "id": 1215, "name": "error", "kind": 1024, "kindString": "Property", @@ -1513,7 +1538,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 13 } ], @@ -1527,7 +1552,7 @@ { "title": "Properties", "kind": 1024, - "children": [1174, 1173] + "children": [1216, 1215] } ] } @@ -1537,7 +1562,7 @@ "defaultValue": "null" }, { - "id": 1185, + "id": 1227, "name": "name", "kind": 1024, "kindString": "Property", @@ -1545,7 +1570,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -1555,20 +1580,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1186, + "id": 1228, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -1578,12 +1606,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } }, { - "id": 1175, + "id": 1217, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1591,13 +1619,13 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 110, + "line": 119, "character": 2 } ], "signatures": [ { - "id": 1176, + "id": 1218, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1605,14 +1633,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1177, + "id": 1219, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1181, + "id": 1223, "name": "details", "kind": 1024, "kindString": "Property", @@ -1620,7 +1648,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 115, + "line": 124, "character": 6 } ], @@ -1634,14 +1662,14 @@ { "type": "reflection", "declaration": { - "id": 1182, + "id": 1224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1184, + "id": 1226, "name": "code", "kind": 1024, "kindString": "Property", @@ -1649,7 +1677,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 28 } ], @@ -1659,7 +1687,7 @@ } }, { - "id": 1183, + "id": 1225, "name": "error", "kind": 1024, "kindString": "Property", @@ -1667,7 +1695,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 104, + "line": 112, "character": 13 } ], @@ -1681,7 +1709,7 @@ { "title": "Properties", "kind": 1024, - "children": [1184, 1183] + "children": [1226, 1225] } ] } @@ -1691,7 +1719,7 @@ "defaultValue": "..." }, { - "id": 1179, + "id": 1221, "name": "message", "kind": 1024, "kindString": "Property", @@ -1699,7 +1727,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 113, + "line": 122, "character": 6 } ], @@ -1710,7 +1738,7 @@ "defaultValue": "..." }, { - "id": 1178, + "id": 1220, "name": "name", "kind": 1024, "kindString": "Property", @@ -1718,7 +1746,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 112, + "line": 121, "character": 6 } ], @@ -1729,7 +1757,7 @@ "defaultValue": "..." }, { - "id": 1180, + "id": 1222, "name": "status", "kind": 1024, "kindString": "Property", @@ -1737,7 +1765,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 114, + "line": 123, "character": 6 } ], @@ -1752,66 +1780,56 @@ { "title": "Properties", "kind": 1024, - "children": [1181, 1179, 1178, 1180] + "children": [1223, 1221, 1220, 1222] } ] } - }, - "overwrites": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" } } - ], - "overwrites": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } + ] } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1164] + "children": [1206] }, { "title": "Properties", "kind": 1024, - "children": [1171, 1185, 1186] + "children": [1229, 1213, 1227, 1228] }, { "title": "Methods", "kind": 2048, - "children": [1175] + "children": [1217] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 103, + "line": 111, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1188, + "id": 1232, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1189, + "id": 1233, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1819,20 +1837,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 121, + "line": 130, "character": 2 } ], "signatures": [ { - "id": 1190, + "id": 1234, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1191, + "id": 1235, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1843,7 +1861,7 @@ } }, { - "id": 1192, + "id": 1236, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -1856,24 +1874,78 @@ ], "type": { "type": "reference", - "id": 1188, + "id": 1232, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1193, + "id": 1239, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1240, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1237, "name": "name", "kind": 1024, "kindString": "Property", @@ -1881,7 +1953,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -1891,20 +1963,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1194, + "id": 1238, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -1914,161 +1989,47 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } - }, - { - "id": 1195, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1196, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1197, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1199, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1198, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1200, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1199, 1198, 1200] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1189] + "children": [1233] }, { "title": "Properties", "kind": 1024, - "children": [1193, 1194] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1195] + "children": [1239, 1237, 1238] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 120, + "line": 129, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1101, + "id": 1153, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1102, + "id": 1154, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2076,37 +2037,91 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 69, + "line": 67, "character": 2 } ], "signatures": [ { - "id": 1103, + "id": 1155, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 1101, + "id": 1153, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1104, + "id": 1158, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1159, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1156, "name": "name", "kind": 1024, "kindString": "Property", @@ -2114,7 +2129,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -2124,20 +2139,23 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1105, + "id": 1157, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -2147,161 +2165,47 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } - }, - { - "id": 1106, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1107, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1110, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1109, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1111, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1110, 1109, 1111] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1102] + "children": [1154] }, { "title": "Properties", "kind": 1024, - "children": [1104, 1105] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1106] + "children": [1158, 1156, 1157] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 68, + "line": 66, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" } ] }, { - "id": 1078, + "id": 1131, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 1079, + "id": 1132, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2309,20 +2213,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 43, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 1080, + "id": 1133, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1081, + "id": 1134, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2333,7 +2237,7 @@ } }, { - "id": 1082, + "id": 1135, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -2346,24 +2250,78 @@ ], "type": { "type": "reference", - "id": 1078, + "id": 1131, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 1060, + "id": 1113, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1059, + "id": 1112, "name": "AuthError.constructor" } }, { - "id": 1083, + "id": 1137, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1138, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1117, + "name": "AuthError.code" + } + }, + { + "id": 1136, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -2371,7 +2329,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 41, + "line": 46, "character": 2 } ], @@ -2381,15 +2339,18 @@ } }, { - "id": 1084, + "id": 1139, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 4, + "line": 14, "character": 2 } ], @@ -2408,7 +2369,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1063, + "id": 1119, "name": "AuthError.status" } } @@ -2417,31 +2378,31 @@ { "title": "Constructors", "kind": 512, - "children": [1079] + "children": [1132] }, { "title": "Properties", "kind": 1024, - "children": [1083, 1084] + "children": [1137, 1136, 1139] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 40, + "line": 45, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] }, { - "id": 1202, + "id": 1242, "name": "AuthWeakPasswordError", "kind": 128, "kindString": "Class", @@ -2451,7 +2412,7 @@ }, "children": [ { - "id": 1203, + "id": 1243, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2459,20 +2420,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 141, + "line": 150, "character": 2 } ], "signatures": [ { - "id": 1204, + "id": 1244, "name": "new AuthWeakPasswordError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1205, + "id": 1245, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2483,7 +2444,7 @@ } }, { - "id": 1206, + "id": 1246, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2494,7 +2455,7 @@ } }, { - "id": 1207, + "id": 1247, "name": "reasons", "kind": 32768, "kindString": "Parameter", @@ -2510,24 +2471,78 @@ ], "type": { "type": "reference", - "id": 1202, + "id": 1242, "name": "AuthWeakPasswordError" }, "overwrites": { "type": "reference", - "id": 1088, + "id": 1143, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1087, + "id": 1142, "name": "CustomAuthError.constructor" } }, { - "id": 1209, + "id": 1251, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1252, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1150, + "name": "CustomAuthError.code" + } + }, + { + "id": 1249, "name": "name", "kind": 1024, "kindString": "Property", @@ -2535,7 +2550,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -2545,12 +2560,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1092, + "id": 1148, "name": "CustomAuthError.name" } }, { - "id": 1208, + "id": 1248, "name": "reasons", "kind": 1024, "kindString": "Property", @@ -2561,28 +2576,32 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 139, + "line": 148, "character": 2 } ], "type": { "type": "array", "elementType": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "id": 526, + "name": "WeakPasswordReasons" } } }, { - "id": 1210, + "id": 1250, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -2592,15 +2611,50 @@ }, "inheritedFrom": { "type": "reference", - "id": 1093, + "id": 1149, "name": "CustomAuthError.status" } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [1243] }, { - "id": 1211, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", + "title": "Properties", + "kind": 1024, + "children": [1251, 1249, 1248, 1250] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 144, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 1141, + "name": "CustomAuthError" + } + ] + }, + { + "id": 1141, + "name": "CustomAuthError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 1142, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, "sources": [ { @@ -2611,163 +2665,14 @@ ], "signatures": [ { - "id": 1212, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1213, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1215, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1214, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1216, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1215, 1214, 1216] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 1095, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 1094, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [1203] - }, - { - "title": "Properties", - "kind": 1024, - "children": [1209, 1208, 1210] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1211] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 135, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 1086, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1086, - "name": "CustomAuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 1087, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 2 - } - ], - "signatures": [ - { - "id": 1088, + "id": 1143, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1089, + "id": 1144, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2778,7 +2683,7 @@ } }, { - "id": 1090, + "id": 1145, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -2789,7 +2694,7 @@ } }, { - "id": 1091, + "id": 1146, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -2798,28 +2703,102 @@ "type": "intrinsic", "name": "number" } + }, + { + "id": 1147, + "name": "code", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } } ], "type": { "type": "reference", - "id": 1086, + "id": 1141, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 1060, + "id": 1113, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 1059, + "id": 1112, "name": "AuthError.constructor" } }, { - "id": 1092, + "id": 1150, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase {@link #status} will also be undefined." + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 11, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "name": "ErrorCode" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1151, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + } + ] + }, + "inheritedFrom": { + "type": "reference", + "id": 1117, + "name": "AuthError.code" + } + }, + { + "id": 1148, "name": "name", "kind": 1024, "kindString": "Property", @@ -2827,7 +2806,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 56, "character": 2 } ], @@ -2841,15 +2820,18 @@ } }, { - "id": 1093, + "id": 1149, "name": "status", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "HTTP status code that caused the error." + }, "sources": [ { "fileName": "src/lib/errors.ts", - "line": 52, + "line": 57, "character": 2 } ], @@ -2859,175 +2841,71 @@ }, "overwrites": { "type": "reference", - "id": 1063, + "id": 1119, "name": "AuthError.status" } - }, - { - "id": 1094, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 59, - "character": 2 - } - ], - "signatures": [ - { - "id": 1095, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1096, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1098, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1097, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 1099, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 63, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1098, 1097, 1099] - } - ] - } - } - } - ] } ], "groups": [ { "title": "Constructors", "kind": 512, - "children": [1087] + "children": [1142] }, { "title": "Properties", "kind": 1024, - "children": [1092, 1093] - }, - { - "title": "Methods", - "kind": 2048, - "children": [1094] + "children": [1150, 1148, 1149] } ], "sources": [ { "fileName": "src/lib/errors.ts", - "line": 50, + "line": 55, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 1101, + "id": 1153, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 1113, + "id": 1161, "name": "AuthInvalidTokenResponseError" }, { "type": "reference", - "id": 1125, + "id": 1169, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 1138, + "id": 1178, "name": "AuthImplicitGrantRedirectError" }, { "type": "reference", - "id": 1163, + "id": 1205, "name": "AuthPKCEGrantCodeExchangeError" }, { "type": "reference", - "id": 1188, + "id": 1232, "name": "AuthRetryableFetchError" }, { "type": "reference", - "id": 1202, + "id": 1242, "name": "AuthWeakPasswordError" } ] @@ -3270,10 +3148,10 @@ ], "type": { "type": "reference", - "id": 1012, + "id": 1021, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 1012, + "id": 1021, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -3289,14 +3167,14 @@ }, "children": [ { - "id": 1016, + "id": 1025, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1017, + "id": 1026, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -3316,17 +3194,17 @@ }, "parameters": [ { - "id": 1018, + "id": 1027, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -3342,21 +3220,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1028, + "line": 1015, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 997, + "id": 1006, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 998, + "id": 1007, "name": "id", "kind": 1024, "kindString": "Property", @@ -3367,7 +3245,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1030, + "line": 1017, "character": 2 } ], @@ -3377,7 +3255,7 @@ } }, { - "id": 999, + "id": 1008, "name": "userId", "kind": 1024, "kindString": "Property", @@ -3388,7 +3266,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1033, + "line": 1020, "character": 2 } ], @@ -3402,13 +3280,13 @@ { "title": "Properties", "kind": 1024, - "children": [998, 999] + "children": [1007, 1008] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1028, + "line": 1015, "character": 45 } ] @@ -3423,7 +3301,7 @@ "typeArguments": [ { "type": "reference", - "id": 987, + "id": 996, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -3435,14 +3313,14 @@ ] }, { - "id": 1013, + "id": 1022, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1014, + "id": 1023, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -3452,17 +3330,17 @@ }, "parameters": [ { - "id": 1015, + "id": 1024, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -3478,21 +3356,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1039, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1010, + "id": 1019, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1011, + "id": 1020, "name": "userId", "kind": 1024, "kindString": "Property", @@ -3503,7 +3381,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1054, + "line": 1041, "character": 2 } ], @@ -3517,13 +3395,13 @@ { "title": "Properties", "kind": 1024, - "children": [1011] + "children": [1020] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1039, "character": 44 } ] @@ -3538,7 +3416,7 @@ "typeArguments": [ { "type": "reference", - "id": 1000, + "id": 1009, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -3554,13 +3432,13 @@ { "title": "Methods", "kind": 2048, - "children": [1016, 1013] + "children": [1025, 1022] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1062, + "line": 1049, "character": 17 } ] @@ -3599,17 +3477,17 @@ "flags": {}, "type": { "type": "reference", - "id": 685, + "id": 705, "name": "AdminUserAttributes", "dereferenced": { - "id": 685, + "id": 705, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 687, + "id": 707, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -3623,7 +3501,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 398, + "line": 404, "character": 2 } ], @@ -3633,7 +3511,7 @@ } }, { - "id": 690, + "id": 710, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -3647,7 +3525,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 424, + "line": 430, "character": 2 } ], @@ -3657,7 +3535,7 @@ } }, { - "id": 694, + "id": 717, "name": "email", "kind": 1024, "kindString": "Property", @@ -3670,7 +3548,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -3684,7 +3562,7 @@ } }, { - "id": 688, + "id": 708, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -3698,7 +3576,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 411, "character": 2 } ], @@ -3708,7 +3586,31 @@ } }, { - "id": 693, + "id": 713, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `id` for the user.", + "text": "Allows you to overwrite the default `id` set for the user.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 455, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 715, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -3722,7 +3624,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -3736,7 +3638,7 @@ } }, { - "id": 692, + "id": 714, "name": "password", "kind": 1024, "kindString": "Property", @@ -3749,7 +3651,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -3763,7 +3665,31 @@ } }, { - "id": 695, + "id": 712, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `password_hash` for the user's password.", + "text": "Allows 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.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 716, "name": "phone", "kind": 1024, "kindString": "Property", @@ -3776,7 +3702,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -3790,7 +3716,7 @@ } }, { - "id": 689, + "id": 709, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -3804,7 +3730,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 412, + "line": 418, "character": 2 } ], @@ -3814,7 +3740,7 @@ } }, { - "id": 691, + "id": 711, "name": "role", "kind": 1024, "kindString": "Property", @@ -3828,7 +3754,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 439, "character": 2 } ], @@ -3838,7 +3764,7 @@ } }, { - "id": 686, + "id": 706, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -3852,7 +3778,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 388, + "line": 394, "character": 2 } ], @@ -3866,13 +3792,13 @@ { "title": "Properties", "kind": 1024, - "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] + "children": [707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 377, + "line": 383, "character": 17 } ], @@ -3882,7 +3808,7 @@ "typeArguments": [ { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes" }, { @@ -3904,7 +3830,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -3960,7 +3886,7 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If true, then the user will be soft-deleted (setting `deleted_at` to the current timestamp and disabling their account while preserving their data) from the auth schema.\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.\n" + "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.\n" }, "type": { "type": "intrinsic", @@ -3974,7 +3900,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -4017,10 +3943,10 @@ "flags": {}, "type": { "type": "reference", - "id": 855, + "id": 876, "name": "GenerateLinkParams", "dereferenced": { - "id": 855, + "id": 876, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4028,7 +3954,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 733, + "line": 751, "character": 12 } ], @@ -4036,7 +3962,7 @@ "type": "union", "types": [ { - "id": 830, + "id": 851, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4044,21 +3970,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 831, + "id": 852, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 854, "name": "email", "kind": 1024, "kindString": "Property", @@ -4066,7 +3992,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 692, + "line": 710, "character": 2 } ], @@ -4076,7 +4002,7 @@ } }, { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -4086,7 +4012,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 694, + "line": 712, "character": 2 } ], @@ -4095,7 +4021,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -4118,7 +4044,7 @@ } }, { - "id": 834, + "id": 855, "name": "password", "kind": 1024, "kindString": "Property", @@ -4126,7 +4052,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 693, + "line": 711, "character": 2 } ], @@ -4136,7 +4062,7 @@ } }, { - "id": 832, + "id": 853, "name": "type", "kind": 1024, "kindString": "Property", @@ -4144,7 +4070,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 691, + "line": 709, "character": 2 } ], @@ -4158,13 +4084,13 @@ { "title": "Properties", "kind": 1024, - "children": [833, 835, 834, 832] + "children": [854, 856, 855, 853] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 39 } ] @@ -4172,7 +4098,7 @@ } }, { - "id": 836, + "id": 857, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4180,21 +4106,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 837, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 839, + "id": 860, "name": "email", "kind": 1024, "kindString": "Property", @@ -4205,7 +4131,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 700, + "line": 718, "character": 2 } ], @@ -4215,7 +4141,7 @@ } }, { - "id": 840, + "id": 861, "name": "options", "kind": 1024, "kindString": "Property", @@ -4225,7 +4151,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 701, + "line": 719, "character": 2 } ], @@ -4234,7 +4160,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -4257,7 +4183,7 @@ } }, { - "id": 838, + "id": 859, "name": "type", "kind": 1024, "kindString": "Property", @@ -4265,7 +4191,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 698, + "line": 716, "character": 2 } ], @@ -4288,13 +4214,13 @@ { "title": "Properties", "kind": 1024, - "children": [839, 840, 838] + "children": [860, 861, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 46 } ] @@ -4302,7 +4228,7 @@ } }, { - "id": 841, + "id": 862, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4310,21 +4236,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "email", "kind": 1024, "kindString": "Property", @@ -4335,7 +4261,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 707, + "line": 725, "character": 2 } ], @@ -4345,7 +4271,7 @@ } }, { - "id": 845, + "id": 866, "name": "options", "kind": 1024, "kindString": "Property", @@ -4355,7 +4281,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 708, + "line": 726, "character": 2 } ], @@ -4364,7 +4290,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -4378,7 +4304,7 @@ } }, { - "id": 843, + "id": 864, "name": "type", "kind": 1024, "kindString": "Property", @@ -4386,7 +4312,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 705, + "line": 723, "character": 2 } ], @@ -4400,13 +4326,13 @@ { "title": "Properties", "kind": 1024, - "children": [844, 845, 843] + "children": [865, 866, 864] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 41 } ] @@ -4414,7 +4340,7 @@ } }, { - "id": 846, + "id": 867, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -4422,21 +4348,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 847, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 849, + "id": 870, "name": "email", "kind": 1024, "kindString": "Property", @@ -4447,7 +4373,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 714, + "line": 732, "character": 2 } ], @@ -4457,7 +4383,7 @@ } }, { - "id": 850, + "id": 871, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -4468,7 +4394,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 718, + "line": 736, "character": 2 } ], @@ -4478,7 +4404,7 @@ } }, { - "id": 851, + "id": 872, "name": "options", "kind": 1024, "kindString": "Property", @@ -4488,7 +4414,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 719, + "line": 737, "character": 2 } ], @@ -4497,7 +4423,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -4511,7 +4437,7 @@ } }, { - "id": 848, + "id": 869, "name": "type", "kind": 1024, "kindString": "Property", @@ -4519,7 +4445,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 712, + "line": 730, "character": 2 } ], @@ -4542,13 +4468,13 @@ { "title": "Properties", "kind": 1024, - "children": [849, 850, 851, 848] + "children": [870, 871, 872, 869] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 44 } ] @@ -4566,7 +4492,7 @@ "typeArguments": [ { "type": "reference", - "id": 856, + "id": 877, "name": "GenerateLinkResponse" } ], @@ -4621,7 +4547,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -4752,7 +4678,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -4801,10 +4727,10 @@ }, "type": { "type": "reference", - "id": 1039, + "id": 1048, "name": "PageParams", "dereferenced": { - "id": 1039, + "id": 1048, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -4812,21 +4738,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1040, + "id": 1049, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1050, "name": "page", "kind": 1024, "kindString": "Property", @@ -4839,7 +4765,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1123, + "line": 1110, "character": 2 } ], @@ -4849,7 +4775,7 @@ } }, { - "id": 1042, + "id": 1051, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -4862,7 +4788,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1125, + "line": 1112, "character": 2 } ], @@ -4876,13 +4802,13 @@ { "title": "Properties", "kind": 1024, - "children": [1041, 1042] + "children": [1050, 1051] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 25 } ] @@ -4967,7 +4893,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } } @@ -4984,7 +4910,7 @@ }, { "type": "reference", - "id": 1032, + "id": 1041, "name": "Pagination" } ] @@ -5092,7 +5018,7 @@ ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -5235,7 +5161,7 @@ }, { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] @@ -5305,17 +5231,17 @@ }, "type": { "type": "reference", - "id": 685, + "id": 705, "name": "AdminUserAttributes", "dereferenced": { - "id": 685, + "id": 705, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 687, + "id": 707, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -5329,7 +5255,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 398, + "line": 404, "character": 2 } ], @@ -5339,7 +5265,7 @@ } }, { - "id": 690, + "id": 710, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -5353,7 +5279,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 424, + "line": 430, "character": 2 } ], @@ -5363,7 +5289,7 @@ } }, { - "id": 694, + "id": 717, "name": "email", "kind": 1024, "kindString": "Property", @@ -5376,7 +5302,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -5390,7 +5316,7 @@ } }, { - "id": 688, + "id": 708, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -5404,7 +5330,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 411, "character": 2 } ], @@ -5414,7 +5340,31 @@ } }, { - "id": 693, + "id": 713, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `id` for the user.", + "text": "Allows you to overwrite the default `id` set for the user.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 455, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 715, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -5428,7 +5378,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -5442,7 +5392,7 @@ } }, { - "id": 692, + "id": 714, "name": "password", "kind": 1024, "kindString": "Property", @@ -5455,7 +5405,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -5469,7 +5419,31 @@ } }, { - "id": 695, + "id": 712, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `password_hash` for the user's password.", + "text": "Allows 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.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 716, "name": "phone", "kind": 1024, "kindString": "Property", @@ -5482,7 +5456,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -5496,7 +5470,7 @@ } }, { - "id": 689, + "id": 709, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -5510,7 +5484,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 412, + "line": 418, "character": 2 } ], @@ -5520,7 +5494,7 @@ } }, { - "id": 691, + "id": 711, "name": "role", "kind": 1024, "kindString": "Property", @@ -5534,7 +5508,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 439, "character": 2 } ], @@ -5544,7 +5518,7 @@ } }, { - "id": 686, + "id": 706, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -5558,7 +5532,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 388, + "line": 394, "character": 2 } ], @@ -5572,13 +5546,13 @@ { "title": "Properties", "kind": 1024, - "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] + "children": [707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 377, + "line": 383, "character": 17 } ], @@ -5588,7 +5562,7 @@ "typeArguments": [ { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes" }, { @@ -5610,7 +5584,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -5663,7 +5637,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 175, + "line": 182, "character": 2 } ], @@ -5686,10 +5660,10 @@ "flags": {}, "type": { "type": "reference", - "id": 490, + "id": 505, "name": "GoTrueClientOptions", "dereferenced": { - "id": 490, + "id": 505, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -5697,21 +5671,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 491, + "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 499, + "id": 514, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -5721,7 +5695,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 66, + "line": 67, "character": 2 } ], @@ -5731,7 +5705,7 @@ } }, { - "id": 504, + "id": 519, "name": "debug", "kind": 1024, "kindString": "Property", @@ -5741,7 +5715,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 76, + "line": 77, "character": 2 } ], @@ -5755,7 +5729,7 @@ { "type": "reflection", "declaration": { - "id": 505, + "id": 520, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5763,20 +5737,20 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 76, + "line": 77, "character": 21 } ], "signatures": [ { - "id": 506, + "id": 521, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 522, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -5787,7 +5761,7 @@ } }, { - "id": 508, + "id": 523, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -5815,7 +5789,7 @@ } }, { - "id": 498, + "id": 513, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -5825,7 +5799,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 65, "character": 2 } ], @@ -5835,7 +5809,7 @@ } }, { - "id": 502, + "id": 517, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -5845,7 +5819,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 72, + "line": 73, "character": 2 } ], @@ -5855,7 +5829,7 @@ } }, { - "id": 503, + "id": 518, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -5865,16 +5839,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 75, "character": 2 } ], "type": { "type": "reference", - "id": 759, + "id": 779, "name": "AuthFlowType", "dereferenced": { - "id": 759, + "id": 779, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -5882,7 +5856,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 565, + "line": 583, "character": 12 } ], @@ -5903,7 +5877,36 @@ } }, { - "id": 493, + "id": 525, + "name": "hasCustomAuthorizationHeader", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set to \"true\" if there is a custom authorization header set globally.", + "tags": [ + { + "tag": "experimental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 508, "name": "headers", "kind": 1024, "kindString": "Property", @@ -5913,14 +5916,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 61, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 494, + "id": 509, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5928,19 +5931,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 61, "character": 12 } ], "indexSignature": { - "id": 495, + "id": 510, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 496, + "id": 511, "name": "key", "kind": 32768, "flags": {}, @@ -5959,7 +5962,7 @@ } }, { - "id": 509, + "id": 524, "name": "lock", "kind": 1024, "kindString": "Property", @@ -5978,16 +5981,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 83, "character": 2 } ], "type": { "type": "reference", - "id": 481, + "id": 496, "name": "LockFunc", "dereferenced": { - "id": 481, + "id": 496, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -5995,14 +5998,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 482, + "id": 497, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6010,13 +6013,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 23 } ], "signatures": [ { - "id": 483, + "id": 498, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -6032,7 +6035,7 @@ }, "typeParameter": [ { - "id": 489, + "id": 504, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -6041,7 +6044,7 @@ ], "parameters": [ { - "id": 484, + "id": 499, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -6055,7 +6058,7 @@ } }, { - "id": 485, + "id": 500, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -6069,7 +6072,7 @@ } }, { - "id": 486, + "id": 501, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -6080,7 +6083,7 @@ "type": { "type": "reflection", "declaration": { - "id": 487, + "id": 502, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6088,13 +6091,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 69 } ], "signatures": [ { - "id": 488, + "id": 503, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -6104,7 +6107,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -6123,7 +6126,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -6139,7 +6142,7 @@ } }, { - "id": 500, + "id": 515, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -6149,7 +6152,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 68, + "line": 69, "character": 2 } ], @@ -6159,7 +6162,7 @@ } }, { - "id": 501, + "id": 516, "name": "storage", "kind": 1024, "kindString": "Property", @@ -6169,16 +6172,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 71, "character": 2 } ], "type": { "type": "reference", - "id": 1019, + "id": 1028, "name": "SupportedStorage", "dereferenced": { - "id": 1019, + "id": 1028, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -6186,7 +6189,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1089, + "line": 1076, "character": 12 } ], @@ -6233,14 +6236,14 @@ { "type": "reflection", "declaration": { - "id": 1020, + "id": 1029, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1021, + "id": 1030, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -6253,7 +6256,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1099, + "line": 1086, "character": 2 } ], @@ -6267,13 +6270,13 @@ { "title": "Properties", "kind": 1024, - "children": [1021] + "children": [1030] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1091, + "line": 1078, "character": 4 } ] @@ -6285,7 +6288,7 @@ } }, { - "id": 497, + "id": 512, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -6295,7 +6298,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 62, + "line": 63, "character": 2 } ], @@ -6305,7 +6308,7 @@ } }, { - "id": 492, + "id": 507, "name": "url", "kind": 1024, "kindString": "Property", @@ -6315,7 +6318,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, + "line": 59, "character": 2 } ], @@ -6329,13 +6332,15 @@ { "title": "Properties", "kind": 1024, - "children": [499, 504, 498, 502, 503, 493, 509, 500, 501, 497, 492] + "children": [ + 514, 519, 513, 517, 518, 525, 508, 524, 515, 516, 512, 507 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 34 } ] @@ -6365,7 +6370,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 125, + "line": 132, "character": 2 } ], @@ -6611,10 +6616,10 @@ ], "type": { "type": "reference", - "id": 1012, + "id": 1021, "name": "GoTrueAdminMFAApi", "dereferenced": { - "id": 1012, + "id": 1021, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -6630,14 +6635,14 @@ }, "children": [ { - "id": 1016, + "id": 1025, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1017, + "id": 1026, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -6657,17 +6662,17 @@ }, "parameters": [ { - "id": 1018, + "id": 1027, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -6683,21 +6688,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1028, + "line": 1015, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 997, + "id": 1006, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 998, + "id": 1007, "name": "id", "kind": 1024, "kindString": "Property", @@ -6708,7 +6713,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1030, + "line": 1017, "character": 2 } ], @@ -6718,7 +6723,7 @@ } }, { - "id": 999, + "id": 1008, "name": "userId", "kind": 1024, "kindString": "Property", @@ -6729,7 +6734,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1033, + "line": 1020, "character": 2 } ], @@ -6743,13 +6748,13 @@ { "title": "Properties", "kind": 1024, - "children": [998, 999] + "children": [1007, 1008] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1028, + "line": 1015, "character": 45 } ] @@ -6764,7 +6769,7 @@ "typeArguments": [ { "type": "reference", - "id": 987, + "id": 996, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -6776,14 +6781,14 @@ ] }, { - "id": 1013, + "id": 1022, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1014, + "id": 1023, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -6793,17 +6798,17 @@ }, "parameters": [ { - "id": 1015, + "id": 1024, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -6819,21 +6824,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1039, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1010, + "id": 1019, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1011, + "id": 1020, "name": "userId", "kind": 1024, "kindString": "Property", @@ -6844,7 +6849,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1054, + "line": 1041, "character": 2 } ], @@ -6858,13 +6863,13 @@ { "title": "Properties", "kind": 1024, - "children": [1011] + "children": [1020] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1039, "character": 44 } ] @@ -6879,7 +6884,7 @@ "typeArguments": [ { "type": "reference", - "id": 1000, + "id": 1009, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -6895,13 +6900,13 @@ { "title": "Methods", "kind": 2048, - "children": [1016, 1013] + "children": [1025, 1022] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1062, + "line": 1049, "character": 17 } ] @@ -6940,17 +6945,17 @@ "flags": {}, "type": { "type": "reference", - "id": 685, + "id": 705, "name": "AdminUserAttributes", "dereferenced": { - "id": 685, + "id": 705, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 687, + "id": 707, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -6964,7 +6969,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 398, + "line": 404, "character": 2 } ], @@ -6974,7 +6979,7 @@ } }, { - "id": 690, + "id": 710, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -6988,7 +6993,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 424, + "line": 430, "character": 2 } ], @@ -6998,7 +7003,7 @@ } }, { - "id": 694, + "id": 717, "name": "email", "kind": 1024, "kindString": "Property", @@ -7011,7 +7016,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -7025,7 +7030,7 @@ } }, { - "id": 688, + "id": 708, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -7039,7 +7044,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 411, "character": 2 } ], @@ -7049,7 +7054,31 @@ } }, { - "id": 693, + "id": 713, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `id` for the user.", + "text": "Allows you to overwrite the default `id` set for the user.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 455, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 715, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -7063,7 +7092,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -7077,7 +7106,7 @@ } }, { - "id": 692, + "id": 714, "name": "password", "kind": 1024, "kindString": "Property", @@ -7090,7 +7119,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -7104,7 +7133,31 @@ } }, { - "id": 695, + "id": 712, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `password_hash` for the user's password.", + "text": "Allows 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.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 716, "name": "phone", "kind": 1024, "kindString": "Property", @@ -7117,7 +7170,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -7131,7 +7184,7 @@ } }, { - "id": 689, + "id": 709, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -7145,7 +7198,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 412, + "line": 418, "character": 2 } ], @@ -7155,7 +7208,7 @@ } }, { - "id": 691, + "id": 711, "name": "role", "kind": 1024, "kindString": "Property", @@ -7169,7 +7222,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 439, "character": 2 } ], @@ -7179,7 +7232,7 @@ } }, { - "id": 686, + "id": 706, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -7193,7 +7246,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 388, + "line": 394, "character": 2 } ], @@ -7207,13 +7260,15 @@ { "title": "Properties", "kind": 1024, - "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] + "children": [ + 707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 377, + "line": 383, "character": 17 } ], @@ -7223,7 +7278,7 @@ "typeArguments": [ { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes" }, { @@ -7245,7 +7300,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -7301,7 +7356,7 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "If true, then the user will be soft-deleted (setting `deleted_at` to the current timestamp and disabling their account while preserving their data) from the auth schema.\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.\n" + "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.\n" }, "type": { "type": "intrinsic", @@ -7315,7 +7370,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -7358,10 +7413,10 @@ "flags": {}, "type": { "type": "reference", - "id": 855, + "id": 876, "name": "GenerateLinkParams", "dereferenced": { - "id": 855, + "id": 876, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7369,7 +7424,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 733, + "line": 751, "character": 12 } ], @@ -7377,7 +7432,7 @@ "type": "union", "types": [ { - "id": 830, + "id": 851, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7385,21 +7440,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 831, + "id": 852, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 854, "name": "email", "kind": 1024, "kindString": "Property", @@ -7407,7 +7462,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 692, + "line": 710, "character": 2 } ], @@ -7417,7 +7472,7 @@ } }, { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -7427,7 +7482,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 694, + "line": 712, "character": 2 } ], @@ -7436,7 +7491,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -7459,7 +7514,7 @@ } }, { - "id": 834, + "id": 855, "name": "password", "kind": 1024, "kindString": "Property", @@ -7467,7 +7522,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 693, + "line": 711, "character": 2 } ], @@ -7477,7 +7532,7 @@ } }, { - "id": 832, + "id": 853, "name": "type", "kind": 1024, "kindString": "Property", @@ -7485,7 +7540,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 691, + "line": 709, "character": 2 } ], @@ -7499,13 +7554,13 @@ { "title": "Properties", "kind": 1024, - "children": [833, 835, 834, 832] + "children": [854, 856, 855, 853] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 39 } ] @@ -7513,7 +7568,7 @@ } }, { - "id": 836, + "id": 857, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7521,21 +7576,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 837, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 839, + "id": 860, "name": "email", "kind": 1024, "kindString": "Property", @@ -7546,7 +7601,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 700, + "line": 718, "character": 2 } ], @@ -7556,7 +7611,7 @@ } }, { - "id": 840, + "id": 861, "name": "options", "kind": 1024, "kindString": "Property", @@ -7566,7 +7621,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 701, + "line": 719, "character": 2 } ], @@ -7575,7 +7630,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -7598,7 +7653,7 @@ } }, { - "id": 838, + "id": 859, "name": "type", "kind": 1024, "kindString": "Property", @@ -7606,7 +7661,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 698, + "line": 716, "character": 2 } ], @@ -7629,13 +7684,13 @@ { "title": "Properties", "kind": 1024, - "children": [839, 840, 838] + "children": [860, 861, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 46 } ] @@ -7643,7 +7698,7 @@ } }, { - "id": 841, + "id": 862, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7651,21 +7706,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "email", "kind": 1024, "kindString": "Property", @@ -7676,7 +7731,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 707, + "line": 725, "character": 2 } ], @@ -7686,7 +7741,7 @@ } }, { - "id": 845, + "id": 866, "name": "options", "kind": 1024, "kindString": "Property", @@ -7696,7 +7751,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 708, + "line": 726, "character": 2 } ], @@ -7705,7 +7760,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -7719,7 +7774,7 @@ } }, { - "id": 843, + "id": 864, "name": "type", "kind": 1024, "kindString": "Property", @@ -7727,7 +7782,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 705, + "line": 723, "character": 2 } ], @@ -7741,13 +7796,13 @@ { "title": "Properties", "kind": 1024, - "children": [844, 845, 843] + "children": [865, 866, 864] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 41 } ] @@ -7755,7 +7810,7 @@ } }, { - "id": 846, + "id": 867, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -7763,21 +7818,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 847, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 849, + "id": 870, "name": "email", "kind": 1024, "kindString": "Property", @@ -7788,7 +7843,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 714, + "line": 732, "character": 2 } ], @@ -7798,7 +7853,7 @@ } }, { - "id": 850, + "id": 871, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -7809,7 +7864,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 718, + "line": 736, "character": 2 } ], @@ -7819,7 +7874,7 @@ } }, { - "id": 851, + "id": 872, "name": "options", "kind": 1024, "kindString": "Property", @@ -7829,7 +7884,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 719, + "line": 737, "character": 2 } ], @@ -7838,7 +7893,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -7852,7 +7907,7 @@ } }, { - "id": 848, + "id": 869, "name": "type", "kind": 1024, "kindString": "Property", @@ -7860,7 +7915,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 712, + "line": 730, "character": 2 } ], @@ -7883,13 +7938,13 @@ { "title": "Properties", "kind": 1024, - "children": [849, 850, 851, 848] + "children": [870, 871, 872, 869] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 44 } ] @@ -7907,7 +7962,7 @@ "typeArguments": [ { "type": "reference", - "id": 856, + "id": 877, "name": "GenerateLinkResponse" } ], @@ -7962,7 +8017,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -8093,7 +8148,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -8142,10 +8197,10 @@ }, "type": { "type": "reference", - "id": 1039, + "id": 1048, "name": "PageParams", "dereferenced": { - "id": 1039, + "id": 1048, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -8153,21 +8208,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1040, + "id": 1049, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1050, "name": "page", "kind": 1024, "kindString": "Property", @@ -8180,7 +8235,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1123, + "line": 1110, "character": 2 } ], @@ -8190,7 +8245,7 @@ } }, { - "id": 1042, + "id": 1051, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -8203,7 +8258,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1125, + "line": 1112, "character": 2 } ], @@ -8217,13 +8272,13 @@ { "title": "Properties", "kind": 1024, - "children": [1041, 1042] + "children": [1050, 1051] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 25 } ] @@ -8308,7 +8363,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } } @@ -8325,7 +8380,7 @@ }, { "type": "reference", - "id": 1032, + "id": 1041, "name": "Pagination" } ] @@ -8433,7 +8488,7 @@ ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -8576,7 +8631,7 @@ }, { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] @@ -8646,17 +8701,17 @@ }, "type": { "type": "reference", - "id": 685, + "id": 705, "name": "AdminUserAttributes", "dereferenced": { - "id": 685, + "id": 705, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 687, + "id": 707, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -8670,7 +8725,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 398, + "line": 404, "character": 2 } ], @@ -8680,7 +8735,7 @@ } }, { - "id": 690, + "id": 710, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -8694,7 +8749,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 424, + "line": 430, "character": 2 } ], @@ -8704,7 +8759,7 @@ } }, { - "id": 694, + "id": 717, "name": "email", "kind": 1024, "kindString": "Property", @@ -8717,7 +8772,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -8731,7 +8786,7 @@ } }, { - "id": 688, + "id": 708, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -8745,7 +8800,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 411, "character": 2 } ], @@ -8755,7 +8810,31 @@ } }, { - "id": 693, + "id": 713, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `id` for the user.", + "text": "Allows you to overwrite the default `id` set for the user.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 455, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 715, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -8769,7 +8848,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -8783,7 +8862,7 @@ } }, { - "id": 692, + "id": 714, "name": "password", "kind": 1024, "kindString": "Property", @@ -8796,7 +8875,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -8810,7 +8889,31 @@ } }, { - "id": 695, + "id": 712, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `password_hash` for the user's password.", + "text": "Allows 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.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 716, "name": "phone", "kind": 1024, "kindString": "Property", @@ -8823,7 +8926,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -8837,7 +8940,7 @@ } }, { - "id": 689, + "id": 709, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -8851,7 +8954,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 412, + "line": 418, "character": 2 } ], @@ -8861,7 +8964,7 @@ } }, { - "id": 691, + "id": 711, "name": "role", "kind": 1024, "kindString": "Property", @@ -8875,7 +8978,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 439, "character": 2 } ], @@ -8885,7 +8988,7 @@ } }, { - "id": 686, + "id": 706, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -8899,7 +9002,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 388, + "line": 394, "character": 2 } ], @@ -8913,13 +9016,15 @@ { "title": "Properties", "kind": 1024, - "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] + "children": [ + 707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706 + ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 377, + "line": 383, "character": 17 } ], @@ -8929,7 +9034,7 @@ "typeArguments": [ { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes" }, { @@ -8951,7 +9056,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -9002,16 +9107,16 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 129, + "line": 136, "character": 2 } ], "type": { "type": "reference", - "id": 967, + "id": 972, "name": "GoTrueMFAApi", "dereferenced": { - "id": 967, + "id": 972, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -9021,14 +9126,14 @@ }, "children": [ { - "id": 971, + "id": 980, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 972, + "id": 981, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -9038,17 +9143,17 @@ }, "parameters": [ { - "id": 973, + "id": 982, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 890, + "id": 907, "name": "MFAChallengeParams", "dereferenced": { - "id": 890, + "id": 907, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -9056,21 +9161,53 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 810, + "line": 821, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 891, + "id": 908, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 892, + "id": 910, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 825, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 909, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -9081,7 +9218,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 812, + "line": 823, "character": 2 } ], @@ -9095,13 +9232,13 @@ { "title": "Properties", "kind": 1024, - "children": [892] + "children": [910, 909] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 810, + "line": 821, "character": 33 } ] @@ -9116,7 +9253,7 @@ "typeArguments": [ { "type": "reference", - "id": 935, + "id": 938, "name": "AuthMFAChallengeResponse" } ], @@ -9128,14 +9265,14 @@ ] }, { - "id": 980, + "id": 989, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 981, + "id": 990, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -9145,17 +9282,17 @@ }, "parameters": [ { - "id": 982, + "id": 991, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 893, + "id": 911, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 893, + "id": 911, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -9163,21 +9300,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 894, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 896, + "id": 914, "name": "code", "kind": 1024, "kindString": "Property", @@ -9188,7 +9325,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 819, + "line": 832, "character": 2 } ], @@ -9198,7 +9335,7 @@ } }, { - "id": 895, + "id": 913, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -9209,7 +9346,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 817, + "line": 830, "character": 2 } ], @@ -9223,13 +9360,13 @@ { "title": "Properties", "kind": 1024, - "children": [896, 895] + "children": [914, 913] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 42 } ] @@ -9244,7 +9381,7 @@ "typeArguments": [ { "type": "reference", - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse" } ], @@ -9256,14 +9393,14 @@ ] }, { - "id": 968, + "id": 973, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 969, + "id": 974, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -9274,39 +9411,39 @@ }, "parameters": [ { - "id": 970, + "id": 975, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 877, - "name": "MFAEnrollParams", + "id": 1055, + "name": "MFAEnrollTOTPParams", "dereferenced": { - "id": 877, - "name": "MFAEnrollParams", + "id": 1055, + "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 785, + "line": 1129, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 878, + "id": 1056, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 879, + "id": 1057, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -9317,7 +9454,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 787, + "line": 1131, "character": 2 } ], @@ -9327,7 +9464,7 @@ } }, { - "id": 881, + "id": 1059, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -9340,7 +9477,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 791, + "line": 1135, "character": 2 } ], @@ -9350,7 +9487,7 @@ } }, { - "id": 880, + "id": 1058, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -9363,7 +9500,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 789, + "line": 1133, "character": 2 } ], @@ -9377,14 +9514,14 @@ { "title": "Properties", "kind": 1024, - "children": [879, 881, 880] + "children": [1057, 1059, 1058] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 785, - "character": 30 + "line": 1129, + "character": 34 } ] } @@ -9398,7 +9535,411 @@ "typeArguments": [ { "type": "reference", - "id": 910, + "id": 1065, + "name": "AuthMFAEnrollTOTPResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + }, + { + "id": 976, + "name": "enroll", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 977, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 1060, + "name": "MFAEnrollPhoneParams", + "dereferenced": { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1081, + "name": "AuthMFAEnrollPhoneResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + }, + { + "id": 978, + "name": "enroll", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 979, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 898, + "name": "MFAEnrollParams", + "dereferenced": { + "id": 898, + "name": "MFAEnrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 803, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "id": 1055, + "name": "MFAEnrollTOTPParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1056, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1057, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1131, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + }, + { + "id": 1059, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1135, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1058, + "name": "issuer", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Domain which the user is enrolled with." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1133, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1057, 1059, 1058] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 34 + } + ] + } + } + }, + { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + } + ] + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 928, "name": "AuthMFAEnrollResponse" } ], @@ -9410,14 +9951,14 @@ ] }, { - "id": 985, + "id": 994, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 986, + "id": 995, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -9431,7 +9972,7 @@ "typeArguments": [ { "type": "reference", - "id": 956, + "id": 961, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -9443,14 +9984,14 @@ ] }, { - "id": 983, + "id": 992, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 984, + "id": 993, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -9477,7 +10018,7 @@ "typeArguments": [ { "type": "reference", - "id": 945, + "id": 949, "name": "AuthMFAListFactorsResponse" } ], @@ -9489,14 +10030,14 @@ ] }, { - "id": 977, + "id": 986, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 978, + "id": 987, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -9506,17 +10047,17 @@ }, "parameters": [ { - "id": 979, + "id": 988, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 882, + "id": 899, "name": "MFAUnenrollParams", "dereferenced": { - "id": 882, + "id": 899, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -9524,21 +10065,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 794, + "line": 805, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 883, + "id": 900, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 884, + "id": 901, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -9549,7 +10090,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 796, + "line": 807, "character": 2 } ], @@ -9563,13 +10104,13 @@ { "title": "Properties", "kind": 1024, - "children": [884] + "children": [901] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 794, + "line": 805, "character": 32 } ] @@ -9584,7 +10125,7 @@ "typeArguments": [ { "type": "reference", - "id": 926, + "id": 929, "name": "AuthMFAUnenrollResponse" } ], @@ -9596,14 +10137,14 @@ ] }, { - "id": 974, + "id": 983, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 975, + "id": 984, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -9613,17 +10154,17 @@ }, "parameters": [ { - "id": 976, + "id": 985, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 885, + "id": 902, "name": "MFAVerifyParams", "dereferenced": { - "id": 885, + "id": 902, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -9631,21 +10172,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 799, + "line": 810, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 886, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 888, + "id": 905, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -9656,7 +10197,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 804, + "line": 815, "character": 2 } ], @@ -9666,7 +10207,7 @@ } }, { - "id": 889, + "id": 906, "name": "code", "kind": 1024, "kindString": "Property", @@ -9677,7 +10218,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 807, + "line": 818, "character": 2 } ], @@ -9687,7 +10228,7 @@ } }, { - "id": 887, + "id": 904, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -9698,7 +10239,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 801, + "line": 812, "character": 2 } ], @@ -9712,13 +10253,13 @@ { "title": "Properties", "kind": 1024, - "children": [888, 889, 887] + "children": [905, 906, 904] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 799, + "line": 810, "character": 30 } ] @@ -9733,7 +10274,7 @@ "typeArguments": [ { "type": "reference", - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse" } ], @@ -9749,13 +10290,13 @@ { "title": "Methods", "kind": 2048, - "children": [971, 980, 968, 985, 983, 977, 974] + "children": [980, 989, 973, 994, 992, 986, 983] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 949, + "line": 934, "character": 17 } ] @@ -9763,7 +10304,7 @@ } }, { - "id": 143, + "id": 144, "name": "exchangeCodeForSession", "kind": 2048, "kindString": "Method", @@ -9771,13 +10312,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 571, + "line": 584, "character": 8 } ], "signatures": [ { - "id": 144, + "id": 145, "name": "exchangeCodeForSession", "kind": 4096, "kindString": "Call signature", @@ -9787,7 +10328,7 @@ }, "parameters": [ { - "id": 145, + "id": 146, "name": "authCode", "kind": 32768, "kindString": "Parameter", @@ -9803,7 +10344,7 @@ "typeArguments": [ { "type": "reference", - "id": 557, + "id": 574, "name": "AuthTokenResponse" } ], @@ -9815,7 +10356,7 @@ ] }, { - "id": 182, + "id": 183, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -9823,13 +10364,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 926, + "line": 935, "character": 8 } ], "signatures": [ { - "id": 183, + "id": 184, "name": "getSession", "kind": 4096, "kindString": "Call signature", @@ -9847,14 +10388,14 @@ { "type": "reflection", "declaration": { - "id": 184, + "id": 185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 185, + "id": 186, "name": "data", "kind": 1024, "kindString": "Property", @@ -9869,14 +10410,14 @@ "type": { "type": "reflection", "declaration": { - "id": 186, + "id": 187, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 187, + "id": 188, "name": "session", "kind": 1024, "kindString": "Property", @@ -9890,7 +10431,7 @@ ], "type": { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } } @@ -9899,14 +10440,14 @@ { "title": "Properties", "kind": 1024, - "children": [187] + "children": [188] } ] } } }, { - "id": 188, + "id": 189, "name": "error", "kind": 1024, "kindString": "Property", @@ -9928,7 +10469,7 @@ { "title": "Properties", "kind": 1024, - "children": [185, 188] + "children": [186, 189] } ] } @@ -9936,14 +10477,14 @@ { "type": "reflection", "declaration": { - "id": 189, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 190, + "id": 191, "name": "data", "kind": 1024, "kindString": "Property", @@ -9958,14 +10499,14 @@ "type": { "type": "reflection", "declaration": { - "id": 191, + "id": 192, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 192, + "id": 193, "name": "session", "kind": 1024, "kindString": "Property", @@ -9987,14 +10528,14 @@ { "title": "Properties", "kind": 1024, - "children": [192] + "children": [193] } ] } } }, { - "id": 193, + "id": 194, "name": "error", "kind": 1024, "kindString": "Property", @@ -10008,7 +10549,7 @@ ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -10017,7 +10558,7 @@ { "title": "Properties", "kind": 1024, - "children": [190, 193] + "children": [191, 194] } ] } @@ -10025,14 +10566,14 @@ { "type": "reflection", "declaration": { - "id": 194, + "id": 195, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 195, + "id": 196, "name": "data", "kind": 1024, "kindString": "Property", @@ -10047,14 +10588,14 @@ "type": { "type": "reflection", "declaration": { - "id": 196, + "id": 197, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 197, + "id": 198, "name": "session", "kind": 1024, "kindString": "Property", @@ -10076,14 +10617,14 @@ { "title": "Properties", "kind": 1024, - "children": [197] + "children": [198] } ] } } }, { - "id": 198, + "id": 199, "name": "error", "kind": 1024, "kindString": "Property", @@ -10105,7 +10646,7 @@ { "title": "Properties", "kind": 1024, - "children": [195, 198] + "children": [196, 199] } ] } @@ -10121,7 +10662,7 @@ ] }, { - "id": 245, + "id": 246, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -10135,7 +10676,7 @@ ], "signatures": [ { - "id": 246, + "id": 247, "name": "getUser", "kind": 4096, "kindString": "Call signature", @@ -10145,7 +10686,7 @@ }, "parameters": [ { - "id": 247, + "id": 248, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -10166,7 +10707,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -10178,7 +10719,7 @@ ] }, { - "id": 349, + "id": 362, "name": "getUserIdentities", "kind": 2048, "kindString": "Method", @@ -10186,13 +10727,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1710, + "line": 1735, "character": 8 } ], "signatures": [ { - "id": 350, + "id": 363, "name": "getUserIdentities", "kind": 4096, "kindString": "Call signature", @@ -10209,14 +10750,14 @@ { "type": "reflection", "declaration": { - "id": 351, + "id": 364, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 352, + "id": 365, "name": "data", "kind": 1024, "kindString": "Property", @@ -10224,21 +10765,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1712, + "line": 1737, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 353, + "id": 366, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 367, "name": "identities", "kind": 1024, "kindString": "Property", @@ -10246,7 +10787,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1713, + "line": 1738, "character": 10 } ], @@ -10254,7 +10795,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 630, + "id": 648, "name": "UserIdentity" } } @@ -10264,14 +10805,14 @@ { "title": "Properties", "kind": 1024, - "children": [354] + "children": [367] } ] } } }, { - "id": 355, + "id": 368, "name": "error", "kind": 1024, "kindString": "Property", @@ -10279,7 +10820,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1715, + "line": 1740, "character": 8 } ], @@ -10293,7 +10834,7 @@ { "title": "Properties", "kind": 1024, - "children": [352, 355] + "children": [365, 368] } ] } @@ -10301,14 +10842,14 @@ { "type": "reflection", "declaration": { - "id": 356, + "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 370, "name": "data", "kind": 1024, "kindString": "Property", @@ -10316,7 +10857,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1717, + "line": 1742, "character": 8 } ], @@ -10326,7 +10867,7 @@ } }, { - "id": 358, + "id": 371, "name": "error", "kind": 1024, "kindString": "Property", @@ -10334,13 +10875,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1717, + "line": 1742, "character": 20 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -10349,7 +10890,7 @@ { "title": "Properties", "kind": 1024, - "children": [357, 358] + "children": [370, 371] } ] } @@ -10365,7 +10906,7 @@ ] }, { - "id": 127, + "id": 128, "name": "initialize", "kind": 2048, "kindString": "Method", @@ -10373,13 +10914,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 278, + "line": 286, "character": 8 } ], "signatures": [ { - "id": 128, + "id": 129, "name": "initialize", "kind": 4096, "kindString": "Call signature", @@ -10392,7 +10933,7 @@ "typeArguments": [ { "type": "reference", - "id": 1022, + "id": 1031, "name": "InitializeResult" } ], @@ -10404,7 +10945,7 @@ ] }, { - "id": 359, + "id": 372, "name": "linkIdentity", "kind": 2048, "kindString": "Method", @@ -10412,13 +10953,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1734, + "line": 1759, "character": 8 } ], "signatures": [ { - "id": 360, + "id": 373, "name": "linkIdentity", "kind": 4096, "kindString": "Call signature", @@ -10428,17 +10969,17 @@ }, "parameters": [ { - "id": 361, + "id": 374, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -10446,21 +10987,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 761, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 763, + "id": 783, "name": "options", "kind": 1024, "kindString": "Property", @@ -10470,21 +11011,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 764, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 767, + "id": 787, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -10497,14 +11038,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 768, + "id": 788, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -10512,19 +11053,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 18 } ], "indexSignature": { - "id": 769, + "id": 789, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 770, + "id": 790, "name": "key", "kind": 32768, "flags": {}, @@ -10543,7 +11084,7 @@ } }, { - "id": 765, + "id": 785, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -10556,7 +11097,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 571, + "line": 589, "character": 4 } ], @@ -10566,7 +11107,7 @@ } }, { - "id": 766, + "id": 786, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -10579,7 +11120,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 573, + "line": 591, "character": 4 } ], @@ -10589,7 +11130,7 @@ } }, { - "id": 771, + "id": 791, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -10602,7 +11143,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 577, + "line": 595, "character": 4 } ], @@ -10616,13 +11157,13 @@ { "title": "Properties", "kind": 1024, - "children": [767, 765, 766, 771] + "children": [787, 785, 786, 791] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 12 } ] @@ -10630,7 +11171,7 @@ } }, { - "id": 762, + "id": 782, "name": "provider", "kind": 1024, "kindString": "Property", @@ -10641,16 +11182,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 568, + "line": 586, "character": 2 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider", "dereferenced": { - "id": 478, + "id": 493, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -10728,6 +11269,10 @@ "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -10762,13 +11307,13 @@ { "title": "Properties", "kind": 1024, - "children": [763, 762] + "children": [783, 782] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 41 } ] @@ -10783,7 +11328,7 @@ "typeArguments": [ { "type": "reference", - "id": 585, + "id": 602, "name": "OAuthResponse" } ], @@ -10795,7 +11340,7 @@ ] }, { - "id": 321, + "id": 334, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -10803,13 +11348,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1608, + "line": 1633, "character": 2 } ], "signatures": [ { - "id": 322, + "id": 335, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -10819,7 +11364,7 @@ }, "parameters": [ { - "id": 323, + "id": 336, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -10830,33 +11375,33 @@ "type": { "type": "reflection", "declaration": { - "id": 324, + "id": 337, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 325, + "id": 338, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 326, + "id": 339, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 480, + "id": 495, "name": "AuthChangeEvent" } }, { - "id": 327, + "id": 340, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -10870,7 +11415,7 @@ }, { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } ] @@ -10907,14 +11452,14 @@ "type": { "type": "reflection", "declaration": { - "id": 328, + "id": 341, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 329, + "id": 342, "name": "data", "kind": 1024, "kindString": "Property", @@ -10922,21 +11467,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1611, + "line": 1636, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 330, + "id": 343, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 331, + "id": 344, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -10944,23 +11489,23 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1611, + "line": 1636, "character": 12 } ], "type": { "type": "reference", - "id": 696, + "id": 718, "name": "Subscription", "dereferenced": { - "id": 696, + "id": 718, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 697, + "id": 719, "name": "id", "kind": 1024, "kindString": "Property", @@ -10971,7 +11516,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 462, "character": 2 } ], @@ -10981,7 +11526,7 @@ } }, { - "id": 698, + "id": 720, "name": "callback", "kind": 2048, "kindString": "Method", @@ -10989,13 +11534,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 444, + "line": 466, "character": 2 } ], "signatures": [ { - "id": 699, + "id": 721, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -11005,17 +11550,17 @@ }, "parameters": [ { - "id": 700, + "id": 722, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 480, + "id": 495, "name": "AuthChangeEvent", "dereferenced": { - "id": 480, + "id": 495, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -11023,7 +11568,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 30, + "line": 31, "character": 12 } ], @@ -11055,7 +11600,7 @@ "value": "USER_UPDATED" }, { - "id": 479, + "id": 494, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -11063,7 +11608,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 28, + "line": 29, "character": 12 } ], @@ -11078,7 +11623,7 @@ } }, { - "id": 701, + "id": 723, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -11092,7 +11637,7 @@ }, { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } ] @@ -11107,7 +11652,7 @@ ] }, { - "id": 702, + "id": 724, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -11115,13 +11660,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 448, + "line": 470, "character": 2 } ], "signatures": [ { - "id": 703, + "id": 725, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -11141,18 +11686,18 @@ { "title": "Properties", "kind": 1024, - "children": [697] + "children": [719] }, { "title": "Methods", "kind": 2048, - "children": [698, 702] + "children": [720, 724] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 436, + "line": 458, "character": 17 } ] @@ -11164,7 +11709,7 @@ { "title": "Properties", "kind": 1024, - "children": [331] + "children": [344] } ] } @@ -11175,7 +11720,7 @@ { "title": "Properties", "kind": 1024, - "children": [329] + "children": [342] } ] } @@ -11184,7 +11729,7 @@ ] }, { - "id": 175, + "id": 176, "name": "reauthenticate", "kind": 2048, "kindString": "Method", @@ -11192,13 +11737,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 838, + "line": 851, "character": 8 } ], "signatures": [ { - "id": 176, + "id": 177, "name": "reauthenticate", "kind": 4096, "kindString": "Call signature", @@ -11211,7 +11756,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -11223,7 +11768,7 @@ ] }, { - "id": 282, + "id": 283, "name": "refreshSession", "kind": 2048, "kindString": "Method", @@ -11231,13 +11776,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1374, + "line": 1382, "character": 8 } ], "signatures": [ { - "id": 283, + "id": 284, "name": "refreshSession", "kind": 4096, "kindString": "Call signature", @@ -11247,7 +11792,7 @@ }, "parameters": [ { - "id": 284, + "id": 285, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -11260,14 +11805,14 @@ "type": { "type": "reflection", "declaration": { - "id": 285, + "id": 286, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 286, + "id": 287, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -11275,7 +11820,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1374, + "line": 1382, "character": 42 } ], @@ -11289,7 +11834,7 @@ { "title": "Properties", "kind": 1024, - "children": [286] + "children": [287] } ] } @@ -11301,7 +11846,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -11313,7 +11858,7 @@ ] }, { - "id": 179, + "id": 180, "name": "resend", "kind": 2048, "kindString": "Method", @@ -11321,13 +11866,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 873, + "line": 886, "character": 8 } ], "signatures": [ { - "id": 180, + "id": 181, "name": "resend", "kind": 4096, "kindString": "Call signature", @@ -11337,17 +11882,17 @@ }, "parameters": [ { - "id": 181, + "id": 182, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 803, + "id": 824, "name": "ResendParams", "dereferenced": { - "id": 803, + "id": 824, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -11355,7 +11900,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 646, + "line": 664, "character": 12 } ], @@ -11365,14 +11910,14 @@ { "type": "reflection", "declaration": { - "id": 804, + "id": 825, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 806, + "id": 827, "name": "email", "kind": 1024, "kindString": "Property", @@ -11380,7 +11925,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 649, + "line": 667, "character": 6 } ], @@ -11390,7 +11935,7 @@ } }, { - "id": 807, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -11400,21 +11945,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 650, + "line": 668, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 808, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -11427,7 +11972,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 654, + "line": 672, "character": 8 } ], @@ -11437,7 +11982,7 @@ } }, { - "id": 809, + "id": 830, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -11450,7 +11995,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 670, "character": 8 } ], @@ -11464,13 +12009,13 @@ { "title": "Properties", "kind": 1024, - "children": [810, 809] + "children": [831, 830] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 650, + "line": 668, "character": 16 } ] @@ -11478,7 +12023,7 @@ } }, { - "id": 805, + "id": 826, "name": "type", "kind": 1024, "kindString": "Property", @@ -11486,7 +12031,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 648, + "line": 666, "character": 6 } ], @@ -11495,7 +12040,7 @@ "typeArguments": [ { "type": "reference", - "id": 802, + "id": 823, "name": "EmailOtpType" }, { @@ -11522,13 +12067,13 @@ { "title": "Properties", "kind": 1024, - "children": [806, 807, 805] + "children": [827, 828, 826] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 647, + "line": 665, "character": 4 } ] @@ -11537,14 +12082,14 @@ { "type": "reflection", "declaration": { - "id": 811, + "id": 832, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 814, + "id": 835, "name": "options", "kind": 1024, "kindString": "Property", @@ -11554,21 +12099,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 660, + "line": 678, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 815, + "id": 836, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 816, + "id": 837, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -11581,7 +12126,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 662, + "line": 680, "character": 8 } ], @@ -11595,13 +12140,13 @@ { "title": "Properties", "kind": 1024, - "children": [816] + "children": [837] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 660, + "line": 678, "character": 16 } ] @@ -11609,7 +12154,7 @@ } }, { - "id": 813, + "id": 834, "name": "phone", "kind": 1024, "kindString": "Property", @@ -11617,7 +12162,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 659, + "line": 677, "character": 6 } ], @@ -11627,7 +12172,7 @@ } }, { - "id": 812, + "id": 833, "name": "type", "kind": 1024, "kindString": "Property", @@ -11635,7 +12180,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 658, + "line": 676, "character": 6 } ], @@ -11644,7 +12189,7 @@ "typeArguments": [ { "type": "reference", - "id": 801, + "id": 822, "name": "MobileOtpType" }, { @@ -11671,13 +12216,13 @@ { "title": "Properties", "kind": 1024, - "children": [814, 813, 812] + "children": [835, 834, 833] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 675, "character": 4 } ] @@ -11694,7 +12239,7 @@ "typeArguments": [ { "type": "reference", - "id": 542, + "id": 559, "name": "AuthOtpResponse" } ], @@ -11706,7 +12251,7 @@ ] }, { - "id": 335, + "id": 348, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", @@ -11714,13 +12259,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1664, + "line": 1689, "character": 8 } ], "signatures": [ { - "id": 336, + "id": 349, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", @@ -11730,7 +12275,7 @@ }, "parameters": [ { - "id": 337, + "id": 350, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -11744,7 +12289,7 @@ } }, { - "id": 338, + "id": 351, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -11752,14 +12297,14 @@ "type": { "type": "reflection", "declaration": { - "id": 339, + "id": 352, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 341, + "id": 354, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -11772,7 +12317,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1668, + "line": 1693, "character": 6 } ], @@ -11782,7 +12327,7 @@ } }, { - "id": 340, + "id": 353, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -11795,7 +12340,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1667, + "line": 1692, "character": 6 } ], @@ -11809,7 +12354,7 @@ { "title": "Properties", "kind": 1024, - "children": [341, 340] + "children": [354, 353] } ] } @@ -11826,14 +12371,14 @@ { "type": "reflection", "declaration": { - "id": 342, + "id": 355, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 343, + "id": 356, "name": "data", "kind": 1024, "kindString": "Property", @@ -11841,14 +12386,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1672, + "line": 1697, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 344, + "id": 357, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -11857,7 +12402,7 @@ } }, { - "id": 345, + "id": 358, "name": "error", "kind": 1024, "kindString": "Property", @@ -11865,7 +12410,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1673, + "line": 1698, "character": 8 } ], @@ -11879,7 +12424,7 @@ { "title": "Properties", "kind": 1024, - "children": [343, 345] + "children": [356, 358] } ] } @@ -11887,14 +12432,14 @@ { "type": "reflection", "declaration": { - "id": 346, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 347, + "id": 360, "name": "data", "kind": 1024, "kindString": "Property", @@ -11902,7 +12447,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1675, + "line": 1700, "character": 8 } ], @@ -11912,7 +12457,7 @@ } }, { - "id": 348, + "id": 361, "name": "error", "kind": 1024, "kindString": "Property", @@ -11920,13 +12465,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1675, + "line": 1700, "character": 20 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -11935,7 +12480,7 @@ { "title": "Properties", "kind": 1024, - "children": [347, 348] + "children": [360, 361] } ] } @@ -11951,7 +12496,7 @@ ] }, { - "id": 270, + "id": 271, "name": "setSession", "kind": 2048, "kindString": "Method", @@ -11959,13 +12504,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1299, + "line": 1307, "character": 8 } ], "signatures": [ { - "id": 271, + "id": 272, "name": "setSession", "kind": 4096, "kindString": "Call signature", @@ -11975,7 +12520,7 @@ }, "parameters": [ { - "id": 272, + "id": 273, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -11986,14 +12531,14 @@ "type": { "type": "reflection", "declaration": { - "id": 273, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 274, + "id": 275, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -12001,7 +12546,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1300, + "line": 1308, "character": 4 } ], @@ -12011,7 +12556,7 @@ } }, { - "id": 275, + "id": 276, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -12019,7 +12564,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1301, + "line": 1309, "character": 4 } ], @@ -12033,7 +12578,7 @@ { "title": "Properties", "kind": 1024, - "children": [274, 275] + "children": [275, 276] } ] } @@ -12045,7 +12590,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -12057,7 +12602,7 @@ ] }, { - "id": 131, + "id": 132, "name": "signInAnonymously", "kind": 2048, "kindString": "Method", @@ -12065,13 +12610,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 368, + "line": 389, "character": 8 } ], "signatures": [ { - "id": 132, + "id": 133, "name": "signInAnonymously", "kind": 4096, "kindString": "Call signature", @@ -12082,7 +12627,7 @@ }, "parameters": [ { - "id": 133, + "id": 134, "name": "credentials", "kind": 32768, "kindString": "Parameter", @@ -12091,10 +12636,10 @@ }, "type": { "type": "reference", - "id": 706, + "id": 726, "name": "SignInAnonymouslyCredentials", "dereferenced": { - "id": 706, + "id": 726, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -12102,21 +12647,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 473, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 707, + "id": 727, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 708, + "id": 728, "name": "options", "kind": 1024, "kindString": "Property", @@ -12126,21 +12671,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 456, + "line": 474, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 709, + "id": 729, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 711, + "id": 731, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -12153,7 +12698,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 482, "character": 4 } ], @@ -12163,7 +12708,7 @@ } }, { - "id": 710, + "id": 730, "name": "data", "kind": 1024, "kindString": "Property", @@ -12177,7 +12722,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 462, + "line": 480, "character": 4 } ], @@ -12191,13 +12736,13 @@ { "title": "Properties", "kind": 1024, - "children": [711, 710] + "children": [731, 730] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 456, + "line": 474, "character": 12 } ] @@ -12209,13 +12754,13 @@ { "title": "Properties", "kind": 1024, - "children": [708] + "children": [728] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 473, "character": 43 } ] @@ -12230,7 +12775,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -12242,7 +12787,7 @@ ] }, { - "id": 163, + "id": 164, "name": "signInWithIdToken", "kind": 2048, "kindString": "Method", @@ -12250,13 +12795,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 621, + "line": 644, "character": 8 } ], "signatures": [ { - "id": 164, + "id": 165, "name": "signInWithIdToken", "kind": 4096, "kindString": "Call signature", @@ -12266,17 +12811,17 @@ }, "parameters": [ { - "id": 165, + "id": 166, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 772, + "id": 792, "name": "SignInWithIdTokenCredentials", "dereferenced": { - "id": 772, + "id": 792, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -12284,21 +12829,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 581, + "line": 599, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 773, + "id": 793, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 776, + "id": 797, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -12311,7 +12856,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 587, + "line": 605, "character": 2 } ], @@ -12321,7 +12866,7 @@ } }, { - "id": 777, + "id": 798, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -12334,7 +12879,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 589, + "line": 607, "character": 2 } ], @@ -12344,7 +12889,7 @@ } }, { - "id": 778, + "id": 799, "name": "options", "kind": 1024, "kindString": "Property", @@ -12354,21 +12899,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 608, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 779, + "id": 800, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 780, + "id": 801, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -12381,7 +12926,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 592, + "line": 610, "character": 4 } ], @@ -12395,13 +12940,13 @@ { "title": "Properties", "kind": 1024, - "children": [780] + "children": [801] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 608, "character": 12 } ] @@ -12409,18 +12954,18 @@ } }, { - "id": 774, + "id": 794, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "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`, `keycloak` (deprecated)." + "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`, `keycloak` (deprecated)." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 583, + "line": 601, "character": 2 } ], @@ -12444,14 +12989,40 @@ "value": "facebook" }, { - "type": "intrinsic", - "name": "string" + "type": "literal", + "value": "kakao" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 795, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 601, + "character": 76 + } + ] + } + } + ] } ] } }, { - "id": 775, + "id": 796, "name": "token", "kind": 1024, "kindString": "Property", @@ -12462,7 +13033,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 585, + "line": 603, "character": 2 } ], @@ -12476,13 +13047,13 @@ { "title": "Properties", "kind": 1024, - "children": [776, 777, 778, 774, 775] + "children": [797, 798, 799, 794, 796] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 581, + "line": 599, "character": 43 } ] @@ -12497,7 +13068,7 @@ "typeArguments": [ { "type": "reference", - "id": 557, + "id": 574, "name": "AuthTokenResponse" } ], @@ -12509,7 +13080,7 @@ ] }, { - "id": 140, + "id": 141, "name": "signInWithOAuth", "kind": 2048, "kindString": "Method", @@ -12517,13 +13088,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 557, + "line": 572, "character": 8 } ], "signatures": [ { - "id": 141, + "id": 142, "name": "signInWithOAuth", "kind": 4096, "kindString": "Call signature", @@ -12533,17 +13104,17 @@ }, "parameters": [ { - "id": 142, + "id": 143, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -12551,21 +13122,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 761, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 763, + "id": 783, "name": "options", "kind": 1024, "kindString": "Property", @@ -12575,21 +13146,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 764, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 767, + "id": 787, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -12602,14 +13173,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 768, + "id": 788, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -12617,19 +13188,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 18 } ], "indexSignature": { - "id": 769, + "id": 789, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 770, + "id": 790, "name": "key", "kind": 32768, "flags": {}, @@ -12648,7 +13219,7 @@ } }, { - "id": 765, + "id": 785, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -12661,7 +13232,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 571, + "line": 589, "character": 4 } ], @@ -12671,7 +13242,7 @@ } }, { - "id": 766, + "id": 786, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -12684,7 +13255,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 573, + "line": 591, "character": 4 } ], @@ -12694,7 +13265,7 @@ } }, { - "id": 771, + "id": 791, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -12707,7 +13278,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 577, + "line": 595, "character": 4 } ], @@ -12721,13 +13292,13 @@ { "title": "Properties", "kind": 1024, - "children": [767, 765, 766, 771] + "children": [787, 785, 786, 791] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 12 } ] @@ -12735,7 +13306,7 @@ } }, { - "id": 762, + "id": 782, "name": "provider", "kind": 1024, "kindString": "Property", @@ -12746,16 +13317,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 568, + "line": 586, "character": 2 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider", "dereferenced": { - "id": 478, + "id": 493, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -12833,6 +13404,10 @@ "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -12867,13 +13442,13 @@ { "title": "Properties", "kind": 1024, - "children": [763, 762] + "children": [783, 782] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 41 } ] @@ -12888,7 +13463,7 @@ "typeArguments": [ { "type": "reference", - "id": 585, + "id": 602, "name": "OAuthResponse" } ], @@ -12900,7 +13475,7 @@ ] }, { - "id": 166, + "id": 167, "name": "signInWithOtp", "kind": 2048, "kindString": "Method", @@ -12908,13 +13483,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 678, + "line": 699, "character": 8 } ], "signatures": [ { - "id": 167, + "id": 168, "name": "signInWithOtp", "kind": 4096, "kindString": "Call signature", @@ -12925,17 +13500,17 @@ }, "parameters": [ { - "id": 168, + "id": 169, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 742, + "id": 762, "name": "SignInWithPasswordlessCredentials", "dereferenced": { - "id": 742, + "id": 762, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -12943,7 +13518,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 527, + "line": 545, "character": 12 } ], @@ -12953,14 +13528,14 @@ { "type": "reflection", "declaration": { - "id": 743, + "id": 763, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 744, + "id": 764, "name": "email", "kind": 1024, "kindString": "Property", @@ -12971,7 +13546,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 530, + "line": 548, "character": 6 } ], @@ -12981,168 +13556,7 @@ } }, { - "id": 745, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 531, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 746, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 750, - "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": 543, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 749, - "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.raw_user_meta_data` 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": 541, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 747, - "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": 533, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 748, - "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": 535, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [750, 749, 747, 748] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 531, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [744, 745] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 528, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 751, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 753, + "id": 765, "name": "options", "kind": 1024, "kindString": "Property", @@ -13159,14 +13573,14 @@ "type": { "type": "reflection", "declaration": { - "id": 754, + "id": 766, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 757, + "id": 770, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -13179,7 +13593,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 559, + "line": 561, "character": 8 } ], @@ -13189,7 +13603,168 @@ } }, { - "id": 758, + "id": 769, + "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.raw_user_meta_data` 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": 559, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 767, + "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": 551, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 768, + "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": 553, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [770, 769, 767, 768] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 549, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [764, 765] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 546, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 771, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 773, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 567, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 774, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 777, + "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": 577, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 778, "name": "channel", "kind": 1024, "kindString": "Property", @@ -13202,7 +13777,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 579, "character": 8 } ], @@ -13221,7 +13796,7 @@ } }, { - "id": 756, + "id": 776, "name": "data", "kind": 1024, "kindString": "Property", @@ -13235,7 +13810,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 557, + "line": 575, "character": 8 } ], @@ -13245,7 +13820,7 @@ } }, { - "id": 755, + "id": 775, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -13258,7 +13833,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 551, + "line": 569, "character": 8 } ], @@ -13272,13 +13847,13 @@ { "title": "Properties", "kind": 1024, - "children": [757, 758, 756, 755] + "children": [777, 778, 776, 775] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 567, "character": 16 } ] @@ -13286,7 +13861,7 @@ } }, { - "id": 752, + "id": 772, "name": "phone", "kind": 1024, "kindString": "Property", @@ -13297,7 +13872,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 548, + "line": 566, "character": 6 } ], @@ -13311,13 +13886,13 @@ { "title": "Properties", "kind": 1024, - "children": [753, 752] + "children": [773, 772] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 564, "character": 4 } ] @@ -13334,7 +13909,7 @@ "typeArguments": [ { "type": "reference", - "id": 542, + "id": 559, "name": "AuthOtpResponse" } ], @@ -13346,7 +13921,7 @@ ] }, { - "id": 137, + "id": 138, "name": "signInWithPassword", "kind": 2048, "kindString": "Method", @@ -13354,13 +13929,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 492, + "line": 509, "character": 8 } ], "signatures": [ { - "id": 138, + "id": 139, "name": "signInWithPassword", "kind": 4096, "kindString": "Call signature", @@ -13371,17 +13946,17 @@ }, "parameters": [ { - "id": 139, + "id": 140, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 729, + "id": 749, "name": "SignInWithPasswordCredentials", "dereferenced": { - "id": 729, + "id": 749, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -13389,7 +13964,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 523, "character": 12 } ], @@ -13399,14 +13974,14 @@ { "type": "reflection", "declaration": { - "id": 730, + "id": 750, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 731, + "id": 751, "name": "email", "kind": 1024, "kindString": "Property", @@ -13417,7 +13992,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 508, + "line": 526, "character": 6 } ], @@ -13427,7 +14002,7 @@ } }, { - "id": 733, + "id": 753, "name": "options", "kind": 1024, "kindString": "Property", @@ -13437,21 +14012,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 511, + "line": 529, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -13464,7 +14039,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 513, + "line": 531, "character": 8 } ], @@ -13478,13 +14053,13 @@ { "title": "Properties", "kind": 1024, - "children": [735] + "children": [755] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 511, + "line": 529, "character": 16 } ] @@ -13492,7 +14067,7 @@ } }, { - "id": 732, + "id": 752, "name": "password", "kind": 1024, "kindString": "Property", @@ -13503,7 +14078,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 510, + "line": 528, "character": 6 } ], @@ -13517,13 +14092,13 @@ { "title": "Properties", "kind": 1024, - "children": [731, 733, 732] + "children": [751, 753, 752] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 524, "character": 4 } ] @@ -13532,14 +14107,14 @@ { "type": "reflection", "declaration": { - "id": 736, + "id": 756, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 739, + "id": 759, "name": "options", "kind": 1024, "kindString": "Property", @@ -13549,21 +14124,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 521, + "line": 539, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 740, + "id": 760, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 741, + "id": 761, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -13576,7 +14151,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 523, + "line": 541, "character": 8 } ], @@ -13590,13 +14165,13 @@ { "title": "Properties", "kind": 1024, - "children": [741] + "children": [761] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 521, + "line": 539, "character": 16 } ] @@ -13604,7 +14179,7 @@ } }, { - "id": 738, + "id": 758, "name": "password", "kind": 1024, "kindString": "Property", @@ -13615,7 +14190,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 520, + "line": 538, "character": 6 } ], @@ -13625,7 +14200,7 @@ } }, { - "id": 737, + "id": 757, "name": "phone", "kind": 1024, "kindString": "Property", @@ -13636,7 +14211,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 518, + "line": 536, "character": 6 } ], @@ -13650,13 +14225,13 @@ { "title": "Properties", "kind": 1024, - "children": [739, 738, 737] + "children": [759, 758, 757] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 516, + "line": 534, "character": 4 } ] @@ -13673,7 +14248,7 @@ "typeArguments": [ { "type": "reference", - "id": 570, + "id": 587, "name": "AuthTokenResponsePassword" } ], @@ -13685,7 +14260,7 @@ ] }, { - "id": 172, + "id": 173, "name": "signInWithSSO", "kind": 2048, "kindString": "Method", @@ -13693,13 +14268,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 799, + "line": 813, "character": 8 } ], "signatures": [ { - "id": 173, + "id": 174, "name": "signInWithSSO", "kind": 4096, "kindString": "Call signature", @@ -13710,17 +14285,17 @@ }, "parameters": [ { - "id": 174, + "id": 175, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 817, + "id": 838, "name": "SignInWithSSO", "dereferenced": { - "id": 817, + "id": 838, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -13728,7 +14303,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 666, + "line": 684, "character": 12 } ], @@ -13738,14 +14313,14 @@ { "type": "reflection", "declaration": { - "id": 818, + "id": 839, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 820, + "id": 841, "name": "options", "kind": 1024, "kindString": "Property", @@ -13755,21 +14330,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 671, + "line": 689, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 821, + "id": 842, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 823, + "id": 844, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -13782,7 +14357,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 675, + "line": 693, "character": 8 } ], @@ -13792,7 +14367,7 @@ } }, { - "id": 822, + "id": 843, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -13805,7 +14380,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 673, + "line": 691, "character": 8 } ], @@ -13819,13 +14394,13 @@ { "title": "Properties", "kind": 1024, - "children": [823, 822] + "children": [844, 843] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 671, + "line": 689, "character": 16 } ] @@ -13833,7 +14408,7 @@ } }, { - "id": 819, + "id": 840, "name": "providerId", "kind": 1024, "kindString": "Property", @@ -13844,7 +14419,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 669, + "line": 687, "character": 6 } ], @@ -13858,13 +14433,13 @@ { "title": "Properties", "kind": 1024, - "children": [820, 819] + "children": [841, 840] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 667, + "line": 685, "character": 4 } ] @@ -13873,14 +14448,14 @@ { "type": "reflection", "declaration": { - "id": 824, + "id": 845, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 825, + "id": 846, "name": "domain", "kind": 1024, "kindString": "Property", @@ -13891,7 +14466,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 680, + "line": 698, "character": 6 } ], @@ -13901,7 +14476,7 @@ } }, { - "id": 826, + "id": 847, "name": "options", "kind": 1024, "kindString": "Property", @@ -13911,21 +14486,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 682, + "line": 700, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 827, + "id": 848, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 829, + "id": 850, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -13938,7 +14513,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 686, + "line": 704, "character": 8 } ], @@ -13948,7 +14523,7 @@ } }, { - "id": 828, + "id": 849, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -13961,7 +14536,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 684, + "line": 702, "character": 8 } ], @@ -13975,13 +14550,13 @@ { "title": "Properties", "kind": 1024, - "children": [829, 828] + "children": [850, 849] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 682, + "line": 700, "character": 16 } ] @@ -13993,13 +14568,13 @@ { "title": "Properties", "kind": 1024, - "children": [825, 826] + "children": [846, 847] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 678, + "line": 696, "character": 4 } ] @@ -14016,7 +14591,7 @@ "typeArguments": [ { "type": "reference", - "id": 598, + "id": 615, "name": "SSOResponse" } ], @@ -14028,7 +14603,7 @@ ] }, { - "id": 311, + "id": 324, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -14036,13 +14611,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1568, + "line": 1589, "character": 8 } ], "signatures": [ { - "id": 312, + "id": 325, "name": "signOut", "kind": 4096, "kindString": "Call signature", @@ -14053,17 +14628,17 @@ }, "parameters": [ { - "id": 313, + "id": 326, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1043, + "id": 1052, "name": "SignOut", "dereferenced": { - "id": 1043, + "id": 1052, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -14071,21 +14646,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1128, + "line": 1115, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1044, + "id": 1053, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1045, + "id": 1054, "name": "scope", "kind": 1024, "kindString": "Property", @@ -14098,7 +14673,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1139, + "line": 1126, "character": 2 } ], @@ -14125,13 +14700,13 @@ { "title": "Properties", "kind": 1024, - "children": [1045] + "children": [1054] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1128, + "line": 1115, "character": 22 } ] @@ -14148,14 +14723,14 @@ { "type": "reflection", "declaration": { - "id": 314, + "id": 327, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 315, + "id": 328, "name": "error", "kind": 1024, "kindString": "Property", @@ -14163,7 +14738,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1568, + "line": 1589, "character": 67 } ], @@ -14176,7 +14751,7 @@ }, { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } ] @@ -14187,7 +14762,7 @@ { "title": "Properties", "kind": 1024, - "children": [315] + "children": [328] } ] } @@ -14201,7 +14776,7 @@ ] }, { - "id": 134, + "id": 135, "name": "signUp", "kind": 2048, "kindString": "Method", @@ -14209,13 +14784,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 413, + "line": 432, "character": 8 } ], "signatures": [ { - "id": 135, + "id": 136, "name": "signUp", "kind": 4096, "kindString": "Call signature", @@ -14227,17 +14802,17 @@ }, "parameters": [ { - "id": 136, + "id": 137, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 712, + "id": 732, "name": "SignUpWithPasswordCredentials", "dereferenced": { - "id": 712, + "id": 732, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -14245,7 +14820,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 468, + "line": 486, "character": 12 } ], @@ -14255,14 +14830,14 @@ { "type": "reflection", "declaration": { - "id": 713, + "id": 733, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 714, + "id": 734, "name": "email", "kind": 1024, "kindString": "Property", @@ -14273,7 +14848,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 471, + "line": 489, "character": 6 } ], @@ -14283,166 +14858,7 @@ } }, { - "id": 716, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 474, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 717, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 720, - "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": 484, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 719, - "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.raw_user_meta_data` 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": 482, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 718, - "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": 476, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [720, 719, 718] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 474, - "character": 16 - } - ] - } - } - }, - { - "id": 715, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 473, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [714, 716, 715] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 469, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 721, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 724, + "id": 736, "name": "options", "kind": 1024, "kindString": "Property", @@ -14459,14 +14875,14 @@ "type": { "type": "reflection", "declaration": { - "id": 725, + "id": 737, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 727, + "id": 740, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14474,30 +14890,7 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 500, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 728, - "name": "channel", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { @@ -14507,21 +14900,12 @@ } ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] + "type": "intrinsic", + "name": "string" } }, { - "id": 726, + "id": 739, "name": "data", "kind": 1024, "kindString": "Property", @@ -14535,7 +14919,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 498, + "line": 500, "character": 8 } ], @@ -14543,13 +14927,36 @@ "type": "intrinsic", "name": "object" } + }, + { + "id": 738, + "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": 494, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [727, 728, 726] + "children": [740, 739, 738] } ], "sources": [ @@ -14563,7 +14970,7 @@ } }, { - "id": 723, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -14582,9 +14989,177 @@ "type": "intrinsic", "name": "string" } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [734, 736, 735] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 487, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 741, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 744, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 510, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 745, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 747, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 518, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 748, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 746, + "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.raw_user_meta_data` 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": 516, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [747, 748, 746] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 510, + "character": 16 + } + ] + } + } }, { - "id": 722, + "id": 743, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 509, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 742, "name": "phone", "kind": 1024, "kindString": "Property", @@ -14595,7 +15170,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 489, + "line": 507, "character": 6 } ], @@ -14609,13 +15184,13 @@ { "title": "Properties", "kind": 1024, - "children": [724, 723, 722] + "children": [744, 743, 742] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 487, + "line": 505, "character": 4 } ] @@ -14632,7 +15207,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -14644,7 +15219,7 @@ ] }, { - "id": 417, + "id": 430, "name": "startAutoRefresh", "kind": 2048, "kindString": "Method", @@ -14652,13 +15227,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 2142, + "line": 2174, "character": 8 } ], "signatures": [ { - "id": 418, + "id": 431, "name": "startAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -14683,7 +15258,7 @@ ] }, { - "id": 419, + "id": 432, "name": "stopAutoRefresh", "kind": 2048, "kindString": "Method", @@ -14691,13 +15266,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 2155, + "line": 2187, "character": 8 } ], "signatures": [ { - "id": 420, + "id": 433, "name": "stopAutoRefresh", "kind": 4096, "kindString": "Call signature", @@ -14722,7 +15297,7 @@ ] }, { - "id": 362, + "id": 375, "name": "unlinkIdentity", "kind": 2048, "kindString": "Method", @@ -14730,13 +15305,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1770, + "line": 1795, "character": 8 } ], "signatures": [ { - "id": 363, + "id": 376, "name": "unlinkIdentity", "kind": 4096, "kindString": "Call signature", @@ -14746,24 +15321,24 @@ }, "parameters": [ { - "id": 364, + "id": 377, "name": "identity", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 630, + "id": 648, "name": "UserIdentity", "dereferenced": { - "id": 630, + "id": 648, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 639, + "id": 657, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -14773,7 +15348,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 279, + "line": 285, "character": 2 } ], @@ -14783,7 +15358,7 @@ } }, { - "id": 631, + "id": 649, "name": "id", "kind": 1024, "kindString": "Property", @@ -14791,7 +15366,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 272, + "line": 278, "character": 2 } ], @@ -14801,7 +15376,7 @@ } }, { - "id": 633, + "id": 651, "name": "identity_data", "kind": 1024, "kindString": "Property", @@ -14811,27 +15386,27 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 274, + "line": 280, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 634, + "id": 652, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 635, + "id": 653, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 636, + "id": 654, "name": "key", "kind": 32768, "flags": {}, @@ -14850,7 +15425,7 @@ } }, { - "id": 637, + "id": 655, "name": "identity_id", "kind": 1024, "kindString": "Property", @@ -14858,7 +15433,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 277, + "line": 283, "character": 2 } ], @@ -14868,7 +15443,7 @@ } }, { - "id": 640, + "id": 658, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -14878,7 +15453,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 280, + "line": 286, "character": 2 } ], @@ -14888,7 +15463,7 @@ } }, { - "id": 638, + "id": 656, "name": "provider", "kind": 1024, "kindString": "Property", @@ -14896,7 +15471,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 284, "character": 2 } ], @@ -14906,7 +15481,7 @@ } }, { - "id": 641, + "id": 659, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -14916,7 +15491,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 281, + "line": 287, "character": 2 } ], @@ -14926,7 +15501,7 @@ } }, { - "id": 632, + "id": 650, "name": "user_id", "kind": 1024, "kindString": "Property", @@ -14934,7 +15509,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 273, + "line": 279, "character": 2 } ], @@ -14948,13 +15523,13 @@ { "title": "Properties", "kind": 1024, - "children": [639, 631, 633, 637, 640, 638, 641, 632] + "children": [657, 649, 651, 655, 658, 656, 659, 650] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 271, + "line": 277, "character": 17 } ] @@ -14971,14 +15546,14 @@ { "type": "reflection", "declaration": { - "id": 365, + "id": 378, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 366, + "id": 379, "name": "data", "kind": 1024, "kindString": "Property", @@ -14986,14 +15561,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1772, + "line": 1797, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 367, + "id": 380, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -15002,7 +15577,7 @@ } }, { - "id": 368, + "id": 381, "name": "error", "kind": 1024, "kindString": "Property", @@ -15010,7 +15585,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1773, + "line": 1798, "character": 8 } ], @@ -15024,7 +15599,7 @@ { "title": "Properties", "kind": 1024, - "children": [366, 368] + "children": [379, 381] } ] } @@ -15032,14 +15607,14 @@ { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 370, + "id": 383, "name": "data", "kind": 1024, "kindString": "Property", @@ -15047,7 +15622,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1775, + "line": 1800, "character": 8 } ], @@ -15057,7 +15632,7 @@ } }, { - "id": 371, + "id": 384, "name": "error", "kind": 1024, "kindString": "Property", @@ -15065,13 +15640,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1775, + "line": 1800, "character": 20 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -15080,7 +15655,7 @@ { "title": "Properties", "kind": 1024, - "children": [370, 371] + "children": [383, 384] } ] } @@ -15096,7 +15671,7 @@ ] }, { - "id": 251, + "id": 252, "name": "updateUser", "kind": 2048, "kindString": "Method", @@ -15104,13 +15679,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1219, + "line": 1227, "character": 8 } ], "signatures": [ { - "id": 252, + "id": 253, "name": "updateUser", "kind": 4096, "kindString": "Call signature", @@ -15120,24 +15695,24 @@ }, "parameters": [ { - "id": 253, + "id": 254, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes", "dereferenced": { - "id": 679, + "id": 699, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 684, + "id": 704, "name": "data", "kind": 1024, "kindString": "Property", @@ -15151,7 +15726,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 374, + "line": 380, "character": 2 } ], @@ -15161,7 +15736,7 @@ } }, { - "id": 680, + "id": 700, "name": "email", "kind": 1024, "kindString": "Property", @@ -15174,7 +15749,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -15184,7 +15759,7 @@ } }, { - "id": 683, + "id": 703, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -15198,7 +15773,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -15208,7 +15783,7 @@ } }, { - "id": 682, + "id": 702, "name": "password", "kind": 1024, "kindString": "Property", @@ -15221,7 +15796,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -15231,7 +15806,7 @@ } }, { - "id": 681, + "id": 701, "name": "phone", "kind": 1024, "kindString": "Property", @@ -15244,7 +15819,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -15258,13 +15833,13 @@ { "title": "Properties", "kind": 1024, - "children": [684, 680, 683, 682, 681] + "children": [704, 700, 703, 702, 701] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 345, + "line": 351, "character": 17 } ] @@ -15272,7 +15847,7 @@ } }, { - "id": 254, + "id": 255, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -15280,14 +15855,14 @@ "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 256, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 256, + "id": 257, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -15297,7 +15872,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 1222, + "line": 1230, "character": 6 } ], @@ -15311,7 +15886,7 @@ { "title": "Properties", "kind": 1024, - "children": [256] + "children": [257] } ] } @@ -15324,7 +15899,7 @@ "typeArguments": [ { "type": "reference", - "id": 607, + "id": 624, "name": "UserResponse" } ], @@ -15336,7 +15911,7 @@ ] }, { - "id": 169, + "id": 170, "name": "verifyOtp", "kind": 2048, "kindString": "Method", @@ -15344,13 +15919,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 733, + "line": 752, "character": 8 } ], "signatures": [ { - "id": 170, + "id": 171, "name": "verifyOtp", "kind": 4096, "kindString": "Call signature", @@ -15360,17 +15935,17 @@ }, "parameters": [ { - "id": 171, + "id": 172, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 781, + "id": 802, "name": "VerifyOtpParams", "dereferenced": { - "id": 781, + "id": 802, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -15378,7 +15953,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 596, + "line": 614, "character": 12 } ], @@ -15386,14 +15961,14 @@ "type": "union", "types": [ { - "id": 782, + "id": 803, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 786, + "id": 807, "name": "options", "kind": 1024, "kindString": "Property", @@ -15403,243 +15978,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 604, + "line": 622, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 787, + "id": 808, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 789, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ - { - "tag": "deprecated", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 613, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 788, - "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": 606, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [789, 788] - } - ] - } - } - }, - { - "id": 783, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 599, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 784, - "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": 601, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 785, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 603, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 801, - "name": "MobileOtpType", - "dereferenced": { - "id": 801, - "name": "MobileOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 643, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [786, 783, 784, 785] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 597, - "character": 17 - } - ] - }, - { - "id": 790, - "name": "VerifyEmailOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 791, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 618, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 794, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 623, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 795, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 797, + "id": 810, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -15668,7 +16021,7 @@ } }, { - "id": 796, + "id": 809, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -15681,7 +16034,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 625, + "line": 624, "character": 4 } ], @@ -15695,25 +16048,25 @@ { "title": "Properties", "kind": 1024, - "children": [797, 796] + "children": [810, 809] } ] } } }, { - "id": 792, - "name": "token", + "id": 804, + "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's email address." + "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 620, + "line": 617, "character": 2 } ], @@ -15723,7 +16076,28 @@ } }, { - "id": 793, + "id": 805, + "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": 619, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 806, "name": "type", "kind": 1024, "kindString": "Property", @@ -15734,24 +16108,24 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 622, + "line": 621, "character": 2 } ], "type": { "type": "reference", - "id": 802, - "name": "EmailOtpType", + "id": 822, + "name": "MobileOtpType", "dereferenced": { - "id": 802, - "name": "EmailOtpType", + "id": 822, + "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 661, "character": 12 } ], @@ -15760,27 +16134,11 @@ "types": [ { "type": "literal", - "value": "signup" + "value": "sms" }, { "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" + "value": "phone_change" } ] } @@ -15792,37 +16150,37 @@ { "title": "Properties", "kind": 1024, - "children": [791, 794, 792, 793] + "children": [807, 804, 805, 806] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 616, + "line": 615, "character": 17 } ] }, { - "id": 798, - "name": "VerifyTokenHashParams", + "id": 811, + "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 799, - "name": "token_hash", + "id": 812, + "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The token hash used in an email link" + "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 637, + "line": 636, "character": 2 } ], @@ -15832,7 +16190,115 @@ } }, { - "id": 800, + "id": 815, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 641, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 816, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 818, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site.", + "tags": [ + { + "tag": "deprecated", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 649, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 817, + "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": 643, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [818, 817] + } + ] + } + } + }, + { + "id": 813, + "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": 638, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 814, "name": "type", "kind": 1024, "kindString": "Property", @@ -15849,10 +16315,10 @@ ], "type": { "type": "reference", - "id": 802, + "id": 823, "name": "EmailOtpType", "dereferenced": { - "id": 802, + "id": 823, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -15860,7 +16326,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 662, "character": 12 } ], @@ -15901,13 +16367,122 @@ { "title": "Properties", "kind": 1024, - "children": [799, 800] + "children": [812, 815, 813, 814] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 635, + "line": 634, + "character": 17 + } + ] + }, + { + "id": 819, + "name": "VerifyTokenHashParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 820, + "name": "token_hash", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The token hash used in an email link" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 655, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 821, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 658, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 823, + "name": "EmailOtpType", + "dereferenced": { + "id": 823, + "name": "EmailOtpType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 662, + "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" + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [820, 821] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 653, "character": 17 } ] @@ -15923,7 +16498,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 532, "name": "AuthResponse" } ], @@ -15950,42 +16525,42 @@ "title": "Methods", "kind": 2048, "children": [ - 143, 182, 245, 349, 127, 359, 321, 175, 282, 179, 335, 270, 131, 163, 140, 166, 137, - 172, 311, 134, 417, 419, 362, 251, 169 + 144, 183, 246, 362, 128, 372, 334, 176, 283, 180, 348, 271, 132, 164, 141, 167, 138, + 173, 324, 135, 430, 432, 375, 252, 170 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 116, + "line": 123, "character": 21 } ] }, { - "id": 470, + "id": 485, "name": "NavigatorLockAcquireTimeoutError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 471, + "id": 486, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 472, + "id": 487, "name": "new NavigatorLockAcquireTimeoutError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 473, + "id": 488, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -15998,7 +16573,7 @@ ], "type": { "type": "reference", - "id": 470, + "id": 485, "name": "NavigatorLockAcquireTimeoutError" }, "inheritedFrom": { @@ -16013,7 +16588,7 @@ } }, { - "id": 474, + "id": 489, "name": "isAcquireTimeout", "kind": 1024, "kindString": "Property", @@ -16043,12 +16618,12 @@ { "title": "Constructors", "kind": 512, - "children": [471] + "children": [486] }, { "title": "Properties", "kind": 1024, - "children": [474] + "children": [489] } ], "sources": [ @@ -16066,7 +16641,7 @@ ] }, { - "id": 627, + "id": 644, "name": "AMREntry", "kind": 256, "kindString": "Interface", @@ -16083,7 +16658,7 @@ }, "children": [ { - "id": 628, + "id": 645, "name": "method", "kind": 1024, "kindString": "Property", @@ -16094,17 +16669,53 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 262, + "line": 268, "character": 2 } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "literal", + "value": "password" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 646, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "literal", + "value": "otp" + }, + { + "type": "literal", + "value": "oauth" + }, + { + "type": "literal", + "value": "mfa/totp" + } + ] } }, { - "id": 629, + "id": 647, "name": "timestamp", "kind": 1024, "kindString": "Property", @@ -16115,7 +16726,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 268, + "line": 274, "character": 2 } ], @@ -16129,26 +16740,26 @@ { "title": "Properties", "kind": 1024, - "children": [628, 629] + "children": [645, 647] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 260, + "line": 266, "character": 17 } ] }, { - "id": 685, + "id": 705, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 687, + "id": 707, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -16162,7 +16773,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 398, + "line": 404, "character": 2 } ], @@ -16172,7 +16783,7 @@ } }, { - "id": 690, + "id": 710, "name": "ban_duration", "kind": 1024, "kindString": "Property", @@ -16186,7 +16797,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 424, + "line": 430, "character": 2 } ], @@ -16196,7 +16807,7 @@ } }, { - "id": 694, + "id": 717, "name": "email", "kind": 1024, "kindString": "Property", @@ -16209,7 +16820,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -16223,7 +16834,7 @@ } }, { - "id": 688, + "id": 708, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -16237,7 +16848,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 405, + "line": 411, "character": 2 } ], @@ -16247,7 +16858,31 @@ } }, { - "id": 693, + "id": 713, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `id` for the user.", + "text": "Allows you to overwrite the default `id` set for the user.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 455, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 715, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -16261,7 +16896,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -16275,7 +16910,7 @@ } }, { - "id": 692, + "id": 714, "name": "password", "kind": 1024, "kindString": "Property", @@ -16288,7 +16923,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -16302,7 +16937,31 @@ } }, { - "id": 695, + "id": 712, + "name": "password_hash", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The `password_hash` for the user's password.", + "text": "Allows 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.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 716, "name": "phone", "kind": 1024, "kindString": "Property", @@ -16315,7 +16974,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -16329,7 +16988,7 @@ } }, { - "id": 689, + "id": 709, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -16343,7 +17002,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 412, + "line": 418, "character": 2 } ], @@ -16353,7 +17012,7 @@ } }, { - "id": 691, + "id": 711, "name": "role", "kind": 1024, "kindString": "Property", @@ -16367,7 +17026,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 433, + "line": 439, "character": 2 } ], @@ -16377,7 +17036,7 @@ } }, { - "id": 686, + "id": 706, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -16391,7 +17050,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 388, + "line": 394, "character": 2 } ], @@ -16405,13 +17064,13 @@ { "title": "Properties", "kind": 1024, - "children": [687, 690, 694, 688, 693, 692, 695, 689, 691, 686] + "children": [707, 710, 717, 708, 713, 715, 714, 712, 716, 709, 711, 706] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 377, + "line": 383, "character": 17 } ], @@ -16421,7 +17080,7 @@ "typeArguments": [ { "type": "reference", - "id": 679, + "id": 699, "name": "UserAttributes" }, { @@ -16436,7 +17095,7 @@ ] }, { - "id": 642, + "id": 660, "name": "Factor", "kind": 256, "kindString": "Interface", @@ -16460,7 +17119,7 @@ }, "children": [ { - "id": 647, + "id": 666, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -16468,7 +17127,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 307, + "line": 312, "character": 2 } ], @@ -16478,13 +17137,64 @@ } }, { - "id": 645, + "id": 663, "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." + "shortText": "Type of factor. `totp` and `phone` supported with this version" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 307, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 664, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + ] + }, + { + "type": "literal", + "value": "totp" + }, + { + "type": "literal", + "value": "phone" + } + ] + } + }, + { + "id": 662, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." }, "sources": [ { @@ -16499,30 +17209,7 @@ } }, { - "id": 644, - "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": 296, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 643, + "id": 661, "name": "id", "kind": 1024, "kindString": "Property", @@ -16533,7 +17220,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 293, + "line": 299, "character": 2 } ], @@ -16543,7 +17230,7 @@ } }, { - "id": 646, + "id": 665, "name": "status", "kind": 1024, "kindString": "Property", @@ -16554,7 +17241,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 305, + "line": 310, "character": 2 } ], @@ -16573,7 +17260,7 @@ } }, { - "id": 648, + "id": 667, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -16581,7 +17268,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 308, + "line": 313, "character": 2 } ], @@ -16595,26 +17282,26 @@ { "title": "Properties", "kind": 1024, - "children": [647, 645, 644, 643, 646, 648] + "children": [666, 663, 662, 661, 665, 667] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 291, + "line": 297, "character": 17 } ] }, { - "id": 852, + "id": 873, "name": "GenerateLinkOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 853, + "id": 874, "name": "data", "kind": 1024, "kindString": "Property", @@ -16628,7 +17315,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 728, + "line": 746, "character": 2 } ], @@ -16638,7 +17325,7 @@ } }, { - "id": 854, + "id": 875, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -16651,7 +17338,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 730, + "line": 748, "character": 2 } ], @@ -16665,19 +17352,19 @@ { "title": "Properties", "kind": 1024, - "children": [853, 854] + "children": [874, 875] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 722, + "line": 740, "character": 17 } ] }, { - "id": 1012, + "id": 1021, "name": "GoTrueAdminMFAApi", "kind": 256, "kindString": "Interface", @@ -16693,14 +17380,14 @@ }, "children": [ { - "id": 1016, + "id": 1025, "name": "deleteFactor", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1017, + "id": 1026, "name": "deleteFactor", "kind": 4096, "kindString": "Call signature", @@ -16720,17 +17407,17 @@ }, "parameters": [ { - "id": 1018, + "id": 1027, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "dereferenced": { - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -16746,21 +17433,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1028, + "line": 1015, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 997, + "id": 1006, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 998, + "id": 1007, "name": "id", "kind": 1024, "kindString": "Property", @@ -16771,7 +17458,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1030, + "line": 1017, "character": 2 } ], @@ -16781,7 +17468,7 @@ } }, { - "id": 999, + "id": 1008, "name": "userId", "kind": 1024, "kindString": "Property", @@ -16792,7 +17479,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1033, + "line": 1020, "character": 2 } ], @@ -16806,13 +17493,13 @@ { "title": "Properties", "kind": 1024, - "children": [998, 999] + "children": [1007, 1008] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1028, + "line": 1015, "character": 45 } ] @@ -16827,7 +17514,7 @@ "typeArguments": [ { "type": "reference", - "id": 987, + "id": 996, "name": "AuthMFAAdminDeleteFactorResponse" } ], @@ -16839,14 +17526,14 @@ ] }, { - "id": 1013, + "id": 1022, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1014, + "id": 1023, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -16856,17 +17543,17 @@ }, "parameters": [ { - "id": 1015, + "id": 1024, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams", "dereferenced": { - "id": 1009, + "id": 1018, "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", @@ -16882,21 +17569,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1039, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1010, + "id": 1019, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1011, + "id": 1020, "name": "userId", "kind": 1024, "kindString": "Property", @@ -16907,7 +17594,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1054, + "line": 1041, "character": 2 } ], @@ -16921,13 +17608,13 @@ { "title": "Properties", "kind": 1024, - "children": [1011] + "children": [1020] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1039, "character": 44 } ] @@ -16942,7 +17629,7 @@ "typeArguments": [ { "type": "reference", - "id": 1000, + "id": 1009, "name": "AuthMFAAdminListFactorsResponse" } ], @@ -16958,19 +17645,19 @@ { "title": "Methods", "kind": 2048, - "children": [1016, 1013] + "children": [1025, 1022] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1062, + "line": 1049, "character": 17 } ] }, { - "id": 967, + "id": 972, "name": "GoTrueMFAApi", "kind": 256, "kindString": "Interface", @@ -16980,14 +17667,14 @@ }, "children": [ { - "id": 971, + "id": 980, "name": "challenge", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 972, + "id": 981, "name": "challenge", "kind": 4096, "kindString": "Call signature", @@ -16997,17 +17684,17 @@ }, "parameters": [ { - "id": 973, + "id": 982, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 890, + "id": 907, "name": "MFAChallengeParams", "dereferenced": { - "id": 890, + "id": 907, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", @@ -17015,21 +17702,53 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 810, + "line": 821, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 891, + "id": 908, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 892, + "id": 910, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 825, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 909, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -17040,7 +17759,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 812, + "line": 823, "character": 2 } ], @@ -17054,13 +17773,13 @@ { "title": "Properties", "kind": 1024, - "children": [892] + "children": [910, 909] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 810, + "line": 821, "character": 33 } ] @@ -17075,7 +17794,7 @@ "typeArguments": [ { "type": "reference", - "id": 935, + "id": 938, "name": "AuthMFAChallengeResponse" } ], @@ -17087,14 +17806,14 @@ ] }, { - "id": 980, + "id": 989, "name": "challengeAndVerify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 981, + "id": 990, "name": "challengeAndVerify", "kind": 4096, "kindString": "Call signature", @@ -17104,17 +17823,17 @@ }, "parameters": [ { - "id": 982, + "id": 991, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 893, + "id": 911, "name": "MFAChallengeAndVerifyParams", "dereferenced": { - "id": 893, + "id": 911, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -17122,21 +17841,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 894, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 896, + "id": 914, "name": "code", "kind": 1024, "kindString": "Property", @@ -17147,7 +17866,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 819, + "line": 832, "character": 2 } ], @@ -17157,7 +17876,7 @@ } }, { - "id": 895, + "id": 913, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -17168,7 +17887,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 817, + "line": 830, "character": 2 } ], @@ -17182,13 +17901,13 @@ { "title": "Properties", "kind": 1024, - "children": [896, 895] + "children": [914, 913] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 42 } ] @@ -17203,7 +17922,7 @@ "typeArguments": [ { "type": "reference", - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse" } ], @@ -17215,14 +17934,14 @@ ] }, { - "id": 968, + "id": 973, "name": "enroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 969, + "id": 974, "name": "enroll", "kind": 4096, "kindString": "Call signature", @@ -17233,39 +17952,39 @@ }, "parameters": [ { - "id": 970, + "id": 975, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 877, - "name": "MFAEnrollParams", + "id": 1055, + "name": "MFAEnrollTOTPParams", "dereferenced": { - "id": 877, - "name": "MFAEnrollParams", + "id": 1055, + "name": "MFAEnrollTOTPParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 785, + "line": 1129, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 878, + "id": 1056, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 879, + "id": 1057, "name": "factorType", "kind": 1024, "kindString": "Property", @@ -17276,7 +17995,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 787, + "line": 1131, "character": 2 } ], @@ -17286,7 +18005,7 @@ } }, { - "id": 881, + "id": 1059, "name": "friendlyName", "kind": 1024, "kindString": "Property", @@ -17299,7 +18018,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 791, + "line": 1135, "character": 2 } ], @@ -17309,7 +18028,7 @@ } }, { - "id": 880, + "id": 1058, "name": "issuer", "kind": 1024, "kindString": "Property", @@ -17322,7 +18041,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 789, + "line": 1133, "character": 2 } ], @@ -17336,14 +18055,14 @@ { "title": "Properties", "kind": 1024, - "children": [879, 881, 880] + "children": [1057, 1059, 1058] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 785, - "character": 30 + "line": 1129, + "character": 34 } ] } @@ -17357,7 +18076,411 @@ "typeArguments": [ { "type": "reference", - "id": 910, + "id": 1065, + "name": "AuthMFAEnrollTOTPResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + }, + { + "id": 976, + "name": "enroll", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 977, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 1060, + "name": "MFAEnrollPhoneParams", + "dereferenced": { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 1081, + "name": "AuthMFAEnrollPhoneResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + }, + { + "id": 978, + "name": "enroll", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 979, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 898, + "name": "MFAEnrollParams", + "dereferenced": { + "id": 898, + "name": "MFAEnrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 803, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "id": 1055, + "name": "MFAEnrollTOTPParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1056, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1057, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1131, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + }, + { + "id": 1059, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1135, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1058, + "name": "issuer", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Domain which the user is enrolled with." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1133, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1057, 1059, 1058] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 34 + } + ] + } + } + }, + { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + } + ] + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 928, "name": "AuthMFAEnrollResponse" } ], @@ -17369,14 +18492,14 @@ ] }, { - "id": 985, + "id": 994, "name": "getAuthenticatorAssuranceLevel", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 986, + "id": 995, "name": "getAuthenticatorAssuranceLevel", "kind": 4096, "kindString": "Call signature", @@ -17390,7 +18513,7 @@ "typeArguments": [ { "type": "reference", - "id": 956, + "id": 961, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" } ], @@ -17402,14 +18525,14 @@ ] }, { - "id": 983, + "id": 992, "name": "listFactors", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 984, + "id": 993, "name": "listFactors", "kind": 4096, "kindString": "Call signature", @@ -17436,7 +18559,7 @@ "typeArguments": [ { "type": "reference", - "id": 945, + "id": 949, "name": "AuthMFAListFactorsResponse" } ], @@ -17448,14 +18571,14 @@ ] }, { - "id": 977, + "id": 986, "name": "unenroll", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 978, + "id": 987, "name": "unenroll", "kind": 4096, "kindString": "Call signature", @@ -17465,17 +18588,17 @@ }, "parameters": [ { - "id": 979, + "id": 988, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 882, + "id": 899, "name": "MFAUnenrollParams", "dereferenced": { - "id": 882, + "id": 899, "name": "MFAUnenrollParams", "kind": 4194304, "kindString": "Type alias", @@ -17483,21 +18606,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 794, + "line": 805, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 883, + "id": 900, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 884, + "id": 901, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -17508,7 +18631,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 796, + "line": 807, "character": 2 } ], @@ -17522,13 +18645,13 @@ { "title": "Properties", "kind": 1024, - "children": [884] + "children": [901] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 794, + "line": 805, "character": 32 } ] @@ -17543,7 +18666,7 @@ "typeArguments": [ { "type": "reference", - "id": 926, + "id": 929, "name": "AuthMFAUnenrollResponse" } ], @@ -17555,14 +18678,14 @@ ] }, { - "id": 974, + "id": 983, "name": "verify", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 975, + "id": 984, "name": "verify", "kind": 4096, "kindString": "Call signature", @@ -17572,17 +18695,17 @@ }, "parameters": [ { - "id": 976, + "id": 985, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 885, + "id": 902, "name": "MFAVerifyParams", "dereferenced": { - "id": 885, + "id": 902, "name": "MFAVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -17590,21 +18713,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 799, + "line": 810, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 886, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 888, + "id": 905, "name": "challengeId", "kind": 1024, "kindString": "Property", @@ -17615,7 +18738,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 804, + "line": 815, "character": 2 } ], @@ -17625,7 +18748,7 @@ } }, { - "id": 889, + "id": 906, "name": "code", "kind": 1024, "kindString": "Property", @@ -17636,7 +18759,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 807, + "line": 818, "character": 2 } ], @@ -17646,7 +18769,7 @@ } }, { - "id": 887, + "id": 904, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -17657,7 +18780,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 801, + "line": 812, "character": 2 } ], @@ -17671,13 +18794,13 @@ { "title": "Properties", "kind": 1024, - "children": [888, 889, 887] + "children": [905, 906, 904] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 799, + "line": 810, "character": 30 } ] @@ -17692,7 +18815,7 @@ "typeArguments": [ { "type": "reference", - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse" } ], @@ -17708,26 +18831,26 @@ { "title": "Methods", "kind": 2048, - "children": [971, 980, 968, 985, 983, 977, 974] + "children": [980, 989, 973, 994, 992, 986, 983] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 949, + "line": 934, "character": 17 } ] }, { - "id": 618, + "id": 635, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 621, + "id": 638, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -17738,7 +18861,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 241, "character": 2 } ], @@ -17748,7 +18871,7 @@ } }, { - "id": 624, + "id": 641, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -17761,7 +18884,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 247, + "line": 253, "character": 2 } ], @@ -17771,7 +18894,7 @@ } }, { - "id": 623, + "id": 640, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -17782,7 +18905,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 243, + "line": 249, "character": 2 } ], @@ -17792,7 +18915,7 @@ } }, { - "id": 620, + "id": 637, "name": "provider_refresh_token", "kind": 1024, "kindString": "Property", @@ -17805,7 +18928,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 231, + "line": 237, "character": 2 } ], @@ -17824,7 +18947,7 @@ } }, { - "id": 619, + "id": 636, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -17837,7 +18960,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 226, + "line": 232, "character": 2 } ], @@ -17856,7 +18979,7 @@ } }, { - "id": 622, + "id": 639, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -17867,7 +18990,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 245, "character": 2 } ], @@ -17877,7 +19000,7 @@ } }, { - "id": 625, + "id": 642, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -17885,7 +19008,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 248, + "line": 254, "character": 2 } ], @@ -17895,7 +19018,7 @@ } }, { - "id": 626, + "id": 643, "name": "user", "kind": 1024, "kindString": "Property", @@ -17903,250 +19026,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 249, + "line": 255, "character": 2 } ], "type": { "type": "reference", - "id": 656, + "id": 675, "name": "User", "dereferenced": { - "id": 656, + "id": 675, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 667, + "id": 686, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 331, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 322, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 649, - "name": "UserAppMetadata", - "dereferenced": { - "id": 649, - "name": "UserAppMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 650, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 312, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [650] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 311, - "character": 17 - } - ], - "indexSignature": { - "id": 651, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 652, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 660, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 324, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 661, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 325, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 671, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 335, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 670, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 334, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 668, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 332, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 663, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 327, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 672, - "name": "email_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -18160,39 +19062,100 @@ } }, { - "id": 678, - "name": "factors", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 642, - "name": "Factor" - } - } - }, - { - "id": 657, - "name": "id", + "id": 677, + "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 321, + "line": 327, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 668, + "name": "UserAppMetadata", + "dereferenced": { + "id": 668, + "name": "UserAppMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 669, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 317, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [669] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 316, + "character": 17 + } + ], + "indexSignature": { + "id": 670, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 671, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 679, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 329, "character": 2 } ], @@ -18202,32 +19165,8 @@ } }, { - "id": 677, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 341, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 630, - "name": "UserIdentity" - } - } - }, - { - "id": 666, - "name": "invited_at", + "id": 680, + "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", "flags": { @@ -18246,148 +19185,8 @@ } }, { - "id": 674, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 338, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 328, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "new_phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 329, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 669, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 333, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 673, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 337, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 662, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 326, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 675, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 339, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 676, - "name": "updated_at", + "id": 690, + "name": "confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -18406,7 +19205,351 @@ } }, { - "id": 659, + "id": 689, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 339, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 687, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 337, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 682, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 332, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 691, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 341, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 698, + "name": "factors", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 348, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + }, + { + "id": 676, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 326, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 696, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 346, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 648, + "name": "UserIdentity" + } + } + }, + { + "id": 685, + "name": "invited_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 335, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 697, + "name": "is_anonymous", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 347, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 693, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 343, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 683, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 333, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 684, + "name": "new_phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 334, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 688, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 338, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 692, + "name": "phone_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 342, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 681, + "name": "recovery_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 331, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 694, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 344, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 695, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 345, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 678, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -18414,16 +19557,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 323, + "line": 328, "character": 2 } ], "type": { "type": "reference", - "id": 653, + "id": 672, "name": "UserMetadata", "dereferenced": { - "id": 653, + "id": 672, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -18431,19 +19574,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 316, + "line": 321, "character": 17 } ], "indexSignature": { - "id": 654, + "id": 673, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 655, + "id": 674, "name": "key", "kind": 32768, "flags": {}, @@ -18467,15 +19610,15 @@ "title": "Properties", "kind": 1024, "children": [ - 667, 658, 660, 661, 671, 670, 668, 663, 672, 678, 657, 677, 666, 674, 664, 665, - 669, 673, 662, 675, 676, 659 + 686, 677, 679, 680, 690, 689, 687, 682, 691, 698, 676, 696, 685, 697, 693, 683, + 684, 688, 692, 681, 694, 695, 678 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 320, + "line": 325, "character": 17 } ] @@ -18487,26 +19630,26 @@ { "title": "Properties", "kind": 1024, - "children": [621, 624, 623, 620, 619, 622, 625, 626] + "children": [638, 641, 640, 637, 636, 639, 642, 643] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 222, + "line": 228, "character": 17 } ] }, { - "id": 696, + "id": 718, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 697, + "id": 719, "name": "id", "kind": 1024, "kindString": "Property", @@ -18517,7 +19660,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 440, + "line": 462, "character": 2 } ], @@ -18527,7 +19670,7 @@ } }, { - "id": 698, + "id": 720, "name": "callback", "kind": 2048, "kindString": "Method", @@ -18535,13 +19678,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 444, + "line": 466, "character": 2 } ], "signatures": [ { - "id": 699, + "id": 721, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -18551,17 +19694,17 @@ }, "parameters": [ { - "id": 700, + "id": 722, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 480, + "id": 495, "name": "AuthChangeEvent", "dereferenced": { - "id": 480, + "id": 495, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -18569,7 +19712,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 30, + "line": 31, "character": 12 } ], @@ -18601,7 +19744,7 @@ "value": "USER_UPDATED" }, { - "id": 479, + "id": 494, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -18609,7 +19752,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 28, + "line": 29, "character": 12 } ], @@ -18624,7 +19767,7 @@ } }, { - "id": 701, + "id": 723, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -18638,7 +19781,7 @@ }, { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } ] @@ -18653,7 +19796,7 @@ ] }, { - "id": 702, + "id": 724, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -18661,13 +19804,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 448, + "line": 470, "character": 2 } ], "signatures": [ { - "id": 703, + "id": 725, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -18687,299 +19830,37 @@ { "title": "Properties", "kind": 1024, - "children": [697] + "children": [719] }, { "title": "Methods", "kind": 2048, - "children": [698, 702] + "children": [720, 724] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 436, + "line": 458, "character": 17 } ] }, { - "id": 704, - "name": "UpdatableFactorAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 705, - "name": "friendlyName", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 452, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [705] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 451, - "character": 17 - } - ] - }, - { - "id": 656, + "id": 675, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 667, + "id": 686, "name": "action_link", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 331, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 322, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 649, - "name": "UserAppMetadata", - "dereferenced": { - "id": 649, - "name": "UserAppMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 650, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 312, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [650] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 311, - "character": 17 - } - ], - "indexSignature": { - "id": 651, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 652, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 660, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 324, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 661, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 325, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 671, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 335, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 670, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 334, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 668, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 332, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 663, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 327, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 672, - "name": "email_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -18993,39 +19874,100 @@ } }, { - "id": 678, - "name": "factors", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 642, - "name": "Factor" - } - } - }, - { - "id": 657, - "name": "id", + "id": 677, + "name": "app_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 321, + "line": 327, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 668, + "name": "UserAppMetadata", + "dereferenced": { + "id": 668, + "name": "UserAppMetadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 669, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 317, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [669] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 316, + "character": 17 + } + ], + "indexSignature": { + "id": 670, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 671, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 679, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 329, "character": 2 } ], @@ -19035,32 +19977,8 @@ } }, { - "id": 677, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 341, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 630, - "name": "UserIdentity" - } - } - }, - { - "id": 666, - "name": "invited_at", + "id": 680, + "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", "flags": { @@ -19079,148 +19997,8 @@ } }, { - "id": 674, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 338, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 328, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "new_phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 329, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 669, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 333, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 673, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 337, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 662, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 326, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 675, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 339, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 676, - "name": "updated_at", + "id": 690, + "name": "confirmed_at", "kind": 1024, "kindString": "Property", "flags": { @@ -19239,7 +20017,351 @@ } }, { - "id": 659, + "id": 689, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 339, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 687, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 337, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 682, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 332, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 691, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 341, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 698, + "name": "factors", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 348, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + }, + { + "id": 676, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 326, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 696, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 346, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 648, + "name": "UserIdentity" + } + } + }, + { + "id": 685, + "name": "invited_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 335, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 697, + "name": "is_anonymous", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 347, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 693, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 343, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 683, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 333, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 684, + "name": "new_phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 334, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 688, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 338, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 692, + "name": "phone_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 342, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 681, + "name": "recovery_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 331, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 694, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 344, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 695, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 345, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 678, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -19247,16 +20369,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 323, + "line": 328, "character": 2 } ], "type": { "type": "reference", - "id": 653, + "id": 672, "name": "UserMetadata", "dereferenced": { - "id": 653, + "id": 672, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -19264,19 +20386,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 316, + "line": 321, "character": 17 } ], "indexSignature": { - "id": 654, + "id": 673, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 655, + "id": 674, "name": "key", "kind": 32768, "flags": {}, @@ -19300,28 +20422,28 @@ "title": "Properties", "kind": 1024, "children": [ - 667, 658, 660, 661, 671, 670, 668, 663, 672, 678, 657, 677, 666, 674, 664, 665, 669, - 673, 662, 675, 676, 659 + 686, 677, 679, 680, 690, 689, 687, 682, 691, 698, 676, 696, 685, 697, 693, 683, 684, + 688, 692, 681, 694, 695, 678 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 320, + "line": 325, "character": 17 } ] }, { - "id": 649, + "id": 668, "name": "UserAppMetadata", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 650, + "id": 669, "name": "provider", "kind": 1024, "kindString": "Property", @@ -19331,7 +20453,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 312, + "line": 317, "character": 2 } ], @@ -19345,25 +20467,25 @@ { "title": "Properties", "kind": 1024, - "children": [650] + "children": [669] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 311, + "line": 316, "character": 17 } ], "indexSignature": { - "id": 651, + "id": 670, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 652, + "id": 671, "name": "key", "kind": 32768, "flags": {}, @@ -19380,14 +20502,14 @@ } }, { - "id": 679, + "id": 699, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 684, + "id": 704, "name": "data", "kind": 1024, "kindString": "Property", @@ -19401,7 +20523,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 374, + "line": 380, "character": 2 } ], @@ -19411,7 +20533,7 @@ } }, { - "id": 680, + "id": 700, "name": "email", "kind": 1024, "kindString": "Property", @@ -19424,7 +20546,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 355, "character": 2 } ], @@ -19434,7 +20556,7 @@ } }, { - "id": 683, + "id": 703, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -19448,7 +20570,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 366, + "line": 372, "character": 2 } ], @@ -19458,7 +20580,7 @@ } }, { - "id": 682, + "id": 702, "name": "password", "kind": 1024, "kindString": "Property", @@ -19471,7 +20593,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 359, + "line": 365, "character": 2 } ], @@ -19481,7 +20603,7 @@ } }, { - "id": 681, + "id": 701, "name": "phone", "kind": 1024, "kindString": "Property", @@ -19494,7 +20616,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 354, + "line": 360, "character": 2 } ], @@ -19508,26 +20630,26 @@ { "title": "Properties", "kind": 1024, - "children": [684, 680, 683, 682, 681] + "children": [704, 700, 703, 702, 701] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 345, + "line": 351, "character": 17 } ] }, { - "id": 630, + "id": 648, "name": "UserIdentity", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 639, + "id": 657, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -19537,7 +20659,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 279, + "line": 285, "character": 2 } ], @@ -19547,7 +20669,7 @@ } }, { - "id": 631, + "id": 649, "name": "id", "kind": 1024, "kindString": "Property", @@ -19555,7 +20677,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 272, + "line": 278, "character": 2 } ], @@ -19565,7 +20687,7 @@ } }, { - "id": 633, + "id": 651, "name": "identity_data", "kind": 1024, "kindString": "Property", @@ -19575,27 +20697,27 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 274, + "line": 280, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 634, + "id": 652, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 635, + "id": 653, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 636, + "id": 654, "name": "key", "kind": 32768, "flags": {}, @@ -19614,7 +20736,7 @@ } }, { - "id": 637, + "id": 655, "name": "identity_id", "kind": 1024, "kindString": "Property", @@ -19622,7 +20744,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 277, + "line": 283, "character": 2 } ], @@ -19632,7 +20754,7 @@ } }, { - "id": 640, + "id": 658, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -19642,7 +20764,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 280, + "line": 286, "character": 2 } ], @@ -19652,7 +20774,7 @@ } }, { - "id": 638, + "id": 656, "name": "provider", "kind": 1024, "kindString": "Property", @@ -19660,7 +20782,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 284, "character": 2 } ], @@ -19670,7 +20792,7 @@ } }, { - "id": 641, + "id": 659, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -19680,7 +20802,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 281, + "line": 287, "character": 2 } ], @@ -19690,7 +20812,7 @@ } }, { - "id": 632, + "id": 650, "name": "user_id", "kind": 1024, "kindString": "Property", @@ -19698,7 +20820,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 273, + "line": 279, "character": 2 } ], @@ -19712,19 +20834,19 @@ { "title": "Properties", "kind": 1024, - "children": [639, 631, 633, 637, 640, 638, 641, 632] + "children": [657, 649, 651, 655, 658, 656, 659, 650] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 271, + "line": 277, "character": 17 } ] }, { - "id": 653, + "id": 672, "name": "UserMetadata", "kind": 256, "kindString": "Interface", @@ -19732,19 +20854,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 316, + "line": 321, "character": 17 } ], "indexSignature": { - "id": 654, + "id": 673, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 655, + "id": 674, "name": "key", "kind": 32768, "flags": {}, @@ -19761,14 +20883,14 @@ } }, { - "id": 790, + "id": 811, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 791, + "id": 812, "name": "email", "kind": 1024, "kindString": "Property", @@ -19779,7 +20901,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 618, + "line": 636, "character": 2 } ], @@ -19789,7 +20911,7 @@ } }, { - "id": 794, + "id": 815, "name": "options", "kind": 1024, "kindString": "Property", @@ -19799,21 +20921,217 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 623, + "line": 641, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 795, + "id": 816, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 797, + "id": 818, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site.", + "tags": [ + { + "tag": "deprecated", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 649, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 817, + "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": 643, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [818, 817] + } + ] + } + } + }, + { + "id": 813, + "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": 638, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 814, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 640, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 823, + "name": "EmailOtpType", + "dereferenced": { + "id": 823, + "name": "EmailOtpType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 662, + "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" + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [812, 815, 813, 814] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 634, + "character": 17 + } + ] + }, + { + "id": 803, + "name": "VerifyMobileOtpParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 807, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 622, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 808, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 810, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -19842,7 +21160,7 @@ } }, { - "id": 796, + "id": 809, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -19855,7 +21173,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 625, + "line": 624, "character": 4 } ], @@ -19869,210 +21187,14 @@ { "title": "Properties", "kind": 1024, - "children": [797, 796] + "children": [810, 809] } ] } } }, { - "id": 792, - "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": 620, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 793, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 622, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 802, - "name": "EmailOtpType", - "dereferenced": { - "id": 802, - "name": "EmailOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 644, - "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" - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [791, 794, 792, 793] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 616, - "character": 17 - } - ] - }, - { - "id": 782, - "name": "VerifyMobileOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 786, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 604, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 787, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 789, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ - { - "tag": "deprecated", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 613, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 788, - "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": 606, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [789, 788] - } - ] - } - } - }, - { - "id": 783, + "id": 804, "name": "phone", "kind": 1024, "kindString": "Property", @@ -20083,7 +21205,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 599, + "line": 617, "character": 2 } ], @@ -20093,7 +21215,7 @@ } }, { - "id": 784, + "id": 805, "name": "token", "kind": 1024, "kindString": "Property", @@ -20104,7 +21226,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 601, + "line": 619, "character": 2 } ], @@ -20114,7 +21236,7 @@ } }, { - "id": 785, + "id": 806, "name": "type", "kind": 1024, "kindString": "Property", @@ -20125,16 +21247,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 603, + "line": 621, "character": 2 } ], "type": { "type": "reference", - "id": 801, + "id": 822, "name": "MobileOtpType", "dereferenced": { - "id": 801, + "id": 822, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -20142,7 +21264,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 643, + "line": 661, "character": 12 } ], @@ -20167,26 +21289,26 @@ { "title": "Properties", "kind": 1024, - "children": [786, 783, 784, 785] + "children": [807, 804, 805, 806] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 597, + "line": 615, "character": 17 } ] }, { - "id": 798, + "id": 819, "name": "VerifyTokenHashParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 799, + "id": 820, "name": "token_hash", "kind": 1024, "kindString": "Property", @@ -20197,7 +21319,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 637, + "line": 655, "character": 2 } ], @@ -20207,7 +21329,7 @@ } }, { - "id": 800, + "id": 821, "name": "type", "kind": 1024, "kindString": "Property", @@ -20218,16 +21340,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 640, + "line": 658, "character": 2 } ], "type": { "type": "reference", - "id": 802, + "id": 823, "name": "EmailOtpType", "dereferenced": { - "id": 802, + "id": 823, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -20235,7 +21357,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 662, "character": 12 } ], @@ -20276,19 +21398,19 @@ { "title": "Properties", "kind": 1024, - "children": [799, 800] + "children": [820, 821] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 635, + "line": 653, "character": 17 } ] }, { - "id": 480, + "id": 495, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -20296,7 +21418,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 30, + "line": 31, "character": 12 } ], @@ -20328,7 +21450,7 @@ "value": "USER_UPDATED" }, { - "id": 479, + "id": 494, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -20336,7 +21458,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 28, + "line": 29, "character": 12 } ], @@ -20349,7 +21471,7 @@ } }, { - "id": 479, + "id": 494, "name": "AuthChangeEventMFA", "kind": 4194304, "kindString": "Type alias", @@ -20357,7 +21479,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 28, + "line": 29, "character": 12 } ], @@ -20367,7 +21489,7 @@ } }, { - "id": 759, + "id": 779, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -20375,7 +21497,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 565, + "line": 583, "character": 12 } ], @@ -20394,7 +21516,7 @@ } }, { - "id": 996, + "id": 1005, "name": "AuthMFAAdminDeleteFactorParams", "kind": 4194304, "kindString": "Type alias", @@ -20407,96 +21529,6 @@ } ] }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1028, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 997, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 998, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the MFA factor to delete." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1030, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 999, - "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": 1033, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [998, 999] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1028, - "character": 45 - } - ] - } - } - }, - { - "id": 987, - "name": "AuthMFAAdminDeleteFactorResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -20505,182 +21537,77 @@ } ], "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 988, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "type": "reflection", + "declaration": { + "id": 1006, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1007, + "name": "id", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ - { - "id": 989, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1017, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 990, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 991, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was successfully deleted." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1019, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [991] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1017, - "character": 12 - } - ] - } - } - }, - { - "id": 992, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1021, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [989, 992] - } - ], + "comment": { + "shortText": "ID of the MFA factor to delete." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 1016, - "character": 4 + "line": 1017, + "character": 2 } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 993, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1008, + "name": "userId", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ - { - "id": 994, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1023, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 995, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1023, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [994, 995] - } - ], + "comment": { + "shortText": "ID of the user whose factor is being deleted." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 1023, - "character": 4 + "line": 1020, + "character": 2 } - ] + ], + "type": { + "type": "intrinsic", + "name": "string" + } } - } - ] + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1007, 1008] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1015, + "character": 45 + } + ] + } } }, { - "id": 1009, - "name": "AuthMFAAdminListFactorsParams", + "id": 996, + "name": "AuthMFAAdminDeleteFactorResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, @@ -20695,61 +21622,187 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1052, + "line": 1002, "character": 12 } ], "type": { - "type": "reflection", - "declaration": { - "id": 1010, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 1011, - "name": "userId", - "kind": 1024, - "kindString": "Property", + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 997, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "ID of the user." - }, + "children": [ + { + "id": 998, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1004, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 999, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1000, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor that was successfully deleted." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1006, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1000] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1004, + "character": 12 + } + ] + } + } + }, + { + "id": 1001, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1008, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [998, 1001] + } + ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1054, - "character": 2 + "line": 1003, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1002, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1003, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1010, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1004, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1010, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } } ], - "type": { - "type": "intrinsic", - "name": "string" - } + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1003, 1004] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1010, + "character": 4 + } + ] } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [1011] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1052, - "character": 44 - } - ] - } + } + ] } }, { - "id": 1000, - "name": "AuthMFAAdminListFactorsResponse", + "id": 1018, + "name": "AuthMFAAdminListFactorsParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, @@ -20768,20 +21821,89 @@ "character": 12 } ], + "type": { + "type": "reflection", + "declaration": { + "id": 1019, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1020, + "name": "userId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1041, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1020] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1039, + "character": 44 + } + ] + } + } + }, + { + "id": 1009, + "name": "AuthMFAAdminListFactorsResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "tags": [ + { + "tag": "expermental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1026, + "character": 12 + } + ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { - "id": 1001, + "id": 1010, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1002, + "id": 1011, "name": "data", "kind": 1024, "kindString": "Property", @@ -20789,21 +21911,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1041, + "line": 1028, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 1003, + "id": 1012, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1004, + "id": 1013, "name": "factors", "kind": 1024, "kindString": "Property", @@ -20814,7 +21936,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1043, + "line": 1030, "character": 8 } ], @@ -20822,7 +21944,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 642, + "id": 660, "name": "Factor" } } @@ -20832,13 +21954,13 @@ { "title": "Properties", "kind": 1024, - "children": [1004] + "children": [1013] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1041, + "line": 1028, "character": 12 } ] @@ -20846,7 +21968,7 @@ } }, { - "id": 1005, + "id": 1014, "name": "error", "kind": 1024, "kindString": "Property", @@ -20854,7 +21976,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1045, + "line": 1032, "character": 6 } ], @@ -20868,13 +21990,13 @@ { "title": "Properties", "kind": 1024, - "children": [1002, 1005] + "children": [1011, 1014] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1040, + "line": 1027, "character": 4 } ] @@ -20883,14 +22005,14 @@ { "type": "reflection", "declaration": { - "id": 1006, + "id": 1015, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1007, + "id": 1016, "name": "data", "kind": 1024, "kindString": "Property", @@ -20898,7 +22020,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1047, + "line": 1034, "character": 6 } ], @@ -20908,7 +22030,7 @@ } }, { - "id": 1008, + "id": 1017, "name": "error", "kind": 1024, "kindString": "Property", @@ -20916,13 +22038,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1047, + "line": 1034, "character": 18 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -20931,13 +22053,13 @@ { "title": "Properties", "kind": 1024, - "children": [1007, 1008] + "children": [1016, 1017] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1047, + "line": 1034, "character": 4 } ] @@ -20947,7 +22069,7 @@ } }, { - "id": 935, + "id": 938, "name": "AuthMFAChallengeResponse", "kind": 4194304, "kindString": "Type alias", @@ -20955,7 +22077,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 892, + "line": 872, "character": 12 } ], @@ -20965,14 +22087,14 @@ { "type": "reflection", "declaration": { - "id": 936, + "id": 939, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 937, + "id": 940, "name": "data", "kind": 1024, "kindString": "Property", @@ -20980,21 +22102,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 894, + "line": 874, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 938, + "id": 941, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 940, + "id": 944, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -21005,7 +22127,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 899, + "line": 882, "character": 8 } ], @@ -21015,7 +22137,7 @@ } }, { - "id": 939, + "id": 942, "name": "id", "kind": 1024, "kindString": "Property", @@ -21026,196 +22148,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 896, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [940, 939] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 894, - "character": 12 - } - ] - } - } - }, - { - "id": 941, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 901, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [937, 941] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 893, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 942, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 943, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 903, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 944, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 903, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [943, 944] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 903, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 910, - "name": "AuthMFAEnrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 847, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 911, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 912, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 849, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 913, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 921, - "name": "friendly_name", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Friendly name of the factor, useful for distinguishing between factors" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 873, + "line": 876, "character": 8 } ], @@ -21225,357 +22158,18 @@ } }, { - "id": 914, - "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": 851, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 916, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "TOTP enrollment information." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 857, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 917, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 918, - "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": 861, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 919, - "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": 866, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 920, - "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": 870, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [918, 919, 920] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 857, - "character": 14 - } - ] - } - } - }, - { - "id": 915, + "id": 943, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Type of MFA factor. Only `totp` supported for now." + "shortText": "Factor Type which generated the challenge" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 854, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [921, 914, 916, 915] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 849, - "character": 12 - } - ] - } - } - }, - { - "id": 922, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 875, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [912, 922] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 848, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 923, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 924, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 878, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 925, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 879, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [924, 925] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 877, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 956, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 920, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 957, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 958, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 922, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 959, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 962, - "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": 939, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 627, - "name": "AMREntry" - } - } - }, - { - "id": 960, - "name": "currentLevel", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Current AAL level of the session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 924, + "line": 879, "character": 8 } ], @@ -21583,50 +22177,12 @@ "type": "union", "types": [ { - "type": "reference", - "id": 955, - "name": "AuthenticatorAssuranceLevels" + "type": "literal", + "value": "totp" }, { "type": "literal", - "value": null - } - ] - } - }, - { - "id": 961, - "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": 932, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 955, - "name": "AuthenticatorAssuranceLevels" - }, - { - "type": "literal", - "value": null + "value": "phone" } ] } @@ -21636,13 +22192,13 @@ { "title": "Properties", "kind": 1024, - "children": [962, 960, 961] + "children": [944, 942, 943] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 922, + "line": 874, "character": 12 } ] @@ -21650,7 +22206,7 @@ } }, { - "id": 963, + "id": 945, "name": "error", "kind": 1024, "kindString": "Property", @@ -21658,7 +22214,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 941, + "line": 884, "character": 6 } ], @@ -21672,100 +22228,18 @@ { "title": "Properties", "kind": 1024, - "children": [958, 963] + "children": [940, 945] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 921, + "line": 873, "character": 4 } ] } }, - { - "type": "reflection", - "declaration": { - "id": 964, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 965, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 943, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 966, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 943, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [965, 966] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 943, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 945, - "name": "AuthMFAListFactorsResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 905, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ { "type": "reflection", "declaration": { @@ -21784,89 +22258,17 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 907, + "line": 886, "character": 6 } ], "type": { - "type": "reflection", - "declaration": { - "id": 948, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 949, - "name": "all", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "All available factors (verified and unverified)." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 909, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 642, - "name": "Factor" - } - } - }, - { - "id": 950, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Only verified TOTP factors. (A subset of `all`.)" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 912, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 642, - "name": "Factor" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [949, 950] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 907, - "character": 12 - } - ] - } + "type": "literal", + "value": null } }, { - "id": 951, + "id": 948, "name": "error", "kind": 1024, "kindString": "Property", @@ -21874,7 +22276,197 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 914, + "line": 886, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [947, 948] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 886, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 1081, + "name": "AuthMFAEnrollPhoneResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1181, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1082, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1083, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1183, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1084, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1087, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1191, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1085, + "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": 1185, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1088, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number of the MFA factor in E.164 format. Used to send messages" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1194, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1086, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1188, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1087, 1085, 1088, 1086] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1183, + "character": 12 + } + ] + } + } + }, + { + "id": 1089, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1196, "character": 6 } ], @@ -21888,7 +22480,1211 @@ { "title": "Properties", "kind": 1024, - "children": [947, 951] + "children": [1083, 1089] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1182, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1090, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1091, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1199, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1092, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1200, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1091, 1092] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1198, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 928, + "name": "AuthMFAEnrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 860, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "id": 1065, + "name": "AuthMFAEnrollTOTPResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1146, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1066, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1067, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1148, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1068, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1076, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1172, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1069, + "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": 1150, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1071, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "TOTP enrollment information." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1156, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1072, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1073, + "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": 1160, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1074, + "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": 1165, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1075, + "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": 1169, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1073, 1074, 1075] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1156, + "character": 14 + } + ] + } + } + }, + { + "id": 1070, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1153, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1076, 1069, 1071, 1070] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1148, + "character": 12 + } + ] + } + } + }, + { + "id": 1077, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1174, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1067, 1077] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1147, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1078, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1079, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1177, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1080, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1178, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1079, 1080] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1176, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 1081, + "name": "AuthMFAEnrollPhoneResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1181, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1082, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1083, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1183, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1084, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1087, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1191, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1085, + "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": 1185, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1088, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number of the MFA factor in E.164 format. Used to send messages" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1194, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1086, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1188, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1087, 1085, 1088, 1086] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1183, + "character": 12 + } + ] + } + } + }, + { + "id": 1089, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1196, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1083, 1089] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1182, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1090, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1091, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1199, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1092, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1200, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1091, 1092] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1198, + "character": 4 + } + ] + } + } + ] + } + } + ] + } + }, + { + "id": 1065, + "name": "AuthMFAEnrollTOTPResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1146, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 1066, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1067, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1148, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1068, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1076, + "name": "friendly_name", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Friendly name of the factor, useful for distinguishing between factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1172, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1069, + "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": 1150, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1071, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "TOTP enrollment information." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1156, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1072, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1073, + "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": 1160, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1074, + "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": 1165, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1075, + "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": 1169, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1073, 1074, 1075] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1156, + "character": 14 + } + ] + } + } + }, + { + "id": 1070, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Type of MFA factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1153, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1076, 1069, 1071, 1070] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1148, + "character": 12 + } + ] + } + } + }, + { + "id": 1077, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1174, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1067, 1077] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1147, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 1078, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1079, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1177, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 1080, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1178, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1079, 1080] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1176, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 961, + "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 905, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 962, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 963, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 907, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 964, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 967, + "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": 924, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 644, + "name": "AMREntry" + } + } + }, + { + "id": 965, + "name": "currentLevel", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Current AAL level of the session." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 909, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 960, + "name": "AuthenticatorAssuranceLevels" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 966, + "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": 917, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 960, + "name": "AuthenticatorAssuranceLevels" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [967, 965, 966] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 907, + "character": 12 + } + ] + } + } + }, + { + "id": 968, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 926, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [963, 968] } ], "sources": [ @@ -21903,14 +23699,14 @@ { "type": "reflection", "declaration": { - "id": 952, + "id": 969, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 953, + "id": 970, "name": "data", "kind": 1024, "kindString": "Property", @@ -21918,7 +23714,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 916, + "line": 928, "character": 6 } ], @@ -21928,7 +23724,7 @@ } }, { - "id": 954, + "id": 971, "name": "error", "kind": 1024, "kindString": "Property", @@ -21936,13 +23732,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 916, + "line": 928, "character": 18 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -21951,13 +23747,13 @@ { "title": "Properties", "kind": 1024, - "children": [953, 954] + "children": [970, 971] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 916, + "line": 928, "character": 4 } ] @@ -21967,15 +23763,15 @@ } }, { - "id": 926, - "name": "AuthMFAUnenrollResponse", + "id": 949, + "name": "AuthMFAListFactorsResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 882, + "line": 888, "character": 12 } ], @@ -21985,14 +23781,14 @@ { "type": "reflection", "declaration": { - "id": 927, + "id": 950, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 928, + "id": 951, "name": "data", "kind": 1024, "kindString": "Property", @@ -22000,21 +23796,262 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 884, + "line": 890, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 929, + "id": 952, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 930, + "id": 953, + "name": "all", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "All available factors (verified and unverified)." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 892, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + }, + { + "id": 955, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Only verified Phone factors. (A subset of `all`.)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 897, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + }, + { + "id": 954, + "name": "totp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Only verified TOTP factors. (A subset of `all`.)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 895, + "character": 8 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 660, + "name": "Factor" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [953, 955, 954] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 890, + "character": 12 + } + ] + } + } + }, + { + "id": 956, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 899, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [951, 956] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 889, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 957, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 958, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 901, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 959, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 901, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [958, 959] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 901, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 929, + "name": "AuthMFAUnenrollResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 862, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 930, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 931, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 864, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 932, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 933, "name": "id", "kind": 1024, "kindString": "Property", @@ -22025,7 +24062,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 886, + "line": 866, "character": 8 } ], @@ -22039,81 +24076,19 @@ { "title": "Properties", "kind": 1024, - "children": [930] + "children": [933] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 884, + "line": 864, "character": 12 } ] } } }, - { - "id": 931, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 888, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [928, 931] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 883, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 932, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 933, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 890, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, { "id": 934, "name": "error", @@ -22123,13 +24098,75 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 890, + "line": 868, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [931, 934] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 863, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 935, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 936, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 870, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 937, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 870, "character": 18 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -22138,13 +24175,13 @@ { "title": "Properties", "kind": 1024, - "children": [933, 934] + "children": [936, 937] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 890, + "line": 870, "character": 4 } ] @@ -22154,7 +24191,7 @@ } }, { - "id": 897, + "id": 915, "name": "AuthMFAVerifyResponse", "kind": 4194304, "kindString": "Type alias", @@ -22162,7 +24199,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 822, + "line": 835, "character": 12 } ], @@ -22172,14 +24209,14 @@ { "type": "reflection", "declaration": { - "id": 898, + "id": 916, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 899, + "id": 917, "name": "data", "kind": 1024, "kindString": "Property", @@ -22187,21 +24224,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 824, + "line": 837, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 900, + "id": 918, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 901, + "id": 919, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -22212,7 +24249,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 826, + "line": 839, "character": 8 } ], @@ -22222,7 +24259,7 @@ } }, { - "id": 903, + "id": 921, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -22233,7 +24270,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 832, + "line": 845, "character": 8 } ], @@ -22243,7 +24280,7 @@ } }, { - "id": 904, + "id": 922, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -22254,7 +24291,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 835, + "line": 848, "character": 8 } ], @@ -22264,7 +24301,7 @@ } }, { - "id": 902, + "id": 920, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -22275,7 +24312,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 829, + "line": 842, "character": 8 } ], @@ -22285,7 +24322,7 @@ } }, { - "id": 905, + "id": 923, "name": "user", "kind": 1024, "kindString": "Property", @@ -22296,13 +24333,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 838, + "line": 851, "character": 8 } ], "type": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } } @@ -22311,13 +24348,13 @@ { "title": "Properties", "kind": 1024, - "children": [901, 903, 904, 902, 905] + "children": [919, 921, 922, 920, 923] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 824, + "line": 837, "character": 12 } ] @@ -22325,7 +24362,7 @@ } }, { - "id": 906, + "id": 924, "name": "error", "kind": 1024, "kindString": "Property", @@ -22333,7 +24370,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 840, + "line": 853, "character": 6 } ], @@ -22347,13 +24384,13 @@ { "title": "Properties", "kind": 1024, - "children": [899, 906] + "children": [917, 924] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 823, + "line": 836, "character": 4 } ] @@ -22362,14 +24399,14 @@ { "type": "reflection", "declaration": { - "id": 907, + "id": 925, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 908, + "id": 926, "name": "data", "kind": 1024, "kindString": "Property", @@ -22377,7 +24414,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 843, + "line": 856, "character": 6 } ], @@ -22387,7 +24424,7 @@ } }, { - "id": 909, + "id": 927, "name": "error", "kind": 1024, "kindString": "Property", @@ -22395,13 +24432,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 844, + "line": 857, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -22410,13 +24447,13 @@ { "title": "Properties", "kind": 1024, - "children": [908, 909] + "children": [926, 927] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 842, + "line": 855, "character": 4 } ] @@ -22426,19 +24463,19 @@ } }, { - "id": 542, + "id": 559, "name": "AuthOtpResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { "shortText": "AuthOtpResponse is returned when OTP is used.", - "text": "{@see AuthRsponse}\n" + "text": "{@see AuthResponse}\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 129, + "line": 135, "character": 12 } ], @@ -22448,14 +24485,14 @@ { "type": "reflection", "declaration": { - "id": 543, + "id": 560, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 544, + "id": 561, "name": "data", "kind": 1024, "kindString": "Property", @@ -22463,21 +24500,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 545, + "id": 562, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 548, + "id": 565, "name": "messageId", "kind": 1024, "kindString": "Property", @@ -22487,7 +24524,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 41 } ], @@ -22506,7 +24543,7 @@ } }, { - "id": 547, + "id": 564, "name": "session", "kind": 1024, "kindString": "Property", @@ -22514,7 +24551,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 26 } ], @@ -22524,7 +24561,7 @@ } }, { - "id": 546, + "id": 563, "name": "user", "kind": 1024, "kindString": "Property", @@ -22532,7 +24569,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 14 } ], @@ -22546,13 +24583,13 @@ { "title": "Properties", "kind": 1024, - "children": [548, 547, 546] + "children": [565, 564, 563] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 131, + "line": 137, "character": 12 } ] @@ -22560,7 +24597,7 @@ } }, { - "id": 549, + "id": 566, "name": "error", "kind": 1024, "kindString": "Property", @@ -22568,7 +24605,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 132, + "line": 138, "character": 6 } ], @@ -22582,13 +24619,13 @@ { "title": "Properties", "kind": 1024, - "children": [544, 549] + "children": [561, 566] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 136, "character": 4 } ] @@ -22597,773 +24634,14 @@ { "type": "reflection", "declaration": { - "id": 550, + "id": 567, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 551, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 552, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 555, - "name": "messageId", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 41 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 554, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 26 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 553, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [555, 554, 553] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 12 - } - ] - } - } - }, - { - "id": 556, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 136, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [551, 556] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 134, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 515, - "name": "AuthResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 91, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 516, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 517, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 518, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 95, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 618, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 519, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 94, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 656, - "name": "User" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [520, 519] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 12 - } - ] - } - } - }, - { - "id": 521, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 97, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [517, 521] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 92, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 522, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 523, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 524, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 526, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 102, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 525, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [526, 525] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 12 - } - ] - } - } - }, - { - "id": 527, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 104, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [523, 527] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 99, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 528, - "name": "AuthResponsePassword", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 107, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 529, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 530, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 531, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 533, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 618, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 532, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 110, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 656, - "name": "User" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 534, - "name": "weak_password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 112, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 511, - "name": "WeakPassword" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [533, 532, 534] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 12 - } - ] - } - } - }, - { - "id": 535, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 114, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [530, 535] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 536, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 537, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 117, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 538, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 540, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 119, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 539, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 118, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [540, 539] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 117, - "character": 12 - } - ] - } - } - }, - { - "id": 541, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 121, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [537, 541] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 116, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 557, - "name": "AuthTokenResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 139, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 558, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 559, + "id": 568, "name": "data", "kind": 1024, "kindString": "Property", @@ -23378,14 +24656,43 @@ "type": { "type": "reflection", "declaration": { - "id": 560, + "id": 569, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 562, + "id": 572, + "name": "messageId", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 141, + "character": 41 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 571, "name": "session", "kind": 1024, "kindString": "Property", @@ -23393,18 +24700,17 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 143, - "character": 8 + "line": 141, + "character": 26 } ], "type": { - "type": "reference", - "id": 618, - "name": "Session" + "type": "literal", + "value": null } }, { - "id": 561, + "id": 570, "name": "user", "kind": 1024, "kindString": "Property", @@ -23412,14 +24718,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 142, - "character": 8 + "line": 141, + "character": 14 } ], "type": { - "type": "reference", - "id": 656, - "name": "User" + "type": "literal", + "value": null } } ], @@ -23427,7 +24732,7 @@ { "title": "Properties", "kind": 1024, - "children": [562, 561] + "children": [572, 571, 570] } ], "sources": [ @@ -23441,7 +24746,7 @@ } }, { - "id": 563, + "id": 573, "name": "error", "kind": 1024, "kindString": "Property", @@ -23449,7 +24754,167 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 145, + "line": 142, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [568, 573] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 140, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 532, + "name": "AuthResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 97, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 533, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 534, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 99, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 535, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 537, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 101, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 635, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 536, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 675, + "name": "User" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [537, 536] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 99, + "character": 12 + } + ] + } + } + }, + { + "id": 538, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 103, "character": 6 } ], @@ -23463,13 +24928,13 @@ { "title": "Properties", "kind": 1024, - "children": [559, 563] + "children": [534, 538] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 140, + "line": 98, "character": 4 } ] @@ -23478,14 +24943,14 @@ { "type": "reflection", "declaration": { - "id": 564, + "id": 539, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 565, + "id": 540, "name": "data", "kind": 1024, "kindString": "Property", @@ -23493,21 +24958,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 148, + "line": 106, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 566, + "id": 541, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 568, + "id": 543, "name": "session", "kind": 1024, "kindString": "Property", @@ -23515,7 +24980,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 150, + "line": 108, "character": 8 } ], @@ -23525,11 +24990,443 @@ } }, { - "id": 567, + "id": 542, "name": "user", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 107, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [543, 542] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 106, + "character": 12 + } + ] + } + } + }, + { + "id": 544, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 110, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [540, 544] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 105, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 545, + "name": "AuthResponsePassword", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 546, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 547, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 548, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 550, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 117, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 635, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 549, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 116, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 675, + "name": "User" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 551, + "name": "weak_password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 118, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 528, + "name": "WeakPassword" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [550, 549, 551] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 12 + } + ] + } + } + }, + { + "id": 552, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 120, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [547, 552] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 114, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 553, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 554, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 123, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 555, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 557, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 125, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 556, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 124, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [557, 556] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 123, + "character": 12 + } + ] + } + } + }, + { + "id": 558, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 127, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [554, 558] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 122, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 574, + "name": "AuthTokenResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 145, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 575, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 576, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 147, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 577, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 579, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -23537,136 +25434,14 @@ "character": 8 } ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [568, 567] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 148, - "character": 12 - } - ] - } - } - }, - { - "id": 569, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 152, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [565, 569] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 147, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 570, - "name": "AuthTokenResponsePassword", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 155, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 571, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 572, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 573, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 575, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 159, - "character": 8 - } - ], "type": { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } }, { - "id": 574, + "id": 578, "name": "user", "kind": 1024, "kindString": "Property", @@ -23674,49 +25449,28 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 158, + "line": 148, "character": 8 } ], "type": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } - }, - { - "id": 576, - "name": "weakPassword", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 160, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 511, - "name": "WeakPassword" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [575, 574, 576] + "children": [579, 578] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 157, + "line": 147, "character": 12 } ] @@ -23724,7 +25478,7 @@ } }, { - "id": 577, + "id": 580, "name": "error", "kind": 1024, "kindString": "Property", @@ -23732,7 +25486,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 162, + "line": 151, "character": 6 } ], @@ -23746,13 +25500,13 @@ { "title": "Properties", "kind": 1024, - "children": [572, 577] + "children": [576, 580] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 156, + "line": 146, "character": 4 } ] @@ -23761,14 +25515,14 @@ { "type": "reflection", "declaration": { - "id": 578, + "id": 581, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 579, + "id": 582, "name": "data", "kind": 1024, "kindString": "Property", @@ -23776,21 +25530,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 154, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 580, + "id": 583, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 582, + "id": 585, "name": "session", "kind": 1024, "kindString": "Property", @@ -23798,7 +25552,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 167, + "line": 156, "character": 8 } ], @@ -23808,7 +25562,7 @@ } }, { - "id": 581, + "id": 584, "name": "user", "kind": 1024, "kindString": "Property", @@ -23816,27 +25570,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 166, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 583, - "name": "weakPassword", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 168, + "line": 155, "character": 8 } ], @@ -23850,13 +25584,13 @@ { "title": "Properties", "kind": 1024, - "children": [582, 581, 583] + "children": [585, 584] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 154, "character": 12 } ] @@ -23864,7 +25598,7 @@ } }, { - "id": 584, + "id": 586, "name": "error", "kind": 1024, "kindString": "Property", @@ -23872,13 +25606,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 170, + "line": 158, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -23887,13 +25621,13 @@ { "title": "Properties", "kind": 1024, - "children": [579, 584] + "children": [582, 586] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 164, + "line": 153, "character": 4 } ] @@ -23903,7 +25637,310 @@ } }, { - "id": 955, + "id": 587, + "name": "AuthTokenResponsePassword", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 161, + "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": 163, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 590, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 592, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 165, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 635, + "name": "Session" + } + }, + { + "id": 591, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 164, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 675, + "name": "User" + } + }, + { + "id": 593, + "name": "weakPassword", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 166, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 528, + "name": "WeakPassword" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [592, 591, 593] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 163, + "character": 12 + } + ] + } + } + }, + { + "id": 594, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 168, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [589, 594] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 162, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 595, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 596, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 171, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 597, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 599, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 173, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 598, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 172, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 600, + "name": "weakPassword", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 174, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [599, 598, 600] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 171, + "character": 12 + } + ] + } + } + }, + { + "id": 601, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 176, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [596, 601] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 170, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 960, "name": "AuthenticatorAssuranceLevels", "kind": 4194304, "kindString": "Type alias", @@ -23911,7 +25948,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 918, + "line": 903, "character": 12 } ], @@ -23930,7 +25967,7 @@ } }, { - "id": 1025, + "id": 1034, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -23938,7 +25975,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1104, + "line": 1091, "character": 12 } ], @@ -23948,14 +25985,14 @@ { "type": "reflection", "declaration": { - "id": 1026, + "id": 1035, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1028, + "id": 1037, "name": "error", "kind": 1024, "kindString": "Property", @@ -23963,7 +26000,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1107, + "line": 1094, "character": 6 } ], @@ -23973,7 +26010,7 @@ } }, { - "id": 1027, + "id": 1036, "name": "session", "kind": 1024, "kindString": "Property", @@ -23981,13 +26018,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1106, + "line": 1093, "character": 6 } ], "type": { "type": "reference", - "id": 618, + "id": 635, "name": "Session" } } @@ -23996,13 +26033,13 @@ { "title": "Properties", "kind": 1024, - "children": [1028, 1027] + "children": [1037, 1036] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1105, + "line": 1092, "character": 4 } ] @@ -24011,14 +26048,14 @@ { "type": "reflection", "declaration": { - "id": 1029, + "id": 1038, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1031, + "id": 1040, "name": "error", "kind": 1024, "kindString": "Property", @@ -24026,18 +26063,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1111, + "line": 1098, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } }, { - "id": 1030, + "id": 1039, "name": "session", "kind": 1024, "kindString": "Property", @@ -24045,7 +26082,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1110, + "line": 1097, "character": 6 } ], @@ -24059,13 +26096,13 @@ { "title": "Properties", "kind": 1024, - "children": [1031, 1030] + "children": [1040, 1039] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1109, + "line": 1096, "character": 4 } ] @@ -24075,7 +26112,7 @@ } }, { - "id": 802, + "id": 823, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -24083,7 +26120,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 662, "character": 12 } ], @@ -24118,7 +26155,7 @@ } }, { - "id": 846, + "id": 867, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -24126,21 +26163,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 847, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 849, + "id": 870, "name": "email", "kind": 1024, "kindString": "Property", @@ -24151,7 +26188,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 714, + "line": 732, "character": 2 } ], @@ -24161,7 +26198,7 @@ } }, { - "id": 850, + "id": 871, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -24172,7 +26209,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 718, + "line": 736, "character": 2 } ], @@ -24182,7 +26219,7 @@ } }, { - "id": 851, + "id": 872, "name": "options", "kind": 1024, "kindString": "Property", @@ -24192,7 +26229,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 719, + "line": 737, "character": 2 } ], @@ -24201,7 +26238,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -24215,7 +26252,7 @@ } }, { - "id": 848, + "id": 869, "name": "type", "kind": 1024, "kindString": "Property", @@ -24223,7 +26260,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 712, + "line": 730, "character": 2 } ], @@ -24246,13 +26283,13 @@ { "title": "Properties", "kind": 1024, - "children": [849, 850, 851, 848] + "children": [870, 871, 872, 869] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 44 } ] @@ -24260,7 +26297,7 @@ } }, { - "id": 836, + "id": 857, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -24268,21 +26305,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 837, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 839, + "id": 860, "name": "email", "kind": 1024, "kindString": "Property", @@ -24293,7 +26330,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 700, + "line": 718, "character": 2 } ], @@ -24303,7 +26340,7 @@ } }, { - "id": 840, + "id": 861, "name": "options", "kind": 1024, "kindString": "Property", @@ -24313,7 +26350,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 701, + "line": 719, "character": 2 } ], @@ -24322,7 +26359,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -24345,7 +26382,7 @@ } }, { - "id": 838, + "id": 859, "name": "type", "kind": 1024, "kindString": "Property", @@ -24353,7 +26390,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 698, + "line": 716, "character": 2 } ], @@ -24376,13 +26413,13 @@ { "title": "Properties", "kind": 1024, - "children": [839, 840, 838] + "children": [860, 861, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 46 } ] @@ -24390,7 +26427,7 @@ } }, { - "id": 855, + "id": 876, "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -24398,7 +26435,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 733, + "line": 751, "character": 12 } ], @@ -24406,7 +26443,7 @@ "type": "union", "types": [ { - "id": 830, + "id": 851, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -24414,21 +26451,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 831, + "id": 852, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 854, "name": "email", "kind": 1024, "kindString": "Property", @@ -24436,7 +26473,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 692, + "line": 710, "character": 2 } ], @@ -24446,7 +26483,7 @@ } }, { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -24456,7 +26493,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 694, + "line": 712, "character": 2 } ], @@ -24465,7 +26502,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -24488,7 +26525,7 @@ } }, { - "id": 834, + "id": 855, "name": "password", "kind": 1024, "kindString": "Property", @@ -24496,7 +26533,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 693, + "line": 711, "character": 2 } ], @@ -24506,7 +26543,7 @@ } }, { - "id": 832, + "id": 853, "name": "type", "kind": 1024, "kindString": "Property", @@ -24514,7 +26551,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 691, + "line": 709, "character": 2 } ], @@ -24528,13 +26565,13 @@ { "title": "Properties", "kind": 1024, - "children": [833, 835, 834, 832] + "children": [854, 856, 855, 853] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 39 } ] @@ -24542,7 +26579,7 @@ } }, { - "id": 836, + "id": 857, "name": "GenerateInviteOrMagiclinkParams", "kind": 4194304, "kindString": "Type alias", @@ -24550,21 +26587,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 837, + "id": 858, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 839, + "id": 860, "name": "email", "kind": 1024, "kindString": "Property", @@ -24575,7 +26612,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 700, + "line": 718, "character": 2 } ], @@ -24585,7 +26622,7 @@ } }, { - "id": 840, + "id": 861, "name": "options", "kind": 1024, "kindString": "Property", @@ -24595,7 +26632,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 701, + "line": 719, "character": 2 } ], @@ -24604,7 +26641,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -24627,7 +26664,7 @@ } }, { - "id": 838, + "id": 859, "name": "type", "kind": 1024, "kindString": "Property", @@ -24635,7 +26672,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 698, + "line": 716, "character": 2 } ], @@ -24658,13 +26695,13 @@ { "title": "Properties", "kind": 1024, - "children": [839, 840, 838] + "children": [860, 861, 859] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 697, + "line": 715, "character": 46 } ] @@ -24672,7 +26709,7 @@ } }, { - "id": 841, + "id": 862, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -24680,21 +26717,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "email", "kind": 1024, "kindString": "Property", @@ -24705,7 +26742,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 707, + "line": 725, "character": 2 } ], @@ -24715,7 +26752,7 @@ } }, { - "id": 845, + "id": 866, "name": "options", "kind": 1024, "kindString": "Property", @@ -24725,7 +26762,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 708, + "line": 726, "character": 2 } ], @@ -24734,7 +26771,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -24748,7 +26785,7 @@ } }, { - "id": 843, + "id": 864, "name": "type", "kind": 1024, "kindString": "Property", @@ -24756,7 +26793,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 705, + "line": 723, "character": 2 } ], @@ -24770,13 +26807,13 @@ { "title": "Properties", "kind": 1024, - "children": [844, 845, 843] + "children": [865, 866, 864] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 41 } ] @@ -24784,7 +26821,7 @@ } }, { - "id": 846, + "id": 867, "name": "GenerateEmailChangeLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -24792,21 +26829,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 847, + "id": 868, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 849, + "id": 870, "name": "email", "kind": 1024, "kindString": "Property", @@ -24817,7 +26854,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 714, + "line": 732, "character": 2 } ], @@ -24827,7 +26864,7 @@ } }, { - "id": 850, + "id": 871, "name": "newEmail", "kind": 1024, "kindString": "Property", @@ -24838,7 +26875,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 718, + "line": 736, "character": 2 } ], @@ -24848,7 +26885,7 @@ } }, { - "id": 851, + "id": 872, "name": "options", "kind": 1024, "kindString": "Property", @@ -24858,7 +26895,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 719, + "line": 737, "character": 2 } ], @@ -24867,7 +26904,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -24881,7 +26918,7 @@ } }, { - "id": 848, + "id": 869, "name": "type", "kind": 1024, "kindString": "Property", @@ -24889,7 +26926,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 712, + "line": 730, "character": 2 } ], @@ -24912,13 +26949,13 @@ { "title": "Properties", "kind": 1024, - "children": [849, 850, 851, 848] + "children": [870, 871, 872, 869] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 711, + "line": 729, "character": 44 } ] @@ -24929,7 +26966,7 @@ } }, { - "id": 869, + "id": 890, "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", @@ -24940,21 +26977,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 756, + "line": 774, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 870, + "id": 891, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 871, + "id": 892, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -24965,7 +27002,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 761, + "line": 779, "character": 2 } ], @@ -24975,7 +27012,7 @@ } }, { - "id": 872, + "id": 893, "name": "email_otp", "kind": 1024, "kindString": "Property", @@ -24986,7 +27023,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 766, + "line": 784, "character": 2 } ], @@ -24996,7 +27033,7 @@ } }, { - "id": 873, + "id": 894, "name": "hashed_token", "kind": 1024, "kindString": "Property", @@ -25007,7 +27044,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 770, + "line": 788, "character": 2 } ], @@ -25017,7 +27054,7 @@ } }, { - "id": 874, + "id": 895, "name": "redirect_to", "kind": 1024, "kindString": "Property", @@ -25028,7 +27065,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 772, + "line": 790, "character": 2 } ], @@ -25038,7 +27075,7 @@ } }, { - "id": 875, + "id": 896, "name": "verification_type", "kind": 1024, "kindString": "Property", @@ -25049,16 +27086,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 774, + "line": 792, "character": 2 } ], "type": { "type": "reference", - "id": 876, + "id": 897, "name": "GenerateLinkType", "dereferenced": { - "id": 876, + "id": 897, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -25066,7 +27103,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 777, + "line": 795, "character": 12 } ], @@ -25107,13 +27144,13 @@ { "title": "Properties", "kind": 1024, - "children": [871, 872, 873, 874, 875] + "children": [892, 893, 894, 895, 896] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 756, + "line": 774, "character": 37 } ] @@ -25121,7 +27158,7 @@ } }, { - "id": 856, + "id": 877, "name": "GenerateLinkResponse", "kind": 4194304, "kindString": "Type alias", @@ -25129,7 +27166,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 739, + "line": 757, "character": 12 } ], @@ -25139,14 +27176,14 @@ { "type": "reflection", "declaration": { - "id": 857, + "id": 878, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 858, + "id": 879, "name": "data", "kind": 1024, "kindString": "Property", @@ -25154,21 +27191,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 741, + "line": 759, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 859, + "id": 880, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 860, + "id": 881, "name": "properties", "kind": 1024, "kindString": "Property", @@ -25176,18 +27213,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 742, + "line": 760, "character": 8 } ], "type": { "type": "reference", - "id": 869, + "id": 890, "name": "GenerateLinkProperties" } }, { - "id": 861, + "id": 882, "name": "user", "kind": 1024, "kindString": "Property", @@ -25195,13 +27232,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 743, + "line": 761, "character": 8 } ], "type": { "type": "reference", - "id": 656, + "id": 675, "name": "User" } } @@ -25210,13 +27247,13 @@ { "title": "Properties", "kind": 1024, - "children": [860, 861] + "children": [881, 882] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 741, + "line": 759, "character": 12 } ] @@ -25224,7 +27261,7 @@ } }, { - "id": 862, + "id": 883, "name": "error", "kind": 1024, "kindString": "Property", @@ -25232,7 +27269,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 745, + "line": 763, "character": 6 } ], @@ -25246,13 +27283,13 @@ { "title": "Properties", "kind": 1024, - "children": [858, 862] + "children": [879, 883] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 740, + "line": 758, "character": 4 } ] @@ -25261,14 +27298,14 @@ { "type": "reflection", "declaration": { - "id": 863, + "id": 884, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 864, + "id": 885, "name": "data", "kind": 1024, "kindString": "Property", @@ -25276,21 +27313,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 748, + "line": 766, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 865, + "id": 886, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 866, + "id": 887, "name": "properties", "kind": 1024, "kindString": "Property", @@ -25298,7 +27335,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 749, + "line": 767, "character": 8 } ], @@ -25308,7 +27345,7 @@ } }, { - "id": 867, + "id": 888, "name": "user", "kind": 1024, "kindString": "Property", @@ -25316,7 +27353,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 750, + "line": 768, "character": 8 } ], @@ -25330,13 +27367,13 @@ { "title": "Properties", "kind": 1024, - "children": [866, 867] + "children": [887, 888] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 748, + "line": 766, "character": 12 } ] @@ -25344,7 +27381,7 @@ } }, { - "id": 868, + "id": 889, "name": "error", "kind": 1024, "kindString": "Property", @@ -25352,13 +27389,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 752, + "line": 770, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -25367,13 +27404,13 @@ { "title": "Properties", "kind": 1024, - "children": [864, 868] + "children": [885, 889] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 747, + "line": 765, "character": 4 } ] @@ -25383,7 +27420,7 @@ } }, { - "id": 876, + "id": 897, "name": "GenerateLinkType", "kind": 4194304, "kindString": "Type alias", @@ -25391,7 +27428,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 777, + "line": 795, "character": 12 } ], @@ -25426,7 +27463,7 @@ } }, { - "id": 841, + "id": 862, "name": "GenerateRecoveryLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -25434,21 +27471,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 842, + "id": 863, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 844, + "id": 865, "name": "email", "kind": 1024, "kindString": "Property", @@ -25459,7 +27496,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 707, + "line": 725, "character": 2 } ], @@ -25469,7 +27506,7 @@ } }, { - "id": 845, + "id": 866, "name": "options", "kind": 1024, "kindString": "Property", @@ -25479,7 +27516,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 708, + "line": 726, "character": 2 } ], @@ -25488,7 +27525,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -25502,7 +27539,7 @@ } }, { - "id": 843, + "id": 864, "name": "type", "kind": 1024, "kindString": "Property", @@ -25510,7 +27547,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 705, + "line": 723, "character": 2 } ], @@ -25524,13 +27561,13 @@ { "title": "Properties", "kind": 1024, - "children": [844, 845, 843] + "children": [865, 866, 864] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 704, + "line": 722, "character": 41 } ] @@ -25538,7 +27575,7 @@ } }, { - "id": 830, + "id": 851, "name": "GenerateSignupLinkParams", "kind": 4194304, "kindString": "Type alias", @@ -25546,21 +27583,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 831, + "id": 852, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 833, + "id": 854, "name": "email", "kind": 1024, "kindString": "Property", @@ -25568,7 +27605,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 692, + "line": 710, "character": 2 } ], @@ -25578,7 +27615,7 @@ } }, { - "id": 835, + "id": 856, "name": "options", "kind": 1024, "kindString": "Property", @@ -25588,7 +27625,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 694, + "line": 712, "character": 2 } ], @@ -25597,7 +27634,7 @@ "typeArguments": [ { "type": "reference", - "id": 852, + "id": 873, "name": "GenerateLinkOptions" }, { @@ -25620,7 +27657,7 @@ } }, { - "id": 834, + "id": 855, "name": "password", "kind": 1024, "kindString": "Property", @@ -25628,7 +27665,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 693, + "line": 711, "character": 2 } ], @@ -25638,7 +27675,7 @@ } }, { - "id": 832, + "id": 853, "name": "type", "kind": 1024, "kindString": "Property", @@ -25646,7 +27683,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 691, + "line": 709, "character": 2 } ], @@ -25660,13 +27697,13 @@ { "title": "Properties", "kind": 1024, - "children": [833, 835, 834, 832] + "children": [854, 856, 855, 853] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 690, + "line": 708, "character": 39 } ] @@ -25674,7 +27711,7 @@ } }, { - "id": 490, + "id": 505, "name": "GoTrueClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -25682,21 +27719,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 491, + "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 499, + "id": 514, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -25706,7 +27743,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 66, + "line": 67, "character": 2 } ], @@ -25716,7 +27753,7 @@ } }, { - "id": 504, + "id": 519, "name": "debug", "kind": 1024, "kindString": "Property", @@ -25726,7 +27763,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 76, + "line": 77, "character": 2 } ], @@ -25740,7 +27777,7 @@ { "type": "reflection", "declaration": { - "id": 505, + "id": 520, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -25748,20 +27785,20 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 76, + "line": 77, "character": 21 } ], "signatures": [ { - "id": 506, + "id": 521, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 522, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -25772,7 +27809,7 @@ } }, { - "id": 508, + "id": 523, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -25800,7 +27837,7 @@ } }, { - "id": 498, + "id": 513, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -25810,7 +27847,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 65, "character": 2 } ], @@ -25820,7 +27857,7 @@ } }, { - "id": 502, + "id": 517, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -25830,7 +27867,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 72, + "line": 73, "character": 2 } ], @@ -25840,7 +27877,7 @@ } }, { - "id": 503, + "id": 518, "name": "flowType", "kind": 1024, "kindString": "Property", @@ -25850,16 +27887,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 75, "character": 2 } ], "type": { "type": "reference", - "id": 759, + "id": 779, "name": "AuthFlowType", "dereferenced": { - "id": 759, + "id": 779, "name": "AuthFlowType", "kind": 4194304, "kindString": "Type alias", @@ -25867,7 +27904,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 565, + "line": 583, "character": 12 } ], @@ -25888,7 +27925,36 @@ } }, { - "id": 493, + "id": 525, + "name": "hasCustomAuthorizationHeader", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Set to \"true\" if there is a custom authorization header set globally.", + "tags": [ + { + "tag": "experimental", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 508, "name": "headers", "kind": 1024, "kindString": "Property", @@ -25898,14 +27964,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 61, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 494, + "id": 509, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -25913,19 +27979,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 61, "character": 12 } ], "indexSignature": { - "id": 495, + "id": 510, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 496, + "id": 511, "name": "key", "kind": 32768, "flags": {}, @@ -25944,7 +28010,7 @@ } }, { - "id": 509, + "id": 524, "name": "lock", "kind": 1024, "kindString": "Property", @@ -25963,16 +28029,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 83, "character": 2 } ], "type": { "type": "reference", - "id": 481, + "id": 496, "name": "LockFunc", "dereferenced": { - "id": 481, + "id": 496, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -25980,14 +28046,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 482, + "id": 497, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -25995,13 +28061,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 23 } ], "signatures": [ { - "id": 483, + "id": 498, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -26017,7 +28083,7 @@ }, "typeParameter": [ { - "id": 489, + "id": 504, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -26026,7 +28092,7 @@ ], "parameters": [ { - "id": 484, + "id": 499, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -26040,7 +28106,7 @@ } }, { - "id": 485, + "id": 500, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -26054,7 +28120,7 @@ } }, { - "id": 486, + "id": 501, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -26065,7 +28131,7 @@ "type": { "type": "reflection", "declaration": { - "id": 487, + "id": 502, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -26073,13 +28139,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 69 } ], "signatures": [ { - "id": 488, + "id": 503, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -26089,7 +28155,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -26108,7 +28174,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -26124,7 +28190,7 @@ } }, { - "id": 500, + "id": 515, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -26134,7 +28200,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 68, + "line": 69, "character": 2 } ], @@ -26144,7 +28210,7 @@ } }, { - "id": 501, + "id": 516, "name": "storage", "kind": 1024, "kindString": "Property", @@ -26154,16 +28220,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 71, "character": 2 } ], "type": { "type": "reference", - "id": 1019, + "id": 1028, "name": "SupportedStorage", "dereferenced": { - "id": 1019, + "id": 1028, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -26171,7 +28237,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1089, + "line": 1076, "character": 12 } ], @@ -26218,14 +28284,14 @@ { "type": "reflection", "declaration": { - "id": 1020, + "id": 1029, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1021, + "id": 1030, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -26238,7 +28304,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1099, + "line": 1086, "character": 2 } ], @@ -26252,13 +28318,13 @@ { "title": "Properties", "kind": 1024, - "children": [1021] + "children": [1030] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1091, + "line": 1078, "character": 4 } ] @@ -26270,7 +28336,7 @@ } }, { - "id": 497, + "id": 512, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -26280,7 +28346,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 62, + "line": 63, "character": 2 } ], @@ -26290,7 +28356,7 @@ } }, { - "id": 492, + "id": 507, "name": "url", "kind": 1024, "kindString": "Property", @@ -26300,7 +28366,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, + "line": 59, "character": 2 } ], @@ -26314,13 +28380,13 @@ { "title": "Properties", "kind": 1024, - "children": [499, 504, 498, 502, 503, 493, 509, 500, 501, 497, 492] + "children": [514, 519, 513, 517, 518, 525, 508, 524, 515, 516, 512, 507] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 34 } ] @@ -26328,7 +28394,7 @@ } }, { - "id": 1022, + "id": 1031, "name": "InitializeResult", "kind": 4194304, "kindString": "Type alias", @@ -26336,21 +28402,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1102, + "line": 1089, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1023, + "id": 1032, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1024, + "id": 1033, "name": "error", "kind": 1024, "kindString": "Property", @@ -26358,7 +28424,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1102, + "line": 1089, "character": 33 } ], @@ -26367,7 +28433,7 @@ "types": [ { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" }, { @@ -26382,13 +28448,13 @@ { "title": "Properties", "kind": 1024, - "children": [1024] + "children": [1033] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1102, + "line": 1089, "character": 31 } ] @@ -26396,7 +28462,7 @@ } }, { - "id": 481, + "id": 496, "name": "LockFunc", "kind": 4194304, "kindString": "Type alias", @@ -26404,14 +28470,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 482, + "id": 497, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -26419,13 +28485,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 23 } ], "signatures": [ { - "id": 483, + "id": 498, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -26441,7 +28507,7 @@ }, "typeParameter": [ { - "id": 489, + "id": 504, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -26450,7 +28516,7 @@ ], "parameters": [ { - "id": 484, + "id": 499, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -26464,7 +28530,7 @@ } }, { - "id": 485, + "id": 500, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -26478,7 +28544,7 @@ } }, { - "id": 486, + "id": 501, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -26489,7 +28555,7 @@ "type": { "type": "reflection", "declaration": { - "id": 487, + "id": 502, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -26497,13 +28563,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 69 } ], "signatures": [ { - "id": 488, + "id": 503, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -26513,7 +28579,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -26532,7 +28598,7 @@ "typeArguments": [ { "type": "reference", - "id": 489, + "id": 504, "name": "R" } ], @@ -26546,7 +28612,7 @@ } }, { - "id": 893, + "id": 911, "name": "MFAChallengeAndVerifyParams", "kind": 4194304, "kindString": "Type alias", @@ -26554,21 +28620,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 894, + "id": 912, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 896, + "id": 914, "name": "code", "kind": 1024, "kindString": "Property", @@ -26579,7 +28645,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 819, + "line": 832, "character": 2 } ], @@ -26589,7 +28655,7 @@ } }, { - "id": 895, + "id": 913, "name": "factorId", "kind": 1024, "kindString": "Property", @@ -26600,7 +28666,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 817, + "line": 830, "character": 2 } ], @@ -26614,13 +28680,13 @@ { "title": "Properties", "kind": 1024, - "children": [896, 895] + "children": [914, 913] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 815, + "line": 828, "character": 42 } ] @@ -26628,11 +28694,608 @@ } }, { - "id": 890, + "id": 907, "name": "MFAChallengeParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 821, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 908, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 910, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 825, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 909, + "name": "factorId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor to be challenged. Returned in enroll()." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 823, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [910, 909] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 821, + "character": 33 + } + ] + } + } + }, + { + "id": 898, + "name": "MFAEnrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 803, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "id": 1055, + "name": "MFAEnrollTOTPParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1056, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1057, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1131, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + }, + { + "id": 1059, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1135, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1058, + "name": "issuer", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Domain which the user is enrolled with." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1133, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1057, 1059, 1058] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 34 + } + ] + } + } + }, + { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + } + ] + } + }, + { + "id": 1060, + "name": "MFAEnrollPhoneParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1061, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1062, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1139, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "phone" + } + }, + { + "id": 1063, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1064, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Phone number associated with a factor. Number should conform to E.164 format" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1062, 1063, 1064] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1137, + "character": 35 + } + ] + } + } + }, + { + "id": 1055, + "name": "MFAEnrollTOTPParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1056, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 1057, + "name": "factorType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The type of factor being enrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1131, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "totp" + } + }, + { + "id": 1059, + "name": "friendlyName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Human readable name assigned to the factor." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1135, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1058, + "name": "issuer", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Domain which the user is enrolled with." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1133, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [1057, 1059, 1058] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 1129, + "character": 34 + } + ] + } + } + }, + { + "id": 899, + "name": "MFAUnenrollParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 805, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 900, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 901, + "name": "factorId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the factor being unenrolled." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 807, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [901] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 805, + "character": 32 + } + ] + } + } + }, + { + "id": 902, + "name": "MFAVerifyParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -26643,20 +29306,62 @@ "type": { "type": "reflection", "declaration": { - "id": 891, + "id": 903, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 892, + "id": 905, + "name": "challengeId", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "ID of the challenge being verified. Returned in challenge()." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 815, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 906, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "Verification code provided by the user." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 818, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 904, "name": "factorId", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "ID of the factor to be challenged. Returned in enroll()." + "shortText": "ID of the factor being verified. Returned in enroll()." }, "sources": [ { @@ -26675,120 +29380,13 @@ { "title": "Properties", "kind": 1024, - "children": [892] + "children": [905, 906, 904] } ], "sources": [ { "fileName": "src/lib/types.ts", "line": 810, - "character": 33 - } - ] - } - } - }, - { - "id": 877, - "name": "MFAEnrollParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 785, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 878, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 879, - "name": "factorType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The type of factor being enrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 787, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - }, - { - "id": 881, - "name": "friendlyName", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Human readable name assigned to the factor." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 791, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 880, - "name": "issuer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Domain which the user is enrolled with." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 789, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [879, 881, 880] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 785, "character": 30 } ] @@ -26796,171 +29394,7 @@ } }, { - "id": 882, - "name": "MFAUnenrollParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 794, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 883, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 884, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being unenrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 796, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [884] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 794, - "character": 32 - } - ] - } - } - }, - { - "id": 885, - "name": "MFAVerifyParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 799, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 886, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 888, - "name": "challengeId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the challenge being verified. Returned in challenge()." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 804, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 889, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Verification code provided by the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 807, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 887, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being verified. Returned in enroll()." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 801, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [888, 889, 887] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 799, - "character": 30 - } - ] - } - } - }, - { - "id": 801, + "id": 822, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -26968,7 +29402,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 643, + "line": 661, "character": 12 } ], @@ -26987,7 +29421,7 @@ } }, { - "id": 585, + "id": 602, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -26995,7 +29429,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 173, + "line": 179, "character": 12 } ], @@ -27005,14 +29439,14 @@ { "type": "reflection", "declaration": { - "id": 586, + "id": 603, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 587, + "id": 604, "name": "data", "kind": 1024, "kindString": "Property", @@ -27020,21 +29454,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 175, + "line": 181, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 588, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 589, + "id": 606, "name": "provider", "kind": 1024, "kindString": "Property", @@ -27042,18 +29476,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 176, + "line": 182, "character": 8 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider" } }, { - "id": 590, + "id": 607, "name": "url", "kind": 1024, "kindString": "Property", @@ -27061,7 +29495,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 177, + "line": 183, "character": 8 } ], @@ -27075,13 +29509,13 @@ { "title": "Properties", "kind": 1024, - "children": [589, 590] + "children": [606, 607] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 175, + "line": 181, "character": 12 } ] @@ -27089,7 +29523,7 @@ } }, { - "id": 591, + "id": 608, "name": "error", "kind": 1024, "kindString": "Property", @@ -27097,7 +29531,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 179, + "line": 185, "character": 6 } ], @@ -27111,13 +29545,13 @@ { "title": "Properties", "kind": 1024, - "children": [587, 591] + "children": [604, 608] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 174, + "line": 180, "character": 4 } ] @@ -27126,14 +29560,14 @@ { "type": "reflection", "declaration": { - "id": 592, + "id": 609, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 593, + "id": 610, "name": "data", "kind": 1024, "kindString": "Property", @@ -27141,21 +29575,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 182, + "line": 188, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 594, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 595, + "id": 612, "name": "provider", "kind": 1024, "kindString": "Property", @@ -27163,18 +29597,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 183, + "line": 189, "character": 8 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider" } }, { - "id": 596, + "id": 613, "name": "url", "kind": 1024, "kindString": "Property", @@ -27182,7 +29616,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 184, + "line": 190, "character": 8 } ], @@ -27196,13 +29630,13 @@ { "title": "Properties", "kind": 1024, - "children": [595, 596] + "children": [612, 613] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 182, + "line": 188, "character": 12 } ] @@ -27210,7 +29644,7 @@ } }, { - "id": 597, + "id": 614, "name": "error", "kind": 1024, "kindString": "Property", @@ -27218,13 +29652,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 186, + "line": 192, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -27233,13 +29667,13 @@ { "title": "Properties", "kind": 1024, - "children": [593, 597] + "children": [610, 614] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 181, + "line": 187, "character": 4 } ] @@ -27249,7 +29683,7 @@ } }, { - "id": 1039, + "id": 1048, "name": "PageParams", "kind": 4194304, "kindString": "Type alias", @@ -27257,21 +29691,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1040, + "id": 1049, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1041, + "id": 1050, "name": "page", "kind": 1024, "kindString": "Property", @@ -27284,7 +29718,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1123, + "line": 1110, "character": 2 } ], @@ -27294,7 +29728,7 @@ } }, { - "id": 1042, + "id": 1051, "name": "perPage", "kind": 1024, "kindString": "Property", @@ -27307,7 +29741,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1125, + "line": 1112, "character": 2 } ], @@ -27321,13 +29755,13 @@ { "title": "Properties", "kind": 1024, - "children": [1041, 1042] + "children": [1050, 1051] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1121, + "line": 1108, "character": 25 } ] @@ -27335,7 +29769,7 @@ } }, { - "id": 1032, + "id": 1041, "name": "Pagination", "kind": 4194304, "kindString": "Type alias", @@ -27343,21 +29777,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1114, + "line": 1101, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1033, + "id": 1042, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1035, + "id": 1044, "name": "lastPage", "kind": 1024, "kindString": "Property", @@ -27365,7 +29799,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1117, + "line": 1104, "character": 2 } ], @@ -27375,7 +29809,7 @@ } }, { - "id": 1034, + "id": 1043, "name": "nextPage", "kind": 1024, "kindString": "Property", @@ -27383,7 +29817,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1116, + "line": 1103, "character": 2 } ], @@ -27402,7 +29836,7 @@ } }, { - "id": 1036, + "id": 1045, "name": "total", "kind": 1024, "kindString": "Property", @@ -27410,7 +29844,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1118, + "line": 1105, "character": 2 } ], @@ -27424,25 +29858,25 @@ { "title": "Properties", "kind": 1024, - "children": [1035, 1034, 1036] + "children": [1044, 1043, 1045] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1114, + "line": 1101, "character": 25 } ], "indexSignature": { - "id": 1037, + "id": 1046, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1038, + "id": 1047, "name": "key", "kind": 32768, "flags": {}, @@ -27461,7 +29895,7 @@ } }, { - "id": 478, + "id": 493, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -27539,6 +29973,10 @@ "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -27567,7 +30005,7 @@ } }, { - "id": 803, + "id": 824, "name": "ResendParams", "kind": 4194304, "kindString": "Type alias", @@ -27575,7 +30013,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 646, + "line": 664, "character": 12 } ], @@ -27585,14 +30023,14 @@ { "type": "reflection", "declaration": { - "id": 804, + "id": 825, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 806, + "id": 827, "name": "email", "kind": 1024, "kindString": "Property", @@ -27600,7 +30038,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 649, + "line": 667, "character": 6 } ], @@ -27610,7 +30048,7 @@ } }, { - "id": 807, + "id": 828, "name": "options", "kind": 1024, "kindString": "Property", @@ -27620,21 +30058,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 650, + "line": 668, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 808, + "id": 829, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 810, + "id": 831, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -27647,7 +30085,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 654, + "line": 672, "character": 8 } ], @@ -27657,7 +30095,7 @@ } }, { - "id": 809, + "id": 830, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -27670,7 +30108,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 652, + "line": 670, "character": 8 } ], @@ -27684,13 +30122,13 @@ { "title": "Properties", "kind": 1024, - "children": [810, 809] + "children": [831, 830] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 650, + "line": 668, "character": 16 } ] @@ -27698,7 +30136,7 @@ } }, { - "id": 805, + "id": 826, "name": "type", "kind": 1024, "kindString": "Property", @@ -27706,7 +30144,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 648, + "line": 666, "character": 6 } ], @@ -27715,7 +30153,7 @@ "typeArguments": [ { "type": "reference", - "id": 802, + "id": 823, "name": "EmailOtpType" }, { @@ -27742,13 +30180,13 @@ { "title": "Properties", "kind": 1024, - "children": [806, 807, 805] + "children": [827, 828, 826] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 647, + "line": 665, "character": 4 } ] @@ -27757,14 +30195,14 @@ { "type": "reflection", "declaration": { - "id": 811, + "id": 832, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 814, + "id": 835, "name": "options", "kind": 1024, "kindString": "Property", @@ -27774,21 +30212,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 660, + "line": 678, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 815, + "id": 836, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 816, + "id": 837, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -27801,7 +30239,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 662, + "line": 680, "character": 8 } ], @@ -27815,13 +30253,13 @@ { "title": "Properties", "kind": 1024, - "children": [816] + "children": [837] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 660, + "line": 678, "character": 16 } ] @@ -27829,7 +30267,7 @@ } }, { - "id": 813, + "id": 834, "name": "phone", "kind": 1024, "kindString": "Property", @@ -27837,7 +30275,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 659, + "line": 677, "character": 6 } ], @@ -27847,7 +30285,7 @@ } }, { - "id": 812, + "id": 833, "name": "type", "kind": 1024, "kindString": "Property", @@ -27855,7 +30293,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 658, + "line": 676, "character": 6 } ], @@ -27864,7 +30302,7 @@ "typeArguments": [ { "type": "reference", - "id": 801, + "id": 822, "name": "MobileOtpType" }, { @@ -27891,13 +30329,13 @@ { "title": "Properties", "kind": 1024, - "children": [814, 813, 812] + "children": [835, 834, 833] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 657, + "line": 675, "character": 4 } ] @@ -27907,7 +30345,7 @@ } }, { - "id": 598, + "id": 615, "name": "SSOResponse", "kind": 4194304, "kindString": "Type alias", @@ -27915,7 +30353,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 189, + "line": 195, "character": 12 } ], @@ -27925,14 +30363,14 @@ { "type": "reflection", "declaration": { - "id": 599, + "id": 616, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 600, + "id": 617, "name": "data", "kind": 1024, "kindString": "Property", @@ -27940,21 +30378,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 191, + "line": 197, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 601, + "id": 618, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 602, + "id": 619, "name": "url", "kind": 1024, "kindString": "Property", @@ -27966,7 +30404,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 199, + "line": 205, "character": 8 } ], @@ -27980,13 +30418,13 @@ { "title": "Properties", "kind": 1024, - "children": [602] + "children": [619] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 191, + "line": 197, "character": 12 } ] @@ -27994,7 +30432,7 @@ } }, { - "id": 603, + "id": 620, "name": "error", "kind": 1024, "kindString": "Property", @@ -28002,7 +30440,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 201, + "line": 207, "character": 6 } ], @@ -28016,13 +30454,13 @@ { "title": "Properties", "kind": 1024, - "children": [600, 603] + "children": [617, 620] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 190, + "line": 196, "character": 4 } ] @@ -28031,14 +30469,14 @@ { "type": "reflection", "declaration": { - "id": 604, + "id": 621, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 605, + "id": 622, "name": "data", "kind": 1024, "kindString": "Property", @@ -28046,7 +30484,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 204, + "line": 210, "character": 6 } ], @@ -28056,7 +30494,7 @@ } }, { - "id": 606, + "id": 623, "name": "error", "kind": 1024, "kindString": "Property", @@ -28064,13 +30502,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 205, + "line": 211, "character": 6 } ], "type": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -28079,13 +30517,13 @@ { "title": "Properties", "kind": 1024, - "children": [605, 606] + "children": [622, 623] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 203, + "line": 209, "character": 4 } ] @@ -28095,7 +30533,7 @@ } }, { - "id": 706, + "id": 726, "name": "SignInAnonymouslyCredentials", "kind": 4194304, "kindString": "Type alias", @@ -28103,21 +30541,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 473, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 707, + "id": 727, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 708, + "id": 728, "name": "options", "kind": 1024, "kindString": "Property", @@ -28127,21 +30565,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 456, + "line": 474, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 709, + "id": 729, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 711, + "id": 731, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -28154,7 +30592,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 464, + "line": 482, "character": 4 } ], @@ -28164,7 +30602,7 @@ } }, { - "id": 710, + "id": 730, "name": "data", "kind": 1024, "kindString": "Property", @@ -28178,7 +30616,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 462, + "line": 480, "character": 4 } ], @@ -28192,13 +30630,13 @@ { "title": "Properties", "kind": 1024, - "children": [711, 710] + "children": [731, 730] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 456, + "line": 474, "character": 12 } ] @@ -28210,13 +30648,13 @@ { "title": "Properties", "kind": 1024, - "children": [708] + "children": [728] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 455, + "line": 473, "character": 43 } ] @@ -28224,7 +30662,7 @@ } }, { - "id": 772, + "id": 792, "name": "SignInWithIdTokenCredentials", "kind": 4194304, "kindString": "Type alias", @@ -28232,21 +30670,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 581, + "line": 599, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 773, + "id": 793, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 776, + "id": 797, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -28259,7 +30697,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 587, + "line": 605, "character": 2 } ], @@ -28269,7 +30707,7 @@ } }, { - "id": 777, + "id": 798, "name": "nonce", "kind": 1024, "kindString": "Property", @@ -28282,7 +30720,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 589, + "line": 607, "character": 2 } ], @@ -28292,7 +30730,7 @@ } }, { - "id": 778, + "id": 799, "name": "options", "kind": 1024, "kindString": "Property", @@ -28302,21 +30740,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 608, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 779, + "id": 800, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 780, + "id": 801, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -28329,7 +30767,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 592, + "line": 610, "character": 4 } ], @@ -28343,13 +30781,13 @@ { "title": "Properties", "kind": 1024, - "children": [780] + "children": [801] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 590, + "line": 608, "character": 12 } ] @@ -28357,18 +30795,18 @@ } }, { - "id": 774, + "id": 794, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, "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`, `keycloak` (deprecated)." + "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`, `keycloak` (deprecated)." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 583, + "line": 601, "character": 2 } ], @@ -28392,14 +30830,40 @@ "value": "facebook" }, { - "type": "intrinsic", - "name": "string" + "type": "literal", + "value": "kakao" + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 795, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 601, + "character": 76 + } + ] + } + } + ] } ] } }, { - "id": 775, + "id": 796, "name": "token", "kind": 1024, "kindString": "Property", @@ -28410,7 +30874,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 585, + "line": 603, "character": 2 } ], @@ -28424,13 +30888,13 @@ { "title": "Properties", "kind": 1024, - "children": [776, 777, 778, 774, 775] + "children": [797, 798, 799, 794, 796] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 581, + "line": 599, "character": 43 } ] @@ -28438,7 +30902,7 @@ } }, { - "id": 760, + "id": 780, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -28446,21 +30910,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 761, + "id": 781, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 763, + "id": 783, "name": "options", "kind": 1024, "kindString": "Property", @@ -28470,21 +30934,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 764, + "id": 784, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 767, + "id": 787, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -28497,14 +30961,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 768, + "id": 788, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -28512,19 +30976,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 575, + "line": 593, "character": 18 } ], "indexSignature": { - "id": 769, + "id": 789, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 770, + "id": 790, "name": "key", "kind": 32768, "flags": {}, @@ -28543,7 +31007,7 @@ } }, { - "id": 765, + "id": 785, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -28556,7 +31020,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 571, + "line": 589, "character": 4 } ], @@ -28566,7 +31030,7 @@ } }, { - "id": 766, + "id": 786, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -28579,7 +31043,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 573, + "line": 591, "character": 4 } ], @@ -28589,7 +31053,7 @@ } }, { - "id": 771, + "id": 791, "name": "skipBrowserRedirect", "kind": 1024, "kindString": "Property", @@ -28602,7 +31066,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 577, + "line": 595, "character": 4 } ], @@ -28616,13 +31080,13 @@ { "title": "Properties", "kind": 1024, - "children": [767, 765, 766, 771] + "children": [787, 785, 786, 791] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 569, + "line": 587, "character": 12 } ] @@ -28630,7 +31094,7 @@ } }, { - "id": 762, + "id": 782, "name": "provider", "kind": 1024, "kindString": "Property", @@ -28641,16 +31105,16 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 568, + "line": 586, "character": 2 } ], "type": { "type": "reference", - "id": 478, + "id": 493, "name": "Provider", "dereferenced": { - "id": 478, + "id": 493, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -28728,6 +31192,10 @@ "type": "literal", "value": "slack" }, + { + "type": "literal", + "value": "slack_oidc" + }, { "type": "literal", "value": "spotify" @@ -28762,13 +31230,13 @@ { "title": "Properties", "kind": 1024, - "children": [763, 762] + "children": [783, 782] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 566, + "line": 584, "character": 41 } ] @@ -28776,7 +31244,7 @@ } }, { - "id": 729, + "id": 749, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -28784,7 +31252,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 505, + "line": 523, "character": 12 } ], @@ -28794,14 +31262,14 @@ { "type": "reflection", "declaration": { - "id": 730, + "id": 750, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 731, + "id": 751, "name": "email", "kind": 1024, "kindString": "Property", @@ -28812,7 +31280,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 508, + "line": 526, "character": 6 } ], @@ -28822,7 +31290,7 @@ } }, { - "id": 733, + "id": 753, "name": "options", "kind": 1024, "kindString": "Property", @@ -28832,21 +31300,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 511, + "line": 529, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 734, + "id": 754, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 735, + "id": 755, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -28859,7 +31327,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 513, + "line": 531, "character": 8 } ], @@ -28873,13 +31341,13 @@ { "title": "Properties", "kind": 1024, - "children": [735] + "children": [755] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 511, + "line": 529, "character": 16 } ] @@ -28887,7 +31355,7 @@ } }, { - "id": 732, + "id": 752, "name": "password", "kind": 1024, "kindString": "Property", @@ -28898,7 +31366,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 510, + "line": 528, "character": 6 } ], @@ -28912,13 +31380,13 @@ { "title": "Properties", "kind": 1024, - "children": [731, 733, 732] + "children": [751, 753, 752] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 506, + "line": 524, "character": 4 } ] @@ -28927,14 +31395,14 @@ { "type": "reflection", "declaration": { - "id": 736, + "id": 756, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 739, + "id": 759, "name": "options", "kind": 1024, "kindString": "Property", @@ -28944,21 +31412,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 521, + "line": 539, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 740, + "id": 760, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 741, + "id": 761, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -28968,203 +31436,6 @@ "comment": { "shortText": "Verification token received when the user completes the captcha on the site." }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 523, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [741] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 521, - "character": 16 - } - ] - } - } - }, - { - "id": 738, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 520, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 737, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 518, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [739, 738, 737] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 516, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 742, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 527, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 743, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 744, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 530, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 745, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 531, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 746, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 750, - "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": 543, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 749, - "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.raw_user_meta_data` 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", @@ -29172,103 +31443,139 @@ "character": 8 } ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 747, - "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": 533, - "character": 8 - } - ], "type": { "type": "intrinsic", "name": "string" } - }, - { - "id": 748, - "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": 535, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [750, 749, 747, 748] + "children": [761] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 531, + "line": 539, "character": 16 } ] } } + }, + { + "id": 758, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 538, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 757, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 536, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [744, 745] + "children": [759, 758, 757] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 528, + "line": 534, "character": 4 } ] } - }, + } + ] + } + }, + { + "id": 762, + "name": "SignInWithPasswordlessCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 545, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ { "type": "reflection", "declaration": { - "id": 751, + "id": 763, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 753, + "id": 764, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 548, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 765, "name": "options", "kind": 1024, "kindString": "Property", @@ -29285,14 +31592,14 @@ "type": { "type": "reflection", "declaration": { - "id": 754, + "id": 766, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 757, + "id": 770, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -29305,7 +31612,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 559, + "line": 561, "character": 8 } ], @@ -29315,7 +31622,168 @@ } }, { - "id": 758, + "id": 769, + "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.raw_user_meta_data` 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": 559, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 767, + "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": 551, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 768, + "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": 553, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [770, 769, 767, 768] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 549, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [764, 765] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 546, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 771, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 773, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 567, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 774, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 777, + "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": 577, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 778, "name": "channel", "kind": 1024, "kindString": "Property", @@ -29328,7 +31796,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 561, + "line": 579, "character": 8 } ], @@ -29347,7 +31815,7 @@ } }, { - "id": 756, + "id": 776, "name": "data", "kind": 1024, "kindString": "Property", @@ -29361,7 +31829,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 557, + "line": 575, "character": 8 } ], @@ -29371,7 +31839,7 @@ } }, { - "id": 755, + "id": 775, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -29384,7 +31852,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 551, + "line": 569, "character": 8 } ], @@ -29398,13 +31866,13 @@ { "title": "Properties", "kind": 1024, - "children": [757, 758, 756, 755] + "children": [777, 778, 776, 775] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 549, + "line": 567, "character": 16 } ] @@ -29412,7 +31880,7 @@ } }, { - "id": 752, + "id": 772, "name": "phone", "kind": 1024, "kindString": "Property", @@ -29423,7 +31891,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 548, + "line": 566, "character": 6 } ], @@ -29437,13 +31905,13 @@ { "title": "Properties", "kind": 1024, - "children": [753, 752] + "children": [773, 772] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 546, + "line": 564, "character": 4 } ] @@ -29453,7 +31921,7 @@ } }, { - "id": 817, + "id": 838, "name": "SignInWithSSO", "kind": 4194304, "kindString": "Type alias", @@ -29461,7 +31929,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 666, + "line": 684, "character": 12 } ], @@ -29471,14 +31939,14 @@ { "type": "reflection", "declaration": { - "id": 818, + "id": 839, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 820, + "id": 841, "name": "options", "kind": 1024, "kindString": "Property", @@ -29488,21 +31956,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 671, + "line": 689, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 821, + "id": 842, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 823, + "id": 844, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -29515,7 +31983,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 675, + "line": 693, "character": 8 } ], @@ -29525,7 +31993,7 @@ } }, { - "id": 822, + "id": 843, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -29538,7 +32006,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 673, + "line": 691, "character": 8 } ], @@ -29552,13 +32020,13 @@ { "title": "Properties", "kind": 1024, - "children": [823, 822] + "children": [844, 843] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 671, + "line": 689, "character": 16 } ] @@ -29566,7 +32034,7 @@ } }, { - "id": 819, + "id": 840, "name": "providerId", "kind": 1024, "kindString": "Property", @@ -29577,7 +32045,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 669, + "line": 687, "character": 6 } ], @@ -29591,13 +32059,13 @@ { "title": "Properties", "kind": 1024, - "children": [820, 819] + "children": [841, 840] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 667, + "line": 685, "character": 4 } ] @@ -29606,14 +32074,14 @@ { "type": "reflection", "declaration": { - "id": 824, + "id": 845, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 825, + "id": 846, "name": "domain", "kind": 1024, "kindString": "Property", @@ -29624,7 +32092,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 680, + "line": 698, "character": 6 } ], @@ -29634,7 +32102,7 @@ } }, { - "id": 826, + "id": 847, "name": "options", "kind": 1024, "kindString": "Property", @@ -29644,21 +32112,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 682, + "line": 700, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 827, + "id": 848, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 829, + "id": 850, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -29671,7 +32139,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 686, + "line": 704, "character": 8 } ], @@ -29681,7 +32149,7 @@ } }, { - "id": 828, + "id": 849, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -29694,7 +32162,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 684, + "line": 702, "character": 8 } ], @@ -29708,13 +32176,13 @@ { "title": "Properties", "kind": 1024, - "children": [829, 828] + "children": [850, 849] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 682, + "line": 700, "character": 16 } ] @@ -29726,13 +32194,13 @@ { "title": "Properties", "kind": 1024, - "children": [825, 826] + "children": [846, 847] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 678, + "line": 696, "character": 4 } ] @@ -29742,7 +32210,7 @@ } }, { - "id": 1043, + "id": 1052, "name": "SignOut", "kind": 4194304, "kindString": "Type alias", @@ -29750,21 +32218,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1128, + "line": 1115, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 1044, + "id": 1053, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1045, + "id": 1054, "name": "scope", "kind": 1024, "kindString": "Property", @@ -29777,7 +32245,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1139, + "line": 1126, "character": 2 } ], @@ -29804,13 +32272,13 @@ { "title": "Properties", "kind": 1024, - "children": [1045] + "children": [1054] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1128, + "line": 1115, "character": 22 } ] @@ -29818,7 +32286,7 @@ } }, { - "id": 712, + "id": 732, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -29826,7 +32294,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 468, + "line": 486, "character": 12 } ], @@ -29836,14 +32304,14 @@ { "type": "reflection", "declaration": { - "id": 713, + "id": 733, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 714, + "id": 734, "name": "email", "kind": 1024, "kindString": "Property", @@ -29854,7 +32322,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 471, + "line": 489, "character": 6 } ], @@ -29864,166 +32332,7 @@ } }, { - "id": 716, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 474, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 717, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 720, - "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": 484, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 719, - "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.raw_user_meta_data` 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": 482, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 718, - "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": 476, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [720, 719, 718] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 474, - "character": 16 - } - ] - } - } - }, - { - "id": 715, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 473, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [714, 716, 715] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 469, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 721, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 724, + "id": 736, "name": "options", "kind": 1024, "kindString": "Property", @@ -30040,14 +32349,14 @@ "type": { "type": "reflection", "declaration": { - "id": 725, + "id": 737, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 727, + "id": 740, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -30055,30 +32364,7 @@ "isOptional": true }, "comment": { - "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 500, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 728, - "name": "channel", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + "shortText": "Verification token received when the user completes the captcha on the site." }, "sources": [ { @@ -30088,21 +32374,12 @@ } ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] + "type": "intrinsic", + "name": "string" } }, { - "id": 726, + "id": 739, "name": "data", "kind": 1024, "kindString": "Property", @@ -30116,7 +32393,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 498, + "line": 500, "character": 8 } ], @@ -30124,13 +32401,36 @@ "type": "intrinsic", "name": "object" } + }, + { + "id": 738, + "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": 494, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [727, 728, 726] + "children": [740, 739, 738] } ], "sources": [ @@ -30144,7 +32444,7 @@ } }, { - "id": 723, + "id": 735, "name": "password", "kind": 1024, "kindString": "Property", @@ -30163,9 +32463,177 @@ "type": "intrinsic", "name": "string" } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [734, 736, 735] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 487, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 741, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 744, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 510, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 745, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 747, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site. Requires a configured WhatsApp sender on Twilio" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 518, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 748, + "name": "channel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Messaging channel to use (e.g. whatsapp or sms)" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 520, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "whatsapp" + } + ] + } + }, + { + "id": 746, + "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.raw_user_meta_data` 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": 516, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [747, 748, 746] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 510, + "character": 16 + } + ] + } + } }, { - "id": 722, + "id": 743, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 509, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 742, "name": "phone", "kind": 1024, "kindString": "Property", @@ -30176,7 +32644,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 489, + "line": 507, "character": 6 } ], @@ -30190,13 +32658,13 @@ { "title": "Properties", "kind": 1024, - "children": [724, 723, 722] + "children": [744, 743, 742] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 487, + "line": 505, "character": 4 } ] @@ -30206,7 +32674,7 @@ } }, { - "id": 1019, + "id": 1028, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -30214,7 +32682,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1089, + "line": 1076, "character": 12 } ], @@ -30261,14 +32729,14 @@ { "type": "reflection", "declaration": { - "id": 1020, + "id": 1029, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1021, + "id": 1030, "name": "isServer", "kind": 1024, "kindString": "Property", @@ -30281,7 +32749,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 1099, + "line": 1086, "character": 2 } ], @@ -30295,13 +32763,13 @@ { "title": "Properties", "kind": 1024, - "children": [1021] + "children": [1030] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 1091, + "line": 1078, "character": 4 } ] @@ -30311,7 +32779,7 @@ } }, { - "id": 607, + "id": 624, "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", @@ -30319,7 +32787,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 208, + "line": 214, "character": 12 } ], @@ -30329,117 +32797,14 @@ { "type": "reflection", "declaration": { - "id": 608, + "id": 625, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 609, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 210, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 610, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 611, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 211, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 656, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [611] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 210, - "character": 12 - } - ] - } - } - }, - { - "id": 612, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 213, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [609, 612] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 209, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 613, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 614, + "id": 626, "name": "data", "kind": 1024, "kindString": "Property", @@ -30454,14 +32819,14 @@ "type": { "type": "reflection", "declaration": { - "id": 615, + "id": 627, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 616, + "id": 628, "name": "user", "kind": 1024, "kindString": "Property", @@ -30474,8 +32839,9 @@ } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 675, + "name": "User" } } ], @@ -30483,7 +32849,7 @@ { "title": "Properties", "kind": 1024, - "children": [616] + "children": [628] } ], "sources": [ @@ -30497,7 +32863,7 @@ } }, { - "id": 617, + "id": 629, "name": "error", "kind": 1024, "kindString": "Property", @@ -30510,9 +32876,8 @@ } ], "type": { - "type": "reference", - "id": 1058, - "name": "AuthError" + "type": "literal", + "value": null } } ], @@ -30520,7 +32885,7 @@ { "title": "Properties", "kind": 1024, - "children": [614, 617] + "children": [626, 629] } ], "sources": [ @@ -30531,12 +32896,115 @@ } ] } + }, + { + "type": "reflection", + "declaration": { + "id": 630, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 631, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 632, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 633, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 223, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [633] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, + "character": 12 + } + ] + } + } + }, + { + "id": 634, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 225, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 1111, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [631, 634] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 221, + "character": 4 + } + ] + } } ] } }, { - "id": 781, + "id": 802, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -30544,7 +33012,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 596, + "line": 614, "character": 12 } ], @@ -30552,14 +33020,14 @@ "type": "union", "types": [ { - "id": 782, + "id": 803, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 786, + "id": 807, "name": "options", "kind": 1024, "kindString": "Property", @@ -30569,243 +33037,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 604, + "line": 622, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 787, + "id": 808, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 789, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.", - "tags": [ - { - "tag": "deprecated", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 613, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 788, - "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": 606, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [789, 788] - } - ] - } - } - }, - { - "id": 783, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 599, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 784, - "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": 601, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 785, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 603, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 801, - "name": "MobileOtpType", - "dereferenced": { - "id": 801, - "name": "MobileOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 643, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [786, 783, 784, 785] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 597, - "character": 17 - } - ] - }, - { - "id": 790, - "name": "VerifyEmailOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 791, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 618, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 794, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 623, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 795, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 797, + "id": 810, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -30834,7 +33080,7 @@ } }, { - "id": 796, + "id": 809, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -30847,7 +33093,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 625, + "line": 624, "character": 4 } ], @@ -30861,25 +33107,25 @@ { "title": "Properties", "kind": 1024, - "children": [797, 796] + "children": [810, 809] } ] } } }, { - "id": 792, - "name": "token", + "id": 804, + "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The otp sent to the user's email address." + "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 620, + "line": 617, "character": 2 } ], @@ -30889,7 +33135,28 @@ } }, { - "id": 793, + "id": 805, + "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": 619, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 806, "name": "type", "kind": 1024, "kindString": "Property", @@ -30900,24 +33167,24 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 622, + "line": 621, "character": 2 } ], "type": { "type": "reference", - "id": 802, - "name": "EmailOtpType", + "id": 822, + "name": "MobileOtpType", "dereferenced": { - "id": 802, - "name": "EmailOtpType", + "id": 822, + "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 661, "character": 12 } ], @@ -30926,27 +33193,11 @@ "types": [ { "type": "literal", - "value": "signup" + "value": "sms" }, { "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" + "value": "phone_change" } ] } @@ -30958,37 +33209,37 @@ { "title": "Properties", "kind": 1024, - "children": [791, 794, 792, 793] + "children": [807, 804, 805, 806] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 616, + "line": 615, "character": 17 } ] }, { - "id": 798, - "name": "VerifyTokenHashParams", + "id": 811, + "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 799, - "name": "token_hash", + "id": 812, + "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "The token hash used in an email link" + "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 637, + "line": 636, "character": 2 } ], @@ -30998,7 +33249,115 @@ } }, { - "id": 800, + "id": 815, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 641, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 816, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 818, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site.", + "tags": [ + { + "tag": "deprecated", + "text": "\n" + } + ] + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 649, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 817, + "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": 643, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [818, 817] + } + ] + } + } + }, + { + "id": 813, + "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": 638, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 814, "name": "type", "kind": 1024, "kindString": "Property", @@ -31015,10 +33374,10 @@ ], "type": { "type": "reference", - "id": 802, + "id": 823, "name": "EmailOtpType", "dereferenced": { - "id": 802, + "id": 823, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -31026,7 +33385,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 644, + "line": 662, "character": 12 } ], @@ -31067,13 +33426,122 @@ { "title": "Properties", "kind": 1024, - "children": [799, 800] + "children": [812, 815, 813, 814] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 635, + "line": 634, + "character": 17 + } + ] + }, + { + "id": 819, + "name": "VerifyTokenHashParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 820, + "name": "token_hash", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The token hash used in an email link" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 655, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 821, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 658, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 823, + "name": "EmailOtpType", + "dereferenced": { + "id": 823, + "name": "EmailOtpType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 662, + "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" + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [820, 821] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 653, "character": 17 } ] @@ -31082,7 +33550,7 @@ } }, { - "id": 511, + "id": 528, "name": "WeakPassword", "kind": 4194304, "kindString": "Type alias", @@ -31090,21 +33558,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 92, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 512, + "id": 529, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 514, + "id": 531, "name": "message", "kind": 1024, "kindString": "Property", @@ -31112,7 +33580,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 88, + "line": 94, "character": 2 } ], @@ -31122,7 +33590,7 @@ } }, { - "id": 513, + "id": 530, "name": "reasons", "kind": 1024, "kindString": "Property", @@ -31130,7 +33598,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 87, + "line": 93, "character": 2 } ], @@ -31138,7 +33606,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 510, + "id": 526, "name": "WeakPasswordReasons" } } @@ -31148,13 +33616,13 @@ { "title": "Properties", "kind": 1024, - "children": [514, 513] + "children": [531, 530] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 92, "character": 27 } ] @@ -31162,7 +33630,7 @@ } }, { - "id": 510, + "id": 526, "name": "WeakPasswordReasons", "kind": 4194304, "kindString": "Type alias", @@ -31170,7 +33638,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 85, + "line": 91, "character": 12 } ], @@ -31190,14 +33658,36 @@ "value": "pwned" }, { - "type": "intrinsic", - "name": "string" + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 527, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 91, + "character": 80 + } + ] + } + } + ] } ] } }, { - "id": 460, + "id": 475, "name": "AuthAdminApi", "kind": 32, "kindString": "Variable", @@ -31222,7 +33712,7 @@ "defaultValue": "GoTrueAdminApi" }, { - "id": 461, + "id": 476, "name": "AuthClient", "kind": 32, "kindString": "Variable", @@ -31247,7 +33737,7 @@ "defaultValue": "GoTrueClient" }, { - "id": 475, + "id": 490, "name": "lockInternals", "kind": 32, "kindString": "Variable", @@ -31272,14 +33762,14 @@ "type": { "type": "reflection", "declaration": { - "id": 476, + "id": 491, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 477, + "id": 492, "name": "debug", "kind": 1024, "kindString": "Property", @@ -31310,7 +33800,7 @@ { "title": "Properties", "kind": 1024, - "children": [477] + "children": [492] } ] } @@ -31318,7 +33808,7 @@ "defaultValue": "..." }, { - "id": 1049, + "id": 1096, "name": "isAuthApiError", "kind": 64, "kindString": "Function", @@ -31326,20 +33816,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 36, + "line": 41, "character": 16 } ], "signatures": [ { - "id": 1050, + "id": 1097, "name": "isAuthApiError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1051, + "id": 1098, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -31356,7 +33846,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1065, + "id": 1121, "name": "AuthApiError" } } @@ -31364,7 +33854,7 @@ ] }, { - "id": 1046, + "id": 1093, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -31372,20 +33862,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 14, + "line": 26, "character": 16 } ], "signatures": [ { - "id": 1047, + "id": 1094, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1048, + "id": 1095, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -31402,7 +33892,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1058, + "id": 1111, "name": "AuthError" } } @@ -31410,7 +33900,53 @@ ] }, { - "id": 1052, + "id": 1102, + "name": "isAuthImplicitGrantRedirectError", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 105, + "character": 16 + } + ], + "signatures": [ + { + "id": 1103, + "name": "isAuthImplicitGrantRedirectError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 1104, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 1178, + "name": "AuthImplicitGrantRedirectError" + } + } + } + ] + }, + { + "id": 1105, "name": "isAuthRetryableFetchError", "kind": 64, "kindString": "Function", @@ -31418,20 +33954,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 126, + "line": 135, "character": 16 } ], "signatures": [ { - "id": 1053, + "id": 1106, "name": "isAuthRetryableFetchError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1054, + "id": 1107, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -31448,7 +33984,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1188, + "id": 1232, "name": "AuthRetryableFetchError" } } @@ -31456,7 +33992,53 @@ ] }, { - "id": 1055, + "id": 1099, + "name": "isAuthSessionMissingError", + "kind": 64, + "kindString": "Function", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 72, + "character": 16 + } + ], + "signatures": [ + { + "id": 1100, + "name": "isAuthSessionMissingError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 1101, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 1153, + "name": "AuthSessionMissingError" + } + } + } + ] + }, + { + "id": 1108, "name": "isAuthWeakPasswordError", "kind": 64, "kindString": "Function", @@ -31464,20 +34046,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 148, + "line": 157, "character": 16 } ], "signatures": [ { - "id": 1056, + "id": 1109, "name": "isAuthWeakPasswordError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1057, + "id": 1110, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -31494,7 +34076,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 1202, + "id": 1242, "name": "AuthWeakPasswordError" } } @@ -31502,7 +34084,7 @@ ] }, { - "id": 462, + "id": 477, "name": "navigatorLock", "kind": 64, "kindString": "Function", @@ -31510,13 +34092,13 @@ "sources": [ { "fileName": "src/lib/locks.ts", - "line": 58, + "line": 59, "character": 22 } ], "signatures": [ { - "id": 463, + "id": 478, "name": "navigatorLock", "kind": 4096, "kindString": "Call signature", @@ -31527,7 +34109,7 @@ }, "typeParameter": [ { - "id": 464, + "id": 479, "name": "R", "kind": 131072, "kindString": "Type parameter", @@ -31536,7 +34118,7 @@ ], "parameters": [ { - "id": 465, + "id": 480, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -31550,7 +34132,7 @@ } }, { - "id": 466, + "id": 481, "name": "acquireTimeout", "kind": 32768, "kindString": "Parameter", @@ -31564,7 +34146,7 @@ } }, { - "id": 467, + "id": 482, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -31575,14 +34157,14 @@ "type": { "type": "reflection", "declaration": { - "id": 468, + "id": 483, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 469, + "id": 484, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -31592,7 +34174,7 @@ "typeArguments": [ { "type": "reference", - "id": 464, + "id": 479, "name": "R" } ], @@ -31611,7 +34193,7 @@ "typeArguments": [ { "type": "reference", - "id": 464, + "id": 479, "name": "R" } ], @@ -31627,34 +34209,32 @@ { "title": "Classes", "kind": 128, - "children": [1065, 1058, 1138, 1125, 1113, 1163, 1188, 1101, 1078, 1202, 1086, 1, 78, 470] + "children": [1121, 1111, 1178, 1169, 1161, 1205, 1232, 1153, 1131, 1242, 1141, 1, 78, 485] }, { "title": "Interfaces", "kind": 256, - "children": [ - 627, 685, 642, 852, 1012, 967, 618, 696, 704, 656, 649, 679, 630, 653, 790, 782, 798 - ] + "children": [644, 705, 660, 873, 1021, 972, 635, 718, 675, 668, 699, 648, 672, 811, 803, 819] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 480, 479, 759, 996, 987, 1009, 1000, 935, 910, 956, 945, 926, 897, 542, 515, 528, 557, 570, - 955, 1025, 802, 846, 836, 855, 869, 856, 876, 841, 830, 490, 1022, 481, 893, 890, 877, 882, - 885, 801, 585, 1039, 1032, 478, 803, 598, 706, 772, 760, 729, 742, 817, 1043, 712, 1019, - 607, 781, 511, 510 + 495, 494, 779, 1005, 996, 1018, 1009, 938, 1081, 928, 1065, 961, 949, 929, 915, 559, 532, + 545, 574, 587, 960, 1034, 823, 867, 857, 876, 890, 877, 897, 862, 851, 505, 1031, 496, 911, + 907, 898, 1060, 1055, 899, 902, 822, 602, 1048, 1041, 493, 824, 615, 726, 792, 780, 749, + 762, 838, 1052, 732, 1028, 624, 802, 528, 526 ] }, { "title": "Variables", "kind": 32, - "children": [460, 461, 475] + "children": [475, 476, 490] }, { "title": "Functions", "kind": 64, - "children": [1049, 1046, 1052, 1055, 462] + "children": [1096, 1093, 1102, 1105, 1099, 1108, 477] } ], "sources": [ diff --git a/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json b/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json index 4e91527fec5..1a2840cc303 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json @@ -7,7 +7,7 @@ "originalName": "", "children": [ { - "id": 609, + "id": 615, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -16,7 +16,7 @@ }, "children": [ { - "id": 610, + "id": 616, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -24,41 +24,60 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 23, "character": 2 } ], "signatures": [ { - "id": 611, + "id": 617, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 612, + "id": 618, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 619, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "parameters": [ { - "id": 613, + "id": 620, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -67,12 +86,17 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" } ], "name": "default" @@ -81,7 +105,7 @@ ] }, { - "id": 618, + "id": 625, "name": "body", "kind": 1024, "kindString": "Property", @@ -92,7 +116,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -102,7 +126,7 @@ } }, { - "id": 621, + "id": 628, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -112,28 +136,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 622, + "id": 629, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 623, + "id": 630, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 624, + "id": 631, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -157,7 +181,7 @@ } }, { - "id": 625, + "id": 632, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -192,7 +216,7 @@ } }, { - "id": 616, + "id": 623, "name": "headers", "kind": 1024, "kindString": "Property", @@ -202,7 +226,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -224,7 +248,7 @@ } }, { - "id": 626, + "id": 633, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -234,7 +258,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -244,7 +268,7 @@ } }, { - "id": 614, + "id": 621, "name": "method", "kind": 1024, "kindString": "Property", @@ -254,7 +278,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -285,7 +309,7 @@ } }, { - "id": 617, + "id": 624, "name": "schema", "kind": 1024, "kindString": "Property", @@ -293,48 +317,6 @@ "isProtected": true, "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 619, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 620, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", @@ -342,6 +324,48 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 626, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 627, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -350,7 +374,7 @@ } }, { - "id": 615, + "id": 622, "name": "url", "kind": 1024, "kindString": "Property", @@ -360,7 +384,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -372,7 +396,74 @@ } }, { - "id": 629, + "id": 636, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 637, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 638, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 639, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 640, "name": "then", "kind": 2048, "kindString": "Method", @@ -380,39 +471,63 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 630, + "id": 641, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 631, + "id": 642, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } }, { - "id": 632, + "id": 643, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -425,7 +540,7 @@ ], "parameters": [ { - "id": 633, + "id": 644, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -442,36 +557,60 @@ { "type": "reflection", "declaration": { - "id": 634, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 635, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 636, + "id": 647, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } } ], @@ -480,7 +619,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -488,7 +627,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -506,7 +645,7 @@ } }, { - "id": 637, + "id": 648, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -523,21 +662,21 @@ { "type": "reflection", "declaration": { - "id": 638, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 639, + "id": 650, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 640, + "id": 651, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -553,7 +692,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -561,7 +700,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -587,12 +726,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -614,7 +753,7 @@ } }, { - "id": 627, + "id": 634, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -622,13 +761,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 628, + "id": 635, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -638,16 +777,42 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 609, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 612, - "name": "Result" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + }, + { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] } } ] @@ -657,17 +822,17 @@ { "title": "Constructors", "kind": 512, - "children": [610] + "children": [616] }, { "title": "Properties", "kind": 1024, - "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] + "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] }, { "title": "Methods", "kind": 2048, - "children": [629, 627] + "children": [636, 640, 634] } ], "sources": [ @@ -679,17 +844,32 @@ ], "typeParameter": [ { - "id": 641, + "id": 652, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 653, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "extendedBy": [ { "type": "reference", - "id": 489, + "id": 491, "name": "PostgrestTransformBuilder" } ], @@ -698,16 +878,40 @@ "type": "reference", "typeArguments": [ { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } ], "qualifiedName": "PromiseLike", @@ -717,7 +921,7 @@ ] }, { - "id": 1, + "id": 9, "name": "PostgrestClient", "kind": 128, "kindString": "Class", @@ -727,7 +931,7 @@ }, "children": [ { - "id": 2, + "id": 10, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -741,7 +945,7 @@ ], "signatures": [ { - "id": 3, + "id": 11, "name": "new PostgrestClient", "kind": 16384, "kindString": "Constructor signature", @@ -751,7 +955,7 @@ }, "typeParameter": [ { - "id": 4, + "id": 12, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -762,7 +966,7 @@ } }, { - "id": 5, + "id": 13, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -782,7 +986,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -802,7 +1006,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } } @@ -811,7 +1015,7 @@ } }, { - "id": 6, + "id": 14, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -826,12 +1030,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -859,7 +1063,7 @@ ], "parameters": [ { - "id": 7, + "id": 15, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -873,7 +1077,7 @@ } }, { - "id": 8, + "id": 16, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -885,14 +1089,14 @@ "type": { "type": "reflection", "declaration": { - "id": 9, + "id": 17, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 12, + "id": 20, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -909,14 +1113,14 @@ "type": { "type": "reflection", "declaration": { - "id": 13, + "id": 21, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 14, + "id": 22, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -926,7 +1130,7 @@ }, "parameters": [ { - "id": 15, + "id": 23, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -950,7 +1154,7 @@ } }, { - "id": 16, + "id": 24, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -985,7 +1189,7 @@ } }, { - "id": 10, + "id": 18, "name": "headers", "kind": 1024, "kindString": "Property", @@ -1020,7 +1224,7 @@ } }, { - "id": 11, + "id": 19, "name": "schema", "kind": 1024, "kindString": "Property", @@ -1039,7 +1243,7 @@ ], "type": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" } } @@ -1048,7 +1252,7 @@ { "title": "Properties", "kind": 1024, - "children": [12, 10, 11] + "children": [20, 18, 19] } ] } @@ -1058,21 +1262,21 @@ ], "type": { "type": "reference", - "id": 1, + "id": 9, "typeArguments": [ { "type": "reference", - "id": 4, + "id": 12, "name": "Database" }, { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" }, { "type": "reference", - "id": 6, + "id": 14, "name": "Schema" } ], @@ -1082,7 +1286,7 @@ ] }, { - "id": 20, + "id": 28, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -1099,21 +1303,21 @@ "type": { "type": "reflection", "declaration": { - "id": 21, + "id": 29, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 22, + "id": 30, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 23, + "id": 31, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1137,7 +1341,7 @@ } }, { - "id": 24, + "id": 32, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1172,7 +1376,7 @@ } }, { - "id": 18, + "id": 26, "name": "headers", "kind": 1024, "kindString": "Property", @@ -1202,7 +1406,7 @@ } }, { - "id": 19, + "id": 27, "name": "schemaName", "kind": 1024, "kindString": "Property", @@ -1218,12 +1422,12 @@ ], "type": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" } }, { - "id": 17, + "id": 25, "name": "url", "kind": 1024, "kindString": "Property", @@ -1241,7 +1445,7 @@ } }, { - "id": 25, + "id": 33, "name": "from", "kind": 2048, "kindString": "Method", @@ -1255,7 +1459,7 @@ ], "signatures": [ { - "id": 26, + "id": 34, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1265,7 +1469,7 @@ }, "typeParameter": [ { - "id": 27, + "id": 35, "name": "TableName", "kind": 131072, "kindString": "Type parameter", @@ -1276,7 +1480,7 @@ } }, { - "id": 28, + "id": 36, "name": "Table", "kind": 131072, "kindString": "Type parameter", @@ -1289,7 +1493,7 @@ ], "parameters": [ { - "id": 29, + "id": 37, "name": "relation", "kind": 32768, "kindString": "Parameter", @@ -1299,48 +1503,48 @@ }, "type": { "type": "reference", - "id": 27, + "id": 35, "name": "TableName" } } ], "type": { "type": "reference", - "id": 56, + "id": 64, "typeArguments": [ { "type": "reference", - "id": 6, + "id": 14, "name": "Schema" }, { "type": "reference", - "id": 28, + "id": 36, "name": "Table" }, { "type": "reference", - "id": 27, + "id": 35, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 28, + "id": 36, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { - "id": 30, + "id": 38, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 31, + "id": 39, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -1362,7 +1566,7 @@ { "title": "Properties", "kind": 1024, - "children": [31] + "children": [39] } ] } @@ -1381,7 +1585,7 @@ } }, { - "id": 32, + "id": 40, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1391,7 +1595,7 @@ }, "typeParameter": [ { - "id": 33, + "id": 41, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", @@ -1402,7 +1606,7 @@ } }, { - "id": 34, + "id": 42, "name": "View", "kind": 131072, "kindString": "Type parameter", @@ -1415,7 +1619,7 @@ ], "parameters": [ { - "id": 35, + "id": 43, "name": "relation", "kind": 32768, "kindString": "Parameter", @@ -1425,48 +1629,48 @@ }, "type": { "type": "reference", - "id": 33, + "id": 41, "name": "ViewName" } } ], "type": { "type": "reference", - "id": 56, + "id": 64, "typeArguments": [ { "type": "reference", - "id": 6, + "id": 14, "name": "Schema" }, { "type": "reference", - "id": 34, + "id": 42, "name": "View" }, { "type": "reference", - "id": 33, + "id": 41, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 34, + "id": 42, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { - "id": 36, + "id": 44, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 37, + "id": 45, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -1488,7 +1692,7 @@ { "title": "Properties", "kind": 1024, - "children": [37] + "children": [45] } ] } @@ -1509,7 +1713,7 @@ ] }, { - "id": 42, + "id": 50, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -1523,7 +1727,7 @@ ], "signatures": [ { - "id": 43, + "id": 51, "name": "rpc", "kind": 4096, "kindString": "Call signature", @@ -1533,7 +1737,7 @@ }, "typeParameter": [ { - "id": 44, + "id": 52, "name": "FnName", "kind": 131072, "kindString": "Type parameter", @@ -1544,7 +1748,7 @@ } }, { - "id": 45, + "id": 53, "name": "Fn", "kind": 131072, "kindString": "Type parameter", @@ -1557,7 +1761,7 @@ ], "parameters": [ { - "id": 46, + "id": 54, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -1567,12 +1771,12 @@ }, "type": { "type": "reference", - "id": 44, + "id": 52, "name": "FnName" } }, { - "id": 47, + "id": 55, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -1588,14 +1792,14 @@ }, "objectType": { "type": "reference", - "id": 45, + "id": 53, "name": "Fn" } }, "defaultValue": "{}" }, { - "id": 48, + "id": 56, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -1607,14 +1811,14 @@ "type": { "type": "reflection", "declaration": { - "id": 49, + "id": 57, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 52, + "id": 60, "name": "count", "kind": 1024, "kindString": "Property", @@ -1650,7 +1854,7 @@ } }, { - "id": 51, + "id": 59, "name": "get", "kind": 1024, "kindString": "Property", @@ -1673,7 +1877,7 @@ } }, { - "id": 50, + "id": 58, "name": "head", "kind": 1024, "kindString": "Property", @@ -1700,7 +1904,7 @@ { "title": "Properties", "kind": 1024, - "children": [52, 51, 50] + "children": [60, 59, 58] } ] } @@ -1710,11 +1914,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 6, + "id": 14, "name": "Schema" }, { @@ -1727,7 +1931,7 @@ }, "objectType": { "type": "reference", - "id": 45, + "id": 53, "name": "Fn" } }, @@ -1803,17 +2007,18 @@ }, "objectType": { "type": "reference", - "id": 45, + "id": 53, "name": "Fn" } }, { - "type": "intrinsic", - "name": "unknown" + "type": "reference", + "id": 52, + "name": "FnName" }, { - "type": "intrinsic", - "name": "unknown" + "type": "literal", + "value": null } ], "name": "default" @@ -1822,7 +2027,7 @@ ] }, { - "id": 38, + "id": 46, "name": "schema", "kind": 2048, "kindString": "Method", @@ -1836,7 +2041,7 @@ ], "signatures": [ { - "id": 39, + "id": 47, "name": "schema", "kind": 4096, "kindString": "Call signature", @@ -1847,7 +2052,7 @@ }, "typeParameter": [ { - "id": 40, + "id": 48, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", @@ -1860,7 +2065,7 @@ ], "parameters": [ { - "id": 41, + "id": 49, "name": "schema", "kind": 32768, "kindString": "Parameter", @@ -1870,23 +2075,23 @@ }, "type": { "type": "reference", - "id": 40, + "id": 48, "name": "DynamicSchema" } } ], "type": { "type": "reference", - "id": 1, + "id": 9, "typeArguments": [ { "type": "reference", - "id": 4, + "id": 12, "name": "Database" }, { "type": "reference", - "id": 40, + "id": 48, "name": "DynamicSchema" }, { @@ -1895,12 +2100,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 40, + "id": 48, "name": "DynamicSchema" }, "objectType": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -1935,17 +2140,17 @@ { "title": "Constructors", "kind": 512, - "children": [2] + "children": [10] }, { "title": "Properties", "kind": 1024, - "children": [20, 18, 19, 17] + "children": [28, 26, 27, 25] }, { "title": "Methods", "kind": 2048, - "children": [25, 42, 38] + "children": [33, 50, 46] } ], "sources": [ @@ -1957,7 +2162,7 @@ ], "typeParameter": [ { - "id": 53, + "id": 61, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -1971,7 +2176,7 @@ } }, { - "id": 54, + "id": 62, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -1991,7 +2196,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } } @@ -2008,7 +2213,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -2028,7 +2233,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } } @@ -2037,7 +2242,7 @@ } }, { - "id": 55, + "id": 63, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -2052,12 +2257,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -2069,12 +2274,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -2087,28 +2292,258 @@ ] }, { - "id": 143, + "id": 654, + "name": "PostgrestError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "Error format", + "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" + }, + "children": [ + { + "id": 655, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 2 + } + ], + "signatures": [ + { + "id": 656, + "name": "new PostgrestError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 657, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 658, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 662, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 73 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 660, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 661, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 659, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 25 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [662, 660, 661, 659] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 654, + "name": "default" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + }, + { + "id": 665, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 9, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 663, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 7, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 664, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 8, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [655] + }, + { + "title": "Properties", + "kind": 1024, + "children": [665, 663, 664] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 6, + "character": 21 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ] + }, + { + "id": 151, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 144, + "id": 152, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 145, + "id": 153, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 146, + "id": 154, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -2119,7 +2554,7 @@ } }, { - "id": 147, + "id": 155, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -2142,14 +2577,14 @@ } }, { - "id": 148, + "id": 156, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 149, + "id": 157, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -2160,7 +2595,7 @@ } }, { - "id": 150, + "id": 158, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -2173,19 +2608,23 @@ ], "parameters": [ { - "id": 151, + "id": 159, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 156, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -2194,31 +2633,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -2226,19 +2665,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 491, + "id": 493, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 490, + "id": 492, "name": "default.constructor" } }, { - "id": 461, + "id": 459, "name": "body", "kind": 1024, "kindString": "Property", @@ -2249,7 +2688,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -2259,12 +2698,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 583, "name": "default.body" } }, { - "id": 464, + "id": 462, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -2274,28 +2713,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 465, + "id": 463, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 466, + "id": 464, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 467, + "id": 465, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -2319,7 +2758,7 @@ } }, { - "id": 468, + "id": 466, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -2354,12 +2793,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 584, + "id": 586, "name": "default.fetch" } }, { - "id": 459, + "id": 457, "name": "headers", "kind": 1024, "kindString": "Property", @@ -2369,7 +2808,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -2391,12 +2830,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 581, "name": "default.headers" } }, { - "id": 469, + "id": 467, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -2406,7 +2845,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -2416,12 +2855,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 589, + "id": 591, "name": "default.isMaybeSingle" } }, { - "id": 457, + "id": 455, "name": "method", "kind": 1024, "kindString": "Property", @@ -2431,7 +2870,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -2462,12 +2901,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 579, "name": "default.method" } }, { - "id": 460, + "id": 458, "name": "schema", "kind": 1024, "kindString": "Property", @@ -2475,58 +2914,6 @@ "isProtected": true, "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 580, - "name": "default.schema" - } - }, - { - "id": 462, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 582, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 463, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", @@ -2534,6 +2921,58 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 582, + "name": "default.schema" + } + }, + { + "id": 460, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false", + "inheritedFrom": { + "type": "reference", + "id": 584, + "name": "default.shouldThrowOnError" + } + }, + { + "id": 461, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -2542,12 +2981,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 583, + "id": 585, "name": "default.signal" } }, { - "id": 458, + "id": 456, "name": "url", "kind": 1024, "kindString": "Property", @@ -2557,7 +2996,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -2569,12 +3008,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 578, + "id": 580, "name": "default.url" } }, { - "id": 429, + "id": 427, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -2588,7 +3027,7 @@ ], "signatures": [ { - "id": 430, + "id": 428, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", @@ -2598,7 +3037,7 @@ }, "parameters": [ { - "id": 431, + "id": 429, "name": "signal", "kind": 32768, "kindString": "Parameter", @@ -2616,31 +3055,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -2648,19 +3087,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 550, + "id": 552, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", - "id": 549, + "id": 551, "name": "default.abortSignal" } }, { - "id": 273, + "id": 271, "name": "containedBy", "kind": 2048, "kindString": "Method", @@ -2668,13 +3107,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 281, + "line": 342, "character": 2 } ], "signatures": [ { - "id": 274, + "id": 272, "name": "containedBy", "kind": 4096, "kindString": "Call signature", @@ -2684,7 +3123,7 @@ }, "typeParameter": [ { - "id": 275, + "id": 273, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -2697,7 +3136,7 @@ ], "parameters": [ { - "id": 276, + "id": 274, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -2707,12 +3146,12 @@ }, "type": { "type": "reference", - "id": 275, + "id": 273, "name": "ColumnName" } }, { - "id": 277, + "id": 275, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -2752,12 +3191,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 275, + "id": 273, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -2769,31 +3208,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -2801,7 +3240,7 @@ } }, { - "id": 278, + "id": 276, "name": "containedBy", "kind": 4096, "kindString": "Call signature", @@ -2811,7 +3250,7 @@ }, "parameters": [ { - "id": 279, + "id": 277, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -2825,7 +3264,7 @@ } }, { - "id": 280, + "id": 278, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -2873,31 +3312,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -2907,7 +3346,7 @@ ] }, { - "id": 265, + "id": 263, "name": "contains", "kind": 2048, "kindString": "Method", @@ -2915,13 +3354,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 254, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 266, + "id": 264, "name": "contains", "kind": 4096, "kindString": "Call signature", @@ -2931,7 +3370,7 @@ }, "typeParameter": [ { - "id": 267, + "id": 265, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -2944,7 +3383,7 @@ ], "parameters": [ { - "id": 268, + "id": 266, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -2954,12 +3393,12 @@ }, "type": { "type": "reference", - "id": 267, + "id": 265, "name": "ColumnName" } }, { - "id": 269, + "id": 267, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -2999,12 +3438,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 267, + "id": 265, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -3016,31 +3455,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -3048,7 +3487,7 @@ } }, { - "id": 270, + "id": 268, "name": "contains", "kind": 4096, "kindString": "Call signature", @@ -3058,7 +3497,7 @@ }, "parameters": [ { - "id": 271, + "id": 269, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3072,7 +3511,7 @@ } }, { - "id": 272, + "id": 270, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3120,31 +3559,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -3154,7 +3593,7 @@ ] }, { - "id": 438, + "id": 436, "name": "csv", "kind": 2048, "kindString": "Method", @@ -3168,7 +3607,7 @@ ], "signatures": [ { - "id": 439, + "id": 437, "name": "csv", "kind": 4096, "kindString": "Call signature", @@ -3178,30 +3617,34 @@ }, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "intrinsic", "name": "string" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 559, + "id": 561, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", - "id": 558, + "id": 560, "name": "default.csv" } }, { - "id": 152, + "id": 160, "name": "eq", "kind": 2048, "kindString": "Method", @@ -3209,13 +3652,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 35, + "line": 87, "character": 2 } ], "signatures": [ { - "id": 153, + "id": 161, "name": "eq", "kind": 4096, "kindString": "Call signature", @@ -3226,7 +3669,7 @@ }, "typeParameter": [ { - "id": 154, + "id": 162, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3239,7 +3682,7 @@ ], "parameters": [ { - "id": 155, + "id": 163, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3249,12 +3692,12 @@ }, "type": { "type": "reference", - "id": 154, + "id": 162, "name": "ColumnName" } }, { - "id": 156, + "id": 164, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3263,150 +3706,110 @@ "shortText": "The value to filter with\n" }, "type": { - "type": "reference", - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { "type": "reference", "id": 154, - "name": "ColumnName" + "name": "Schema" }, - "objectType": { + { "type": "reference", - "id": 147, + "id": 155, "name": "Row" + }, + { + "type": "reference", + "id": 162, + "name": "ColumnName" } - } - ], - "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 157, - "name": "eq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is equal to `value`.", - "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" - }, - "typeParameter": [ - { - "id": 158, - "name": "Value", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 159, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 160, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "intrinsic", + "name": "never" + }, + "trueType": { + "type": "intrinsic", + "name": "unknown" + }, + "falseType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 158, - "name": "Value" + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 162, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ResolvedFilterValue" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + "falseType": { + "type": "intrinsic", + "name": "never" } - ], - "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + } } } ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -3416,7 +3819,7 @@ ] }, { - "id": 442, + "id": 440, "name": "explain", "kind": 2048, "kindString": "Method", @@ -3430,7 +3833,7 @@ ], "signatures": [ { - "id": 443, + "id": 441, "name": "explain", "kind": 4096, "kindString": "Call signature", @@ -3441,7 +3844,7 @@ }, "parameters": [ { - "id": 444, + "id": 442, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -3453,14 +3856,14 @@ "type": { "type": "reflection", "declaration": { - "id": 445, + "id": 443, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 446, + "id": 444, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -3483,7 +3886,7 @@ } }, { - "id": 449, + "id": 447, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -3506,7 +3909,7 @@ } }, { - "id": 451, + "id": 449, "name": "format", "kind": 1024, "kindString": "Property", @@ -3538,7 +3941,7 @@ } }, { - "id": 448, + "id": 446, "name": "settings", "kind": 1024, "kindString": "Property", @@ -3561,7 +3964,7 @@ } }, { - "id": 447, + "id": 445, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -3584,7 +3987,7 @@ } }, { - "id": 450, + "id": 448, "name": "wal", "kind": 1024, "kindString": "Property", @@ -3611,7 +4014,7 @@ { "title": "Properties", "kind": 1024, - "children": [446, 449, 451, 448, 447, 450] + "children": [444, 447, 449, 446, 445, 448] } ] } @@ -3624,18 +4027,22 @@ "types": [ { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "intrinsic", "name": "string" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "array", @@ -3655,6 +4062,10 @@ "package": "typescript", "name": "Record" } + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -3663,19 +4074,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 563, + "id": 565, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", - "id": 562, + "id": 564, "name": "default.explain" } }, { - "id": 368, + "id": 366, "name": "filter", "kind": 2048, "kindString": "Method", @@ -3683,13 +4094,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 508, + "line": 569, "character": 2 } ], "signatures": [ { - "id": 369, + "id": 367, "name": "filter", "kind": 4096, "kindString": "Call signature", @@ -3700,7 +4111,7 @@ }, "typeParameter": [ { - "id": 370, + "id": 368, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3713,7 +4124,7 @@ ], "parameters": [ { - "id": 371, + "id": 369, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3723,12 +4134,12 @@ }, "type": { "type": "reference", - "id": 370, + "id": 368, "name": "ColumnName" } }, { - "id": 372, + "id": 370, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -3835,7 +4246,7 @@ } }, { - "id": 373, + "id": 371, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3851,31 +4262,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -3883,7 +4294,7 @@ } }, { - "id": 374, + "id": 372, "name": "filter", "kind": 4096, "kindString": "Call signature", @@ -3894,7 +4305,7 @@ }, "parameters": [ { - "id": 375, + "id": 373, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3908,7 +4319,7 @@ } }, { - "id": 376, + "id": 374, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -3922,7 +4333,7 @@ } }, { - "id": 377, + "id": 375, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3938,31 +4349,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -3972,7 +4383,7 @@ ] }, { - "id": 440, + "id": 438, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -3986,7 +4397,7 @@ ], "signatures": [ { - "id": 441, + "id": 439, "name": "geojson", "kind": 4096, "kindString": "Call signature", @@ -3996,7 +4407,7 @@ }, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", @@ -4013,25 +4424,29 @@ "qualifiedName": "Record", "package": "typescript", "name": "Record" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 561, + "id": 563, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", - "id": 560, + "id": 562, "name": "default.geojson" } }, { - "id": 169, + "id": 170, "name": "gt", "kind": 2048, "kindString": "Method", @@ -4039,13 +4454,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 66, + "line": 120, "character": 2 } ], "signatures": [ { - "id": 170, + "id": 171, "name": "gt", "kind": 4096, "kindString": "Call signature", @@ -4055,7 +4470,7 @@ }, "typeParameter": [ { - "id": 171, + "id": 172, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4068,7 +4483,7 @@ ], "parameters": [ { - "id": 172, + "id": 173, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4078,12 +4493,12 @@ }, "type": { "type": "reference", - "id": 171, + "id": 172, "name": "ColumnName" } }, { - "id": 173, + "id": 174, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4095,12 +4510,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 171, + "id": 172, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -4108,31 +4523,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -4140,7 +4555,7 @@ } }, { - "id": 174, + "id": 175, "name": "gt", "kind": 4096, "kindString": "Call signature", @@ -4150,7 +4565,7 @@ }, "parameters": [ { - "id": 175, + "id": 176, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4164,7 +4579,7 @@ } }, { - "id": 176, + "id": 177, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4180,31 +4595,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -4214,7 +4629,7 @@ ] }, { - "id": 177, + "id": 178, "name": "gte", "kind": 2048, "kindString": "Method", @@ -4222,13 +4637,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 79, + "line": 133, "character": 2 } ], "signatures": [ { - "id": 178, + "id": 179, "name": "gte", "kind": 4096, "kindString": "Call signature", @@ -4238,7 +4653,7 @@ }, "typeParameter": [ { - "id": 179, + "id": 180, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4251,7 +4666,7 @@ ], "parameters": [ { - "id": 180, + "id": 181, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4261,12 +4676,12 @@ }, "type": { "type": "reference", - "id": 179, + "id": 180, "name": "ColumnName" } }, { - "id": 181, + "id": 182, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4278,12 +4693,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 179, + "id": 180, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -4291,31 +4706,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -4323,7 +4738,7 @@ } }, { - "id": 182, + "id": 183, "name": "gte", "kind": 4096, "kindString": "Call signature", @@ -4333,7 +4748,7 @@ }, "parameters": [ { - "id": 183, + "id": 184, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4347,7 +4762,7 @@ } }, { - "id": 184, + "id": 185, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4363,31 +4778,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -4397,7 +4812,7 @@ ] }, { - "id": 225, + "id": 226, "name": "ilike", "kind": 2048, "kindString": "Method", @@ -4405,13 +4820,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 163, + "line": 217, "character": 2 } ], "signatures": [ { - "id": 226, + "id": 227, "name": "ilike", "kind": 4096, "kindString": "Call signature", @@ -4420,21 +4835,21 @@ "shortText": "Match only rows where `column` matches `pattern` case-insensitively." }, "typeParameter": [ - { - "id": 227, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ { "id": 228, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 229, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4444,12 +4859,12 @@ }, "type": { "type": "reference", - "id": 227, + "id": 228, "name": "ColumnName" } }, { - "id": 229, + "id": 230, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -4465,31 +4880,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -4497,7 +4912,7 @@ } }, { - "id": 230, + "id": 231, "name": "ilike", "kind": 4096, "kindString": "Call signature", @@ -4507,7 +4922,7 @@ }, "parameters": [ { - "id": 231, + "id": 232, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4521,7 +4936,7 @@ } }, { - "id": 232, + "id": 233, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -4537,31 +4952,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -4571,387 +4986,11 @@ ] }, { - "id": 233, + "id": 234, "name": "ilikeAllOf", "kind": 2048, "kindString": "Method", "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 176, - "character": 2 - } - ], - "signatures": [ - { - "id": 234, - "name": "ilikeAllOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." - }, - "typeParameter": [ - { - "id": 235, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 236, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 235, - "name": "ColumnName" - } - }, - { - "id": 237, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 238, - "name": "ilikeAllOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." - }, - "parameters": [ - { - "id": 239, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 240, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 241, - "name": "ilikeAnyOf", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 192, - "character": 2 - } - ], - "signatures": [ - { - "id": 242, - "name": "ilikeAnyOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." - }, - "typeParameter": [ - { - "id": 243, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 244, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 243, - "name": "ColumnName" - } - }, - { - "id": 245, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 246, - "name": "ilikeAnyOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." - }, - "parameters": [ - { - "id": 247, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 248, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 257, - "name": "in", - "kind": 2048, - "kindString": "Method", - "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", @@ -4961,17 +5000,17 @@ ], "signatures": [ { - "id": 258, - "name": "in", + "id": 235, + "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." + "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." }, "typeParameter": [ { - "id": 259, + "id": 236, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4984,7 +5023,7 @@ ], "parameters": [ { - "id": 260, + "id": 237, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4994,18 +5033,18 @@ }, "type": { "type": "reference", - "id": 259, + "id": 236, "name": "ColumnName" } }, { - "id": 261, - "name": "values", + "id": 238, + "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values array to filter with\n" + "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", @@ -5013,17 +5052,8 @@ "target": { "type": "array", "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 259, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 147, - "name": "Row" - } + "type": "intrinsic", + "name": "string" } } } @@ -5031,31 +5061,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5063,17 +5093,17 @@ } }, { - "id": 262, - "name": "in", + "id": 239, + "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." + "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." }, "parameters": [ { - "id": 263, + "id": 240, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5087,7 +5117,304 @@ } }, { - "id": 264, + "id": 241, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 242, + "name": "ilikeAnyOf", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 246, + "character": 2 + } + ], + "signatures": [ + { + "id": 243, + "name": "ilikeAnyOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + }, + "typeParameter": [ + { + "id": 244, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 245, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 244, + "name": "ColumnName" + } + }, + { + "id": 246, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 247, + "name": "ilikeAnyOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + }, + "parameters": [ + { + "id": 248, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 249, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 258, + "name": "in", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 290, + "character": 2 + } + ], + "signatures": [ + { + "id": 259, + "name": "in", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is included in the `values` array." + }, + "typeParameter": [ + { + "id": 260, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 261, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 260, + "name": "ColumnName" + } + }, + { + "id": 262, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -5101,8 +5428,72 @@ "target": { "type": "array", "elementType": { - "type": "intrinsic", - "name": "unknown" + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 260, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "intrinsic", + "name": "never" + }, + "trueType": { + "type": "intrinsic", + "name": "unknown" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 260, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "trueType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } } } } @@ -5110,31 +5501,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5144,7 +5535,7 @@ ] }, { - "id": 249, + "id": 250, "name": "is", "kind": 2048, "kindString": "Method", @@ -5152,13 +5543,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 208, + "line": 262, "character": 2 } ], "signatures": [ { - "id": 250, + "id": 251, "name": "is", "kind": 4096, "kindString": "Call signature", @@ -5169,7 +5560,7 @@ }, "typeParameter": [ { - "id": 251, + "id": 252, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5182,7 +5573,7 @@ ], "parameters": [ { - "id": 252, + "id": 253, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5192,12 +5583,12 @@ }, "type": { "type": "reference", - "id": 251, + "id": 252, "name": "ColumnName" } }, { - "id": 253, + "id": 254, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -5215,12 +5606,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 251, + "id": 252, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } }, @@ -5237,12 +5628,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 251, + "id": 252, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } }, @@ -5259,12 +5650,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 251, + "id": 252, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } }, @@ -5280,31 +5671,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5312,7 +5703,7 @@ } }, { - "id": 254, + "id": 255, "name": "is", "kind": 4096, "kindString": "Call signature", @@ -5323,7 +5714,7 @@ }, "parameters": [ { - "id": 255, + "id": 256, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5337,7 +5728,7 @@ } }, { - "id": 256, + "id": 257, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -5362,31 +5753,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5396,7 +5787,7 @@ ] }, { - "id": 201, + "id": 202, "name": "like", "kind": 2048, "kindString": "Method", @@ -5404,13 +5795,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 118, + "line": 172, "character": 2 } ], "signatures": [ { - "id": 202, + "id": 203, "name": "like", "kind": 4096, "kindString": "Call signature", @@ -5420,7 +5811,7 @@ }, "typeParameter": [ { - "id": 203, + "id": 204, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5433,7 +5824,7 @@ ], "parameters": [ { - "id": 204, + "id": 205, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5443,12 +5834,12 @@ }, "type": { "type": "reference", - "id": 203, + "id": 204, "name": "ColumnName" } }, { - "id": 205, + "id": 206, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -5464,31 +5855,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5496,7 +5887,7 @@ } }, { - "id": 206, + "id": 207, "name": "like", "kind": 4096, "kindString": "Call signature", @@ -5506,7 +5897,7 @@ }, "parameters": [ { - "id": 207, + "id": 208, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5520,7 +5911,7 @@ } }, { - "id": 208, + "id": 209, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -5536,31 +5927,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5570,7 +5961,7 @@ ] }, { - "id": 209, + "id": 210, "name": "likeAllOf", "kind": 2048, "kindString": "Method", @@ -5578,13 +5969,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 131, + "line": 185, "character": 2 } ], "signatures": [ { - "id": 210, + "id": 211, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", @@ -5594,7 +5985,7 @@ }, "typeParameter": [ { - "id": 211, + "id": 212, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5607,7 +5998,7 @@ ], "parameters": [ { - "id": 212, + "id": 213, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5617,12 +6008,12 @@ }, "type": { "type": "reference", - "id": 211, + "id": 212, "name": "ColumnName" } }, { - "id": 213, + "id": 214, "name": "patterns", "kind": 32768, "kindString": "Parameter", @@ -5645,31 +6036,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5677,7 +6068,7 @@ } }, { - "id": 214, + "id": 215, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", @@ -5687,7 +6078,7 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5701,7 +6092,7 @@ } }, { - "id": 216, + "id": 217, "name": "patterns", "kind": 32768, "kindString": "Parameter", @@ -5724,31 +6115,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5758,7 +6149,7 @@ ] }, { - "id": 217, + "id": 218, "name": "likeAnyOf", "kind": 2048, "kindString": "Method", @@ -5766,13 +6157,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 147, + "line": 201, "character": 2 } ], "signatures": [ { - "id": 218, + "id": 219, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", @@ -5782,7 +6173,7 @@ }, "typeParameter": [ { - "id": 219, + "id": 220, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5795,7 +6186,7 @@ ], "parameters": [ { - "id": 220, + "id": 221, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5805,12 +6196,12 @@ }, "type": { "type": "reference", - "id": 219, + "id": 220, "name": "ColumnName" } }, { - "id": 221, + "id": 222, "name": "patterns", "kind": 32768, "kindString": "Parameter", @@ -5833,31 +6224,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5865,7 +6256,7 @@ } }, { - "id": 222, + "id": 223, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", @@ -5875,7 +6266,7 @@ }, "parameters": [ { - "id": 223, + "id": 224, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5889,7 +6280,7 @@ } }, { - "id": 224, + "id": 225, "name": "patterns", "kind": 32768, "kindString": "Parameter", @@ -5912,31 +6303,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5946,7 +6337,7 @@ ] }, { - "id": 414, + "id": 412, "name": "limit", "kind": 2048, "kindString": "Method", @@ -5960,7 +6351,7 @@ ], "signatures": [ { - "id": 415, + "id": 413, "name": "limit", "kind": 4096, "kindString": "Call signature", @@ -5970,7 +6361,7 @@ }, "parameters": [ { - "id": 416, + "id": 414, "name": "count", "kind": 32768, "kindString": "Parameter", @@ -5984,7 +6375,7 @@ } }, { - "id": 417, + "id": 415, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5996,14 +6387,14 @@ "type": { "type": "reflection", "declaration": { - "id": 418, + "id": 416, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 419, + "id": 417, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -6026,7 +6417,7 @@ } }, { - "id": 420, + "id": 418, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -6053,7 +6444,7 @@ { "title": "Properties", "kind": 1024, - "children": [419, 420] + "children": [417, 418] } ] } @@ -6063,31 +6454,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6095,19 +6486,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 535, + "id": 537, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", - "id": 534, + "id": 536, "name": "default.limit" } }, { - "id": 185, + "id": 186, "name": "lt", "kind": 2048, "kindString": "Method", @@ -6115,13 +6506,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 92, + "line": 146, "character": 2 } ], "signatures": [ { - "id": 186, + "id": 187, "name": "lt", "kind": 4096, "kindString": "Call signature", @@ -6131,7 +6522,7 @@ }, "typeParameter": [ { - "id": 187, + "id": 188, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6144,7 +6535,7 @@ ], "parameters": [ { - "id": 188, + "id": 189, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6154,12 +6545,12 @@ }, "type": { "type": "reference", - "id": 187, + "id": 188, "name": "ColumnName" } }, { - "id": 189, + "id": 190, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -6171,12 +6562,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 187, + "id": 188, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -6184,31 +6575,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6216,7 +6607,7 @@ } }, { - "id": 190, + "id": 191, "name": "lt", "kind": 4096, "kindString": "Call signature", @@ -6226,7 +6617,7 @@ }, "parameters": [ { - "id": 191, + "id": 192, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6240,7 +6631,7 @@ } }, { - "id": 192, + "id": 193, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -6256,31 +6647,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6290,7 +6681,7 @@ ] }, { - "id": 193, + "id": 194, "name": "lte", "kind": 2048, "kindString": "Method", @@ -6298,13 +6689,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 105, + "line": 159, "character": 2 } ], "signatures": [ { - "id": 194, + "id": 195, "name": "lte", "kind": 4096, "kindString": "Call signature", @@ -6314,7 +6705,7 @@ }, "typeParameter": [ { - "id": 195, + "id": 196, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6327,7 +6718,7 @@ ], "parameters": [ { - "id": 196, + "id": 197, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6337,12 +6728,12 @@ }, "type": { "type": "reference", - "id": 195, + "id": 196, "name": "ColumnName" } }, { - "id": 197, + "id": 198, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -6354,12 +6745,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 195, + "id": 196, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -6367,31 +6758,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6399,7 +6790,7 @@ } }, { - "id": 198, + "id": 199, "name": "lte", "kind": 4096, "kindString": "Call signature", @@ -6409,7 +6800,7 @@ }, "parameters": [ { - "id": 199, + "id": 200, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6423,7 +6814,7 @@ } }, { - "id": 200, + "id": 201, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -6439,31 +6830,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6473,7 +6864,7 @@ ] }, { - "id": 345, + "id": 343, "name": "match", "kind": 2048, "kindString": "Method", @@ -6481,13 +6872,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 441, + "line": 502, "character": 2 } ], "signatures": [ { - "id": 346, + "id": 344, "name": "match", "kind": 4096, "kindString": "Call signature", @@ -6497,7 +6888,7 @@ }, "typeParameter": [ { - "id": 347, + "id": 345, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6510,7 +6901,7 @@ ], "parameters": [ { - "id": 348, + "id": 346, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -6523,19 +6914,19 @@ "typeArguments": [ { "type": "reference", - "id": 347, + "id": 345, "name": "ColumnName" }, { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 347, + "id": 345, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -6548,31 +6939,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6580,7 +6971,7 @@ } }, { - "id": 349, + "id": 347, "name": "match", "kind": 4096, "kindString": "Call signature", @@ -6590,7 +6981,7 @@ }, "parameters": [ { - "id": 350, + "id": 348, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -6618,31 +7009,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6652,7 +7043,7 @@ ] }, { - "id": 435, + "id": 433, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -6666,7 +7057,7 @@ ], "signatures": [ { - "id": 436, + "id": 434, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", @@ -6677,7 +7068,7 @@ }, "typeParameter": [ { - "id": 437, + "id": 435, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -6686,7 +7077,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, "extendsType": { @@ -6709,7 +7100,7 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "union", @@ -6720,29 +7111,33 @@ }, { "type": "reference", - "id": 437, + "id": 435, "name": "ResultOne" } ] + }, + { + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 556, + "id": 558, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", - "id": 555, + "id": 557, "name": "default.maybeSingle" } }, { - "id": 161, + "id": 165, "name": "neq", "kind": 2048, "kindString": "Method", @@ -6750,13 +7145,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 53, + "line": 108, "character": 2 } ], "signatures": [ { - "id": 162, + "id": 166, "name": "neq", "kind": 4096, "kindString": "Call signature", @@ -6766,7 +7161,7 @@ }, "typeParameter": [ { - "id": 163, + "id": 167, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6779,7 +7174,7 @@ ], "parameters": [ { - "id": 164, + "id": 168, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6789,12 +7184,12 @@ }, "type": { "type": "reference", - "id": 163, + "id": 167, "name": "ColumnName" } }, { - "id": 165, + "id": 169, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -6803,119 +7198,102 @@ "shortText": "The value to filter with\n" }, "type": { - "type": "indexedAccess", - "indexType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 163, - "name": "ColumnName" + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 167, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" }, - "objectType": { - "type": "reference", - "id": 147, - "name": "Row" + "extendsType": { + "type": "intrinsic", + "name": "never" + }, + "trueType": { + "type": "intrinsic", + "name": "unknown" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 167, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "trueType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } } } } ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 166, - "name": "neq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is not equal to `value`." - }, - "parameters": [ - { - "id": 167, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 168, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6925,7 +7303,7 @@ ] }, { - "id": 351, + "id": 349, "name": "not", "kind": 2048, "kindString": "Method", @@ -6933,13 +7311,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 457, + "line": 518, "character": 2 } ], "signatures": [ { - "id": 352, + "id": 350, "name": "not", "kind": 4096, "kindString": "Call signature", @@ -6950,7 +7328,7 @@ }, "typeParameter": [ { - "id": 353, + "id": 351, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6963,7 +7341,7 @@ ], "parameters": [ { - "id": 354, + "id": 352, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6973,12 +7351,12 @@ }, "type": { "type": "reference", - "id": 353, + "id": 351, "name": "ColumnName" } }, { - "id": 355, + "id": 353, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -6992,7 +7370,7 @@ } }, { - "id": 356, + "id": 354, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -7004,12 +7382,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 353, + "id": 351, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -7017,31 +7395,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7049,7 +7427,7 @@ } }, { - "id": 357, + "id": 355, "name": "not", "kind": 4096, "kindString": "Call signature", @@ -7060,7 +7438,7 @@ }, "parameters": [ { - "id": 358, + "id": 356, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7074,7 +7452,7 @@ } }, { - "id": 359, + "id": 357, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -7088,7 +7466,7 @@ } }, { - "id": 360, + "id": 358, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -7104,31 +7482,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7138,7 +7516,7 @@ ] }, { - "id": 361, + "id": 359, "name": "or", "kind": 2048, "kindString": "Method", @@ -7146,13 +7524,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 496, + "line": 557, "character": 2 } ], "signatures": [ { - "id": 362, + "id": 360, "name": "or", "kind": 4096, "kindString": "Call signature", @@ -7163,7 +7541,7 @@ }, "parameters": [ { - "id": 363, + "id": 361, "name": "filters", "kind": 32768, "kindString": "Parameter", @@ -7177,7 +7555,7 @@ } }, { - "id": 364, + "id": 362, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7189,14 +7567,14 @@ "type": { "type": "reflection", "declaration": { - "id": 365, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 366, + "id": 364, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -7209,7 +7587,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 501, + "line": 562, "character": 9 } ], @@ -7219,7 +7597,7 @@ } }, { - "id": 367, + "id": 365, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -7232,7 +7610,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 501, + "line": 562, "character": 32 } ], @@ -7246,7 +7624,7 @@ { "title": "Properties", "kind": 1024, - "children": [366, 367] + "children": [364, 365] } ] } @@ -7256,31 +7634,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7290,7 +7668,7 @@ ] }, { - "id": 383, + "id": 381, "name": "order", "kind": 2048, "kindString": "Method", @@ -7304,7 +7682,7 @@ ], "signatures": [ { - "id": 384, + "id": 382, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -7314,36 +7692,36 @@ "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "typeParameter": [ + { + "id": 383, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 384, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 383, + "name": "ColumnName" + } + }, { "id": 385, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 386, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 385, - "name": "ColumnName" - } - }, - { - "id": 387, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7356,14 +7734,14 @@ "type": { "type": "reflection", "declaration": { - "id": 388, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 389, + "id": 387, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -7386,7 +7764,7 @@ } }, { - "id": 390, + "id": 388, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -7409,7 +7787,7 @@ } }, { - "id": 391, + "id": 389, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -7436,7 +7814,7 @@ { "title": "Properties", "kind": 1024, - "children": [389, 390, 391] + "children": [387, 388, 389] } ] } @@ -7445,31 +7823,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7477,12 +7855,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 504, + "id": 506, "name": "default.order" } }, { - "id": 392, + "id": 390, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -7493,7 +7871,7 @@ }, "parameters": [ { - "id": 393, + "id": 391, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7507,7 +7885,7 @@ } }, { - "id": 394, + "id": 392, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7520,14 +7898,14 @@ "type": { "type": "reflection", "declaration": { - "id": 395, + "id": 393, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 396, + "id": 394, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -7550,7 +7928,7 @@ } }, { - "id": 397, + "id": 395, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -7573,7 +7951,7 @@ } }, { - "id": 398, + "id": 396, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -7600,7 +7978,7 @@ { "title": "Properties", "kind": 1024, - "children": [396, 397, 398] + "children": [394, 395, 396] } ] } @@ -7609,31 +7987,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7641,12 +8019,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 512, + "id": 514, "name": "default.order" } }, { - "id": 399, + "id": 397, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -7663,7 +8041,7 @@ }, "typeParameter": [ { - "id": 400, + "id": 398, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7676,7 +8054,7 @@ ], "parameters": [ { - "id": 401, + "id": 399, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7686,12 +8064,12 @@ }, "type": { "type": "reference", - "id": 400, + "id": 398, "name": "ColumnName" } }, { - "id": 402, + "id": 400, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7704,14 +8082,14 @@ "type": { "type": "reflection", "declaration": { - "id": 403, + "id": 401, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 404, + "id": 402, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -7731,7 +8109,7 @@ } }, { - "id": 406, + "id": 404, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -7751,7 +8129,7 @@ } }, { - "id": 405, + "id": 403, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -7775,7 +8153,7 @@ { "title": "Properties", "kind": 1024, - "children": [404, 406, 405] + "children": [402, 404, 403] } ] } @@ -7784,31 +8162,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7816,12 +8194,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 519, + "id": 521, "name": "default.order" } }, { - "id": 407, + "id": 405, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -7838,7 +8216,7 @@ }, "parameters": [ { - "id": 408, + "id": 406, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7852,7 +8230,7 @@ } }, { - "id": 409, + "id": 407, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7865,14 +8243,14 @@ "type": { "type": "reflection", "declaration": { - "id": 410, + "id": 408, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 411, + "id": 409, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -7892,7 +8270,7 @@ } }, { - "id": 413, + "id": 411, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -7912,7 +8290,7 @@ } }, { - "id": 412, + "id": 410, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -7936,7 +8314,7 @@ { "title": "Properties", "kind": 1024, - "children": [411, 413, 412] + "children": [409, 411, 410] } ] } @@ -7945,31 +8323,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7977,19 +8355,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 527, + "id": 529, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", - "id": 503, + "id": 505, "name": "default.order" } }, { - "id": 321, + "id": 319, "name": "overlaps", "kind": 2048, "kindString": "Method", @@ -7997,13 +8375,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 380, + "line": 441, "character": 2 } ], "signatures": [ { - "id": 322, + "id": 320, "name": "overlaps", "kind": 4096, "kindString": "Call signature", @@ -8013,7 +8391,7 @@ }, "typeParameter": [ { - "id": 323, + "id": 321, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8026,7 +8404,7 @@ ], "parameters": [ { - "id": 324, + "id": 322, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8036,12 +8414,12 @@ }, "type": { "type": "reference", - "id": 323, + "id": 321, "name": "ColumnName" } }, { - "id": 325, + "id": 323, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -8065,12 +8443,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 323, + "id": 321, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -8082,31 +8460,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8114,7 +8492,7 @@ } }, { - "id": 326, + "id": 324, "name": "overlaps", "kind": 4096, "kindString": "Call signature", @@ -8124,7 +8502,7 @@ }, "parameters": [ { - "id": 327, + "id": 325, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8138,7 +8516,7 @@ } }, { - "id": 328, + "id": 326, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -8170,31 +8548,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8204,7 +8582,7 @@ ] }, { - "id": 421, + "id": 419, "name": "range", "kind": 2048, "kindString": "Method", @@ -8218,17 +8596,17 @@ ], "signatures": [ { - "id": 422, + "id": 420, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by starting at an offset (`from`) and ending at the offset (`from + 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." + "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." }, "parameters": [ { - "id": 423, + "id": 421, "name": "from", "kind": 32768, "kindString": "Parameter", @@ -8242,7 +8620,7 @@ } }, { - "id": 424, + "id": 422, "name": "to", "kind": 32768, "kindString": "Parameter", @@ -8256,7 +8634,7 @@ } }, { - "id": 425, + "id": 423, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -8268,14 +8646,14 @@ "type": { "type": "reflection", "declaration": { - "id": 426, + "id": 424, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 427, + "id": 425, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -8298,7 +8676,7 @@ } }, { - "id": 428, + "id": 426, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -8325,7 +8703,7 @@ { "title": "Properties", "kind": 1024, - "children": [427, 428] + "children": [425, 426] } ] } @@ -8335,31 +8713,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8367,19 +8745,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 542, + "id": 544, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", - "id": 541, + "id": 543, "name": "default.range" } }, { - "id": 313, + "id": 311, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", @@ -8387,13 +8765,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 365, + "line": 426, "character": 2 } ], "signatures": [ { - "id": 314, + "id": 312, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", @@ -8403,7 +8781,7 @@ }, "typeParameter": [ { - "id": 315, + "id": 313, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8416,7 +8794,7 @@ ], "parameters": [ { - "id": 316, + "id": 314, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8426,12 +8804,12 @@ }, "type": { "type": "reference", - "id": 315, + "id": 313, "name": "ColumnName" } }, { - "id": 317, + "id": 315, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -8447,31 +8825,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8479,7 +8857,7 @@ } }, { - "id": 318, + "id": 316, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", @@ -8489,7 +8867,7 @@ }, "parameters": [ { - "id": 319, + "id": 317, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8503,7 +8881,7 @@ } }, { - "id": 320, + "id": 318, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -8519,31 +8897,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8553,7 +8931,7 @@ ] }, { - "id": 281, + "id": 279, "name": "rangeGt", "kind": 2048, "kindString": "Method", @@ -8561,13 +8939,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 307, + "line": 368, "character": 2 } ], "signatures": [ { - "id": 282, + "id": 280, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", @@ -8577,7 +8955,7 @@ }, "typeParameter": [ { - "id": 283, + "id": 281, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8590,7 +8968,7 @@ ], "parameters": [ { - "id": 284, + "id": 282, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8600,12 +8978,12 @@ }, "type": { "type": "reference", - "id": 283, + "id": 281, "name": "ColumnName" } }, { - "id": 285, + "id": 283, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -8621,31 +8999,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8653,7 +9031,7 @@ } }, { - "id": 286, + "id": 284, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", @@ -8663,7 +9041,7 @@ }, "parameters": [ { - "id": 287, + "id": 285, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8677,7 +9055,7 @@ } }, { - "id": 288, + "id": 286, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -8693,31 +9071,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8727,7 +9105,7 @@ ] }, { - "id": 289, + "id": 287, "name": "rangeGte", "kind": 2048, "kindString": "Method", @@ -8735,13 +9113,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 321, + "line": 382, "character": 2 } ], "signatures": [ { - "id": 290, + "id": 288, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", @@ -8751,7 +9129,7 @@ }, "typeParameter": [ { - "id": 291, + "id": 289, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8764,7 +9142,7 @@ ], "parameters": [ { - "id": 292, + "id": 290, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8774,12 +9152,12 @@ }, "type": { "type": "reference", - "id": 291, + "id": 289, "name": "ColumnName" } }, { - "id": 293, + "id": 291, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -8795,31 +9173,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8827,7 +9205,7 @@ } }, { - "id": 294, + "id": 292, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", @@ -8837,7 +9215,7 @@ }, "parameters": [ { - "id": 295, + "id": 293, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8851,7 +9229,7 @@ } }, { - "id": 296, + "id": 294, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -8867,31 +9245,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8901,7 +9279,7 @@ ] }, { - "id": 297, + "id": 295, "name": "rangeLt", "kind": 2048, "kindString": "Method", @@ -8909,13 +9287,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 336, + "line": 397, "character": 2 } ], "signatures": [ { - "id": 298, + "id": 296, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", @@ -8925,7 +9303,7 @@ }, "typeParameter": [ { - "id": 299, + "id": 297, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8938,7 +9316,7 @@ ], "parameters": [ { - "id": 300, + "id": 298, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8948,12 +9326,12 @@ }, "type": { "type": "reference", - "id": 299, + "id": 297, "name": "ColumnName" } }, { - "id": 301, + "id": 299, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -8969,31 +9347,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9001,7 +9379,7 @@ } }, { - "id": 302, + "id": 300, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", @@ -9011,7 +9389,7 @@ }, "parameters": [ { - "id": 303, + "id": 301, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9025,7 +9403,7 @@ } }, { - "id": 304, + "id": 302, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -9041,31 +9419,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9075,7 +9453,7 @@ ] }, { - "id": 305, + "id": 303, "name": "rangeLte", "kind": 2048, "kindString": "Method", @@ -9083,13 +9461,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 350, + "line": 411, "character": 2 } ], "signatures": [ { - "id": 306, + "id": 304, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", @@ -9099,7 +9477,7 @@ }, "typeParameter": [ { - "id": 307, + "id": 305, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9112,7 +9490,7 @@ ], "parameters": [ { - "id": 308, + "id": 306, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9122,12 +9500,12 @@ }, "type": { "type": "reference", - "id": 307, + "id": 305, "name": "ColumnName" } }, { - "id": 309, + "id": 307, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -9143,31 +9521,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9175,7 +9553,7 @@ } }, { - "id": 310, + "id": 308, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", @@ -9185,7 +9563,7 @@ }, "parameters": [ { - "id": 311, + "id": 309, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9199,7 +9577,7 @@ } }, { - "id": 312, + "id": 310, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -9215,31 +9593,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9249,7 +9627,7 @@ ] }, { - "id": 454, + "id": 452, "name": "returns", "kind": 2048, "kindString": "Method", @@ -9263,7 +9641,7 @@ ], "signatures": [ { - "id": 455, + "id": 453, "name": "returns", "kind": 4096, "kindString": "Call signature", @@ -9273,7 +9651,7 @@ }, "typeParameter": [ { - "id": 456, + "id": 454, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", @@ -9285,31 +9663,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 456, + "id": 454, "name": "NewResult" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9317,19 +9695,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 575, + "id": 577, "name": "default.returns" } } ], "inheritedFrom": { "type": "reference", - "id": 574, + "id": 576, "name": "default.returns" } }, { - "id": 452, + "id": 450, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -9343,7 +9721,7 @@ ], "signatures": [ { - "id": 453, + "id": 451, "name": "rollback", "kind": 4096, "kindString": "Call signature", @@ -9354,31 +9732,31 @@ }, "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9386,19 +9764,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 573, + "id": 575, "name": "default.rollback" } } ], "inheritedFrom": { "type": "reference", - "id": 572, + "id": 574, "name": "default.rollback" } }, { - "id": 378, + "id": 376, "name": "select", "kind": 2048, "kindString": "Method", @@ -9412,7 +9790,7 @@ ], "signatures": [ { - "id": 379, + "id": 377, "name": "select", "kind": 4096, "kindString": "Call signature", @@ -9423,7 +9801,7 @@ }, "typeParameter": [ { - "id": 380, + "id": 378, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -9438,37 +9816,38 @@ } }, { - "id": 381, + "id": 379, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", + "id": 685, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" }, { "type": "reference", - "id": 380, + "id": 378, "name": "Query" } ], @@ -9478,7 +9857,7 @@ ], "parameters": [ { - "id": 382, + "id": 380, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -9490,41 +9869,41 @@ }, "type": { "type": "reference", - "id": 380, + "id": 378, "name": "Query" } } ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 381, + "id": 379, "name": "NewResultOne" } }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9532,19 +9911,111 @@ }, "inheritedFrom": { "type": "reference", - "id": 499, + "id": 501, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", - "id": 498, + "id": 500, "name": "default.select" } }, { - "id": 432, + "id": 470, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 471, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 472, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 473, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 595, + "name": "default.setHeader" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 594, + "name": "default.setHeader" + } + }, + { + "id": 430, "name": "single", "kind": 2048, "kindString": "Method", @@ -9558,7 +10029,7 @@ ], "signatures": [ { - "id": 433, + "id": 431, "name": "single", "kind": 4096, "kindString": "Call signature", @@ -9569,7 +10040,7 @@ }, "typeParameter": [ { - "id": 434, + "id": 432, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -9578,7 +10049,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, "extendsType": { @@ -9601,31 +10072,35 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 434, + "id": 432, "name": "ResultOne" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 553, + "id": 555, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", - "id": 552, + "id": 554, "name": "default.single" } }, { - "id": 329, + "id": 327, "name": "textSearch", "kind": 2048, "kindString": "Method", @@ -9633,13 +10108,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 403, + "line": 464, "character": 2 } ], "signatures": [ { - "id": 330, + "id": 328, "name": "textSearch", "kind": 4096, "kindString": "Call signature", @@ -9649,7 +10124,7 @@ }, "typeParameter": [ { - "id": 331, + "id": 329, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9662,7 +10137,7 @@ ], "parameters": [ { - "id": 332, + "id": 330, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9672,12 +10147,12 @@ }, "type": { "type": "reference", - "id": 331, + "id": 329, "name": "ColumnName" } }, { - "id": 333, + "id": 331, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -9691,7 +10166,7 @@ } }, { - "id": 334, + "id": 332, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -9704,14 +10179,14 @@ "type": { "type": "reflection", "declaration": { - "id": 335, + "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 336, + "id": 334, "name": "config", "kind": 1024, "kindString": "Property", @@ -9724,7 +10199,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 406, + "line": 467, "character": 16 } ], @@ -9734,7 +10209,7 @@ } }, { - "id": 337, + "id": 335, "name": "type", "kind": 1024, "kindString": "Property", @@ -9747,7 +10222,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 406, + "line": 467, "character": 33 } ], @@ -9774,7 +10249,7 @@ { "title": "Properties", "kind": 1024, - "children": [336, 337] + "children": [334, 335] } ] } @@ -9783,31 +10258,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9815,7 +10290,7 @@ } }, { - "id": 338, + "id": 336, "name": "textSearch", "kind": 4096, "kindString": "Call signature", @@ -9825,7 +10300,7 @@ }, "parameters": [ { - "id": 339, + "id": 337, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9839,7 +10314,7 @@ } }, { - "id": 340, + "id": 338, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -9853,7 +10328,7 @@ } }, { - "id": 341, + "id": 339, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -9866,14 +10341,14 @@ "type": { "type": "reflection", "declaration": { - "id": 342, + "id": 340, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 343, + "id": 341, "name": "config", "kind": 1024, "kindString": "Property", @@ -9886,7 +10361,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 411, + "line": 472, "character": 16 } ], @@ -9896,7 +10371,7 @@ } }, { - "id": 344, + "id": 342, "name": "type", "kind": 1024, "kindString": "Property", @@ -9909,7 +10384,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 411, + "line": 472, "character": 33 } ], @@ -9936,7 +10411,7 @@ { "title": "Properties", "kind": 1024, - "children": [343, 344] + "children": [341, 342] } ] } @@ -9945,31 +10420,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9979,7 +10454,7 @@ ] }, { - "id": 472, + "id": 474, "name": "then", "kind": 2048, "kindString": "Method", @@ -9987,31 +10462,31 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 473, + "id": 475, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 474, + "id": 476, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 156, "name": "Result" } ], @@ -10019,7 +10494,7 @@ } }, { - "id": 475, + "id": 477, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -10032,7 +10507,7 @@ ], "parameters": [ { - "id": 476, + "id": 478, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -10049,32 +10524,32 @@ { "type": "reflection", "declaration": { - "id": 477, + "id": 479, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 478, + "id": 480, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 479, + "id": 481, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 156, "name": "Result" } ], @@ -10087,7 +10562,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -10095,7 +10570,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -10113,7 +10588,7 @@ } }, { - "id": 480, + "id": 482, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -10130,21 +10605,21 @@ { "type": "reflection", "declaration": { - "id": 481, + "id": 483, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 482, + "id": 484, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 483, + "id": 485, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -10160,7 +10635,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -10168,7 +10643,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -10194,12 +10669,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -10211,19 +10686,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 593, + "id": 599, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 592, + "id": 598, "name": "default.then" } }, { - "id": 470, + "id": 468, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -10231,13 +10706,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 471, + "id": 469, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -10247,47 +10722,68 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 143, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 146, - "name": "Schema" + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" }, { "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] }, "inheritedFrom": { "type": "reference", - "id": 591, + "id": 593, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 590, + "id": 592, "name": "default.throwOnError" } } @@ -10296,33 +10792,33 @@ { "title": "Constructors", "kind": 512, - "children": [144] + "children": [152] }, { "title": "Properties", "kind": 1024, - "children": [461, 464, 459, 469, 457, 460, 462, 463, 458] + "children": [459, 462, 457, 467, 455, 458, 460, 461, 456] }, { "title": "Methods", "kind": 2048, "children": [ - 429, 273, 265, 438, 152, 442, 368, 440, 169, 177, 225, 233, 241, 257, 249, 201, 209, - 217, 414, 185, 193, 345, 435, 161, 351, 361, 383, 321, 421, 313, 281, 289, 297, 305, - 454, 452, 378, 432, 329, 472, 470 + 427, 271, 263, 436, 160, 440, 366, 438, 170, 178, 226, 234, 242, 258, 250, 202, 210, + 218, 412, 186, 194, 343, 433, 165, 349, 359, 381, 319, 419, 311, 279, 287, 295, 303, + 452, 450, 376, 470, 430, 327, 474, 468 ] } ], "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 28, + "line": 72, "character": 21 } ], "typeParameter": [ { - "id": 484, + "id": 486, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -10333,7 +10829,7 @@ } }, { - "id": 485, + "id": 487, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -10356,14 +10852,14 @@ } }, { - "id": 486, + "id": 488, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 487, + "id": 489, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -10374,7 +10870,7 @@ } }, { - "id": 488, + "id": 490, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -10388,31 +10884,31 @@ "extendedTypes": [ { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -10421,14 +10917,14 @@ ] }, { - "id": 56, + "id": 64, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 57, + "id": 65, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -10442,14 +10938,14 @@ ], "signatures": [ { - "id": 58, + "id": 66, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 59, + "id": 67, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -10460,7 +10956,7 @@ } }, { - "id": 60, + "id": 68, "name": "Relation", "kind": 131072, "kindString": "Type parameter", @@ -10480,7 +10976,7 @@ } }, { - "id": 61, + "id": 69, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -10491,7 +10987,7 @@ } }, { - "id": 64, + "id": 72, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -10500,20 +10996,20 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { - "id": 62, + "id": 70, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 63, + "id": 71, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -10535,7 +11031,7 @@ { "title": "Properties", "kind": 1024, - "children": [63] + "children": [71] } ] } @@ -10553,7 +11049,7 @@ ], "parameters": [ { - "id": 65, + "id": 73, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -10566,7 +11062,7 @@ } }, { - "id": 66, + "id": 74, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -10574,14 +11070,14 @@ "type": { "type": "reflection", "declaration": { - "id": 67, + "id": 75, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 70, + "id": 78, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -10598,21 +11094,21 @@ "type": { "type": "reflection", "declaration": { - "id": 71, + "id": 79, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 72, + "id": 80, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 73, + "id": 81, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -10636,7 +11132,7 @@ } }, { - "id": 74, + "id": 82, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -10671,7 +11167,7 @@ } }, { - "id": 68, + "id": 76, "name": "headers", "kind": 1024, "kindString": "Property", @@ -10703,7 +11199,7 @@ } }, { - "id": 69, + "id": 77, "name": "schema", "kind": 1024, "kindString": "Property", @@ -10727,7 +11223,7 @@ { "title": "Properties", "kind": 1024, - "children": [70, 68, 69] + "children": [78, 76, 77] } ] } @@ -10736,26 +11232,26 @@ ], "type": { "type": "reference", - "id": 56, + "id": 64, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -10765,7 +11261,7 @@ ] }, { - "id": 79, + "id": 87, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -10782,21 +11278,21 @@ "type": { "type": "reflection", "declaration": { - "id": 80, + "id": 88, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 81, + "id": 89, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 82, + "id": 90, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -10820,7 +11316,7 @@ } }, { - "id": 83, + "id": 91, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -10855,7 +11351,7 @@ } }, { - "id": 76, + "id": 84, "name": "headers", "kind": 1024, "kindString": "Property", @@ -10885,7 +11381,7 @@ } }, { - "id": 77, + "id": 85, "name": "schema", "kind": 1024, "kindString": "Property", @@ -10905,7 +11401,7 @@ } }, { - "id": 78, + "id": 86, "name": "signal", "kind": 1024, "kindString": "Property", @@ -10927,7 +11423,7 @@ } }, { - "id": 75, + "id": 83, "name": "url", "kind": 1024, "kindString": "Property", @@ -10947,7 +11443,7 @@ } }, { - "id": 132, + "id": 140, "name": "delete", "kind": 2048, "kindString": "Method", @@ -10961,7 +11457,7 @@ ], "signatures": [ { - "id": 133, + "id": 141, "name": "delete", "kind": 4096, "kindString": "Call signature", @@ -10972,7 +11468,7 @@ }, "parameters": [ { - "id": 134, + "id": 142, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -10984,14 +11480,14 @@ "type": { "type": "reflection", "declaration": { - "id": 135, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 136, + "id": 144, "name": "count", "kind": 1024, "kindString": "Property", @@ -11031,7 +11527,7 @@ { "title": "Properties", "kind": 1024, - "children": [136] + "children": [144] } ] } @@ -11041,11 +11537,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -11056,7 +11552,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -11066,12 +11562,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -11081,7 +11577,7 @@ ] }, { - "id": 93, + "id": 101, "name": "insert", "kind": 2048, "kindString": "Method", @@ -11095,7 +11591,7 @@ ], "signatures": [ { - "id": 94, + "id": 102, "name": "insert", "kind": 4096, "kindString": "Call signature", @@ -11106,7 +11602,7 @@ }, "typeParameter": [ { - "id": 95, + "id": 103, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -11131,7 +11627,7 @@ ], "parameters": [ { - "id": 96, + "id": 104, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -11141,12 +11637,12 @@ }, "type": { "type": "reference", - "id": 95, + "id": 103, "name": "Row" } }, { - "id": 97, + "id": 105, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -11159,14 +11655,14 @@ "type": { "type": "reflection", "declaration": { - "id": 98, + "id": 106, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 99, + "id": 107, "name": "count", "kind": 1024, "kindString": "Property", @@ -11206,7 +11702,7 @@ { "title": "Properties", "kind": 1024, - "children": [99] + "children": [107] } ] } @@ -11215,11 +11711,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -11230,7 +11726,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -11240,12 +11736,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -11253,7 +11749,7 @@ } }, { - "id": 100, + "id": 108, "name": "insert", "kind": 4096, "kindString": "Call signature", @@ -11264,7 +11760,7 @@ }, "typeParameter": [ { - "id": 101, + "id": 109, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -11289,7 +11785,7 @@ ], "parameters": [ { - "id": 102, + "id": 110, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -11301,13 +11797,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 101, + "id": 109, "name": "Row" } } }, { - "id": 103, + "id": 111, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -11320,14 +11816,14 @@ "type": { "type": "reflection", "declaration": { - "id": 104, + "id": 112, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 105, + "id": 113, "name": "count", "kind": 1024, "kindString": "Property", @@ -11363,7 +11859,7 @@ } }, { - "id": 106, + "id": 114, "name": "defaultToNull", "kind": 1024, "kindString": "Property", @@ -11390,7 +11886,7 @@ { "title": "Properties", "kind": 1024, - "children": [105, 106] + "children": [113, 114] } ] } @@ -11399,11 +11895,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -11414,7 +11910,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -11424,12 +11920,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -11439,7 +11935,7 @@ ] }, { - "id": 84, + "id": 92, "name": "select", "kind": 2048, "kindString": "Method", @@ -11453,7 +11949,7 @@ ], "signatures": [ { - "id": 85, + "id": 93, "name": "select", "kind": 4096, "kindString": "Call signature", @@ -11463,7 +11959,7 @@ }, "typeParameter": [ { - "id": 86, + "id": 94, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -11478,17 +11974,18 @@ } }, { - "id": 87, + "id": 95, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", + "id": 685, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -11499,23 +11996,23 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" }, { "type": "reference", - "id": 86, + "id": 94, "name": "Query" } ], @@ -11525,7 +12022,7 @@ ], "parameters": [ { - "id": 88, + "id": 96, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -11537,12 +12034,12 @@ }, "type": { "type": "reference", - "id": 86, + "id": 94, "name": "Query" } }, { - "id": 89, + "id": 97, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -11554,14 +12051,14 @@ "type": { "type": "reflection", "declaration": { - "id": 90, + "id": 98, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 92, + "id": 100, "name": "count", "kind": 1024, "kindString": "Property", @@ -11597,7 +12094,7 @@ } }, { - "id": 91, + "id": 99, "name": "head", "kind": 1024, "kindString": "Property", @@ -11624,7 +12121,7 @@ { "title": "Properties", "kind": 1024, - "children": [92, 91] + "children": [100, 99] } ] } @@ -11634,11 +12131,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -11649,7 +12146,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -11657,18 +12154,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 87, + "id": 95, "name": "ResultOne" } }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -11678,7 +12175,7 @@ ] }, { - "id": 125, + "id": 133, "name": "update", "kind": 2048, "kindString": "Method", @@ -11692,7 +12189,7 @@ ], "signatures": [ { - "id": 126, + "id": 134, "name": "update", "kind": 4096, "kindString": "Call signature", @@ -11703,7 +12200,7 @@ }, "typeParameter": [ { - "id": 127, + "id": 135, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -11728,7 +12225,7 @@ ], "parameters": [ { - "id": 128, + "id": 136, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -11738,12 +12235,12 @@ }, "type": { "type": "reference", - "id": 127, + "id": 135, "name": "Row" } }, { - "id": 129, + "id": 137, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -11755,14 +12252,14 @@ "type": { "type": "reflection", "declaration": { - "id": 130, + "id": 138, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 131, + "id": 139, "name": "count", "kind": 1024, "kindString": "Property", @@ -11802,7 +12299,7 @@ { "title": "Properties", "kind": 1024, - "children": [131] + "children": [139] } ] } @@ -11812,11 +12309,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -11827,7 +12324,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -11837,12 +12334,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -11852,7 +12349,7 @@ ] }, { - "id": 107, + "id": 115, "name": "upsert", "kind": 2048, "kindString": "Method", @@ -11865,210 +12362,6 @@ } ], "signatures": [ - { - "id": 108, - "name": "upsert", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "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`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" - }, - "typeParameter": [ - { - "id": 109, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "parameters": [ - { - "id": 110, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" - }, - "type": { - "type": "reference", - "id": 109, - "name": "Row" - } - }, - { - "id": 111, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 112, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 115, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "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.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 189, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 114, - "name": "ignoreDuplicates", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 188, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 113, - "name": "onConflict", - "kind": 1024, - "kindString": "Property", - "flags": { - "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.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 187, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [115, 114, 113] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 59, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 60, - "name": "Relation" - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 61, - "name": "RelationName" - }, - { - "type": "reference", - "id": 64, - "name": "Relationships" - } - ], - "name": "default" - } - }, { "id": 116, "name": "upsert", @@ -12115,12 +12408,9 @@ "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 117, - "name": "Row" - } + "type": "reference", + "id": 117, + "name": "Row" } }, { @@ -12154,6 +12444,213 @@ "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.\n" }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 189, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 122, + "name": "ignoreDuplicates", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 188, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 121, + "name": "onConflict", + "kind": 1024, + "kindString": "Property", + "flags": { + "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.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 187, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [123, 122, 121] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 67, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 68, + "name": "Relation" + } + }, + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 69, + "name": "RelationName" + }, + { + "type": "reference", + "id": 72, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 124, + "name": "upsert", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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`.", + "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + }, + "typeParameter": [ + { + "id": 125, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "parameters": [ + { + "id": 126, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 125, + "name": "Row" + } + } + }, + { + "id": 127, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters\n" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 128, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 131, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "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.\n" + }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", @@ -12180,7 +12677,7 @@ } }, { - "id": 124, + "id": 132, "name": "defaultToNull", "kind": 1024, "kindString": "Property", @@ -12203,7 +12700,7 @@ } }, { - "id": 122, + "id": 130, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", @@ -12226,7 +12723,7 @@ } }, { - "id": 121, + "id": 129, "name": "onConflict", "kind": 1024, "kindString": "Property", @@ -12253,7 +12750,7 @@ { "title": "Properties", "kind": 1024, - "children": [123, 124, 122, 121] + "children": [131, 132, 130, 129] } ] } @@ -12262,11 +12759,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -12277,7 +12774,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -12287,12 +12784,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -12306,17 +12803,17 @@ { "title": "Constructors", "kind": 512, - "children": [57] + "children": [65] }, { "title": "Properties", "kind": 1024, - "children": [79, 76, 77, 78, 75] + "children": [87, 84, 85, 86, 83] }, { "title": "Methods", "kind": 2048, - "children": [132, 93, 84, 125, 107] + "children": [140, 101, 92, 133, 115] } ], "sources": [ @@ -12328,7 +12825,7 @@ ], "typeParameter": [ { - "id": 137, + "id": 145, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -12339,7 +12836,7 @@ } }, { - "id": 138, + "id": 146, "name": "Relation", "kind": 131072, "kindString": "Type parameter", @@ -12359,7 +12856,7 @@ } }, { - "id": 139, + "id": 147, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -12370,7 +12867,7 @@ } }, { - "id": 142, + "id": 150, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -12379,20 +12876,20 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { - "id": 140, + "id": 148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 141, + "id": 149, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -12414,7 +12911,7 @@ { "title": "Properties", "kind": 1024, - "children": [141] + "children": [149] } ], "sources": [ @@ -12439,28 +12936,28 @@ ] }, { - "id": 489, + "id": 491, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 490, + "id": 492, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 491, + "id": 493, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 492, + "id": 494, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -12471,7 +12968,7 @@ } }, { - "id": 493, + "id": 495, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -12494,14 +12991,14 @@ } }, { - "id": 494, + "id": 496, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 495, + "id": 497, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -12512,7 +13009,7 @@ } }, { - "id": 496, + "id": 498, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -12525,19 +13022,23 @@ ], "parameters": [ { - "id": 497, + "id": 499, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 496, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -12546,31 +13047,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -12578,19 +13079,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 611, + "id": 617, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 610, + "id": 616, "name": "default.constructor" } }, { - "id": 581, + "id": 583, "name": "body", "kind": 1024, "kindString": "Property", @@ -12601,7 +13102,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -12611,12 +13112,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 618, + "id": 625, "name": "default.body" } }, { - "id": 584, + "id": 586, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -12626,28 +13127,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 585, + "id": 587, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 586, + "id": 588, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 587, + "id": 589, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -12671,7 +13172,7 @@ } }, { - "id": 588, + "id": 590, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -12706,12 +13207,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 621, + "id": 628, "name": "default.fetch" } }, { - "id": 579, + "id": 581, "name": "headers", "kind": 1024, "kindString": "Property", @@ -12721,7 +13222,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -12743,12 +13244,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 616, + "id": 623, "name": "default.headers" } }, { - "id": 589, + "id": 591, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -12758,7 +13259,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -12768,12 +13269,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 626, + "id": 633, "name": "default.isMaybeSingle" } }, { - "id": 577, + "id": 579, "name": "method", "kind": 1024, "kindString": "Property", @@ -12783,7 +13284,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -12814,65 +13315,13 @@ }, "inheritedFrom": { "type": "reference", - "id": 614, + "id": 621, "name": "default.method" } }, - { - "id": 580, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 617, - "name": "default.schema" - } - }, { "id": 582, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 619, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 583, - "name": "signal", + "name": "schema", "kind": 1024, "kindString": "Property", "flags": { @@ -12886,6 +13335,58 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 624, + "name": "default.schema" + } + }, + { + "id": 584, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false", + "inheritedFrom": { + "type": "reference", + "id": 626, + "name": "default.shouldThrowOnError" + } + }, + { + "id": 585, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -12894,12 +13395,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 620, + "id": 627, "name": "default.signal" } }, { - "id": 578, + "id": 580, "name": "url", "kind": 1024, "kindString": "Property", @@ -12909,7 +13410,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -12921,12 +13422,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 615, + "id": 622, "name": "default.url" } }, { - "id": 549, + "id": 551, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -12940,7 +13441,7 @@ ], "signatures": [ { - "id": 550, + "id": 552, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", @@ -12950,7 +13451,7 @@ }, "parameters": [ { - "id": 551, + "id": 553, "name": "signal", "kind": 32768, "kindString": "Parameter", @@ -12968,31 +13469,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -13002,7 +13503,7 @@ ] }, { - "id": 558, + "id": 560, "name": "csv", "kind": 2048, "kindString": "Method", @@ -13016,7 +13517,7 @@ ], "signatures": [ { - "id": 559, + "id": 561, "name": "csv", "kind": 4096, "kindString": "Call signature", @@ -13026,11 +13527,15 @@ }, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "intrinsic", "name": "string" + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -13039,7 +13544,7 @@ ] }, { - "id": 562, + "id": 564, "name": "explain", "kind": 2048, "kindString": "Method", @@ -13053,7 +13558,7 @@ ], "signatures": [ { - "id": 563, + "id": 565, "name": "explain", "kind": 4096, "kindString": "Call signature", @@ -13064,7 +13569,7 @@ }, "parameters": [ { - "id": 564, + "id": 566, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -13076,14 +13581,14 @@ "type": { "type": "reflection", "declaration": { - "id": 565, + "id": 567, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 566, + "id": 568, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -13106,7 +13611,7 @@ } }, { - "id": 569, + "id": 571, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -13129,7 +13634,7 @@ } }, { - "id": 571, + "id": 573, "name": "format", "kind": 1024, "kindString": "Property", @@ -13161,7 +13666,7 @@ } }, { - "id": 568, + "id": 570, "name": "settings", "kind": 1024, "kindString": "Property", @@ -13184,7 +13689,7 @@ } }, { - "id": 567, + "id": 569, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -13207,7 +13712,7 @@ } }, { - "id": 570, + "id": 572, "name": "wal", "kind": 1024, "kindString": "Property", @@ -13234,7 +13739,7 @@ { "title": "Properties", "kind": 1024, - "children": [566, 569, 571, 568, 567, 570] + "children": [568, 571, 573, 570, 569, 572] } ] } @@ -13247,18 +13752,22 @@ "types": [ { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "intrinsic", "name": "string" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "array", @@ -13278,6 +13787,10 @@ "package": "typescript", "name": "Record" } + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -13288,7 +13801,7 @@ ] }, { - "id": 560, + "id": 562, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -13302,7 +13815,7 @@ ], "signatures": [ { - "id": 561, + "id": 563, "name": "geojson", "kind": 4096, "kindString": "Call signature", @@ -13312,7 +13825,7 @@ }, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", @@ -13329,6 +13842,10 @@ "qualifiedName": "Record", "package": "typescript", "name": "Record" + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -13337,7 +13854,7 @@ ] }, { - "id": 534, + "id": 536, "name": "limit", "kind": 2048, "kindString": "Method", @@ -13351,7 +13868,7 @@ ], "signatures": [ { - "id": 535, + "id": 537, "name": "limit", "kind": 4096, "kindString": "Call signature", @@ -13361,7 +13878,7 @@ }, "parameters": [ { - "id": 536, + "id": 538, "name": "count", "kind": 32768, "kindString": "Parameter", @@ -13375,7 +13892,7 @@ } }, { - "id": 537, + "id": 539, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -13387,14 +13904,14 @@ "type": { "type": "reflection", "declaration": { - "id": 538, + "id": 540, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 539, + "id": 541, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -13417,7 +13934,7 @@ } }, { - "id": 540, + "id": 542, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -13444,7 +13961,7 @@ { "title": "Properties", "kind": 1024, - "children": [539, 540] + "children": [541, 542] } ] } @@ -13454,31 +13971,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -13488,7 +14005,7 @@ ] }, { - "id": 555, + "id": 557, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -13502,7 +14019,7 @@ ], "signatures": [ { - "id": 556, + "id": 558, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", @@ -13513,7 +14030,7 @@ }, "typeParameter": [ { - "id": 557, + "id": 559, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -13522,7 +14039,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, "extendsType": { @@ -13545,7 +14062,7 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "union", @@ -13556,10 +14073,14 @@ }, { "type": "reference", - "id": 437, + "id": 435, "name": "ResultOne" } ] + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -13568,7 +14089,7 @@ ] }, { - "id": 503, + "id": 505, "name": "order", "kind": 2048, "kindString": "Method", @@ -13582,7 +14103,7 @@ ], "signatures": [ { - "id": 504, + "id": 506, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -13592,36 +14113,36 @@ "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "typeParameter": [ - { - "id": 505, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 506, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 385, - "name": "ColumnName" - } - }, { "id": 507, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 508, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 383, + "name": "ColumnName" + } + }, + { + "id": 509, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -13634,14 +14155,14 @@ "type": { "type": "reflection", "declaration": { - "id": 508, + "id": 510, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 509, + "id": 511, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -13664,7 +14185,7 @@ } }, { - "id": 510, + "id": 512, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -13687,7 +14208,7 @@ } }, { - "id": 511, + "id": 513, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -13714,7 +14235,7 @@ { "title": "Properties", "kind": 1024, - "children": [509, 510, 511] + "children": [511, 512, 513] } ] } @@ -13723,31 +14244,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -13755,7 +14276,7 @@ } }, { - "id": 512, + "id": 514, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -13766,7 +14287,7 @@ }, "parameters": [ { - "id": 513, + "id": 515, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -13780,7 +14301,7 @@ } }, { - "id": 514, + "id": 516, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -13793,14 +14314,14 @@ "type": { "type": "reflection", "declaration": { - "id": 515, + "id": 517, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 516, + "id": 518, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -13823,7 +14344,7 @@ } }, { - "id": 517, + "id": 519, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -13846,7 +14367,7 @@ } }, { - "id": 518, + "id": 520, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -13873,7 +14394,7 @@ { "title": "Properties", "kind": 1024, - "children": [516, 517, 518] + "children": [518, 519, 520] } ] } @@ -13882,31 +14403,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -13914,7 +14435,7 @@ } }, { - "id": 519, + "id": 521, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -13931,7 +14452,7 @@ }, "typeParameter": [ { - "id": 520, + "id": 522, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -13944,7 +14465,7 @@ ], "parameters": [ { - "id": 521, + "id": 523, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -13954,12 +14475,12 @@ }, "type": { "type": "reference", - "id": 400, + "id": 398, "name": "ColumnName" } }, { - "id": 522, + "id": 524, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -13972,14 +14493,14 @@ "type": { "type": "reflection", "declaration": { - "id": 523, + "id": 525, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 524, + "id": 526, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -13999,7 +14520,7 @@ } }, { - "id": 526, + "id": 528, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -14019,7 +14540,7 @@ } }, { - "id": 525, + "id": 527, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -14043,7 +14564,7 @@ { "title": "Properties", "kind": 1024, - "children": [524, 526, 525] + "children": [526, 528, 527] } ] } @@ -14052,31 +14573,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -14084,7 +14605,7 @@ } }, { - "id": 527, + "id": 529, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -14101,7 +14622,7 @@ }, "parameters": [ { - "id": 528, + "id": 530, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -14115,7 +14636,7 @@ } }, { - "id": 529, + "id": 531, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -14128,14 +14649,14 @@ "type": { "type": "reflection", "declaration": { - "id": 530, + "id": 532, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 531, + "id": 533, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -14155,7 +14676,7 @@ } }, { - "id": 533, + "id": 535, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -14175,7 +14696,7 @@ } }, { - "id": 532, + "id": 534, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -14199,7 +14720,7 @@ { "title": "Properties", "kind": 1024, - "children": [531, 533, 532] + "children": [533, 535, 534] } ] } @@ -14208,31 +14729,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -14242,7 +14763,7 @@ ] }, { - "id": 541, + "id": 543, "name": "range", "kind": 2048, "kindString": "Method", @@ -14256,17 +14777,17 @@ ], "signatures": [ { - "id": 542, + "id": 544, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by starting at an offset (`from`) and ending at the offset (`from + 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." + "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." }, "parameters": [ { - "id": 543, + "id": 545, "name": "from", "kind": 32768, "kindString": "Parameter", @@ -14280,7 +14801,7 @@ } }, { - "id": 544, + "id": 546, "name": "to", "kind": 32768, "kindString": "Parameter", @@ -14294,7 +14815,7 @@ } }, { - "id": 545, + "id": 547, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -14306,14 +14827,14 @@ "type": { "type": "reflection", "declaration": { - "id": 546, + "id": 548, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 547, + "id": 549, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -14336,7 +14857,7 @@ } }, { - "id": 548, + "id": 550, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -14363,7 +14884,7 @@ { "title": "Properties", "kind": 1024, - "children": [547, 548] + "children": [549, 550] } ] } @@ -14373,31 +14894,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -14407,7 +14928,7 @@ ] }, { - "id": 574, + "id": 576, "name": "returns", "kind": 2048, "kindString": "Method", @@ -14421,7 +14942,7 @@ ], "signatures": [ { - "id": 575, + "id": 577, "name": "returns", "kind": 4096, "kindString": "Call signature", @@ -14431,7 +14952,7 @@ }, "typeParameter": [ { - "id": 576, + "id": 578, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", @@ -14443,31 +14964,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 456, + "id": 454, "name": "NewResult" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -14477,7 +14998,7 @@ ] }, { - "id": 572, + "id": 574, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -14491,7 +15012,7 @@ ], "signatures": [ { - "id": 573, + "id": 575, "name": "rollback", "kind": 4096, "kindString": "Call signature", @@ -14502,31 +15023,31 @@ }, "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -14536,7 +15057,7 @@ ] }, { - "id": 498, + "id": 500, "name": "select", "kind": 2048, "kindString": "Method", @@ -14550,7 +15071,7 @@ ], "signatures": [ { - "id": 499, + "id": 501, "name": "select", "kind": 4096, "kindString": "Call signature", @@ -14561,7 +15082,7 @@ }, "typeParameter": [ { - "id": 500, + "id": 502, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -14576,37 +15097,38 @@ } }, { - "id": 501, + "id": 503, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", + "id": 685, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" }, { "type": "reference", - "id": 380, + "id": 378, "name": "Query" } ], @@ -14616,7 +15138,7 @@ ], "parameters": [ { - "id": 502, + "id": 504, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -14628,41 +15150,41 @@ }, "type": { "type": "reference", - "id": 380, + "id": 378, "name": "Query" } } ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 381, + "id": 379, "name": "NewResultOne" } }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -14672,7 +15194,99 @@ ] }, { - "id": 552, + "id": 594, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 595, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 596, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 597, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 491, + "typeArguments": [ + { + "type": "reference", + "id": 494, + "name": "Schema" + }, + { + "type": "reference", + "id": 495, + "name": "Row" + }, + { + "type": "reference", + "id": 496, + "name": "Result" + }, + { + "type": "reference", + "id": 497, + "name": "RelationName" + }, + { + "type": "reference", + "id": 498, + "name": "Relationships" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 637, + "name": "default.setHeader" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 636, + "name": "default.setHeader" + } + }, + { + "id": 554, "name": "single", "kind": 2048, "kindString": "Method", @@ -14686,7 +15300,7 @@ ], "signatures": [ { - "id": 553, + "id": 555, "name": "single", "kind": 4096, "kindString": "Call signature", @@ -14697,7 +15311,7 @@ }, "typeParameter": [ { - "id": 554, + "id": 556, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -14706,7 +15320,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, "extendsType": { @@ -14729,12 +15343,16 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 434, + "id": 432, "name": "ResultOne" + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -14743,7 +15361,7 @@ ] }, { - "id": 592, + "id": 598, "name": "then", "kind": 2048, "kindString": "Method", @@ -14751,31 +15369,31 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 593, + "id": 599, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 594, + "id": 600, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 496, "name": "Result" } ], @@ -14783,7 +15401,7 @@ } }, { - "id": 595, + "id": 601, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -14796,7 +15414,7 @@ ], "parameters": [ { - "id": 596, + "id": 602, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -14813,32 +15431,32 @@ { "type": "reflection", "declaration": { - "id": 597, + "id": 603, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 598, + "id": 604, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 599, + "id": 605, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 496, "name": "Result" } ], @@ -14851,7 +15469,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -14859,7 +15477,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -14877,7 +15495,7 @@ } }, { - "id": 600, + "id": 606, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -14894,21 +15512,21 @@ { "type": "reflection", "declaration": { - "id": 601, + "id": 607, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 602, + "id": 608, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 603, + "id": 609, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -14924,7 +15542,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -14932,7 +15550,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -14958,12 +15576,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -14975,19 +15593,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 630, + "id": 641, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 629, + "id": 640, "name": "default.then" } }, { - "id": 590, + "id": 592, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -14995,13 +15613,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 591, + "id": 593, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -15011,47 +15629,68 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 489, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 492, - "name": "Schema" + "id": 491, + "typeArguments": [ + { + "type": "reference", + "id": 494, + "name": "Schema" + }, + { + "type": "reference", + "id": 495, + "name": "Row" + }, + { + "type": "reference", + "id": 496, + "name": "Result" + }, + { + "type": "reference", + "id": 497, + "name": "RelationName" + }, + { + "type": "reference", + "id": 498, + "name": "Relationships" + } + ], + "name": "default" }, { "type": "reference", - "id": 493, - "name": "Row" - }, - { - "type": "reference", - "id": 494, - "name": "Result" - }, - { - "type": "reference", - "id": 495, - "name": "RelationName" - }, - { - "type": "reference", - "id": 496, - "name": "Relationships" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 496, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] }, "inheritedFrom": { "type": "reference", - "id": 628, + "id": 635, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 627, + "id": 634, "name": "default.throwOnError" } } @@ -15060,17 +15699,17 @@ { "title": "Constructors", "kind": 512, - "children": [490] + "children": [492] }, { "title": "Properties", "kind": 1024, - "children": [581, 584, 579, 589, 577, 580, 582, 583, 578] + "children": [583, 586, 581, 591, 579, 582, 584, 585, 580] }, { "title": "Methods", "kind": 2048, - "children": [549, 558, 562, 560, 534, 555, 503, 541, 574, 572, 498, 552, 592, 590] + "children": [551, 560, 564, 562, 536, 557, 505, 543, 576, 574, 500, 594, 554, 598, 592] } ], "sources": [ @@ -15082,7 +15721,7 @@ ], "typeParameter": [ { - "id": 604, + "id": 610, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -15093,7 +15732,7 @@ } }, { - "id": 605, + "id": 611, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -15116,14 +15755,14 @@ } }, { - "id": 606, + "id": 612, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 607, + "id": 613, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -15134,7 +15773,7 @@ } }, { - "id": 608, + "id": 614, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -15148,11 +15787,11 @@ "extendedTypes": [ { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 496, "name": "Result" } ], @@ -15162,20 +15801,20 @@ "extendedBy": [ { "type": "reference", - "id": 143, + "id": 151, "name": "PostgrestFilterBuilder" } ] }, { - "id": 644, + "id": 668, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 647, + "id": 671, "name": "count", "kind": 1024, "kindString": "Property", @@ -15183,7 +15822,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 32, + "line": 22, "character": 2 } ], @@ -15193,7 +15832,7 @@ } }, { - "id": 646, + "id": 670, "name": "data", "kind": 1024, "kindString": "Property", @@ -15201,7 +15840,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 31, + "line": 21, "character": 2 } ], @@ -15211,7 +15850,7 @@ } }, { - "id": 645, + "id": 669, "name": "error", "kind": 1024, "kindString": "Property", @@ -15219,18 +15858,18 @@ "sources": [ { "fileName": "src/types.ts", - "line": 30, + "line": 20, "character": 2 } ], "type": { "type": "reference", - "id": 661, - "name": "PostgrestError" + "id": 654, + "name": "default" } }, { - "id": 648, + "id": 672, "name": "status", "kind": 1024, "kindString": "Property", @@ -15238,7 +15877,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 21, + "line": 11, "character": 2 } ], @@ -15252,7 +15891,7 @@ } }, { - "id": 649, + "id": 673, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -15260,7 +15899,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 22, + "line": 12, "character": 2 } ], @@ -15278,13 +15917,13 @@ { "title": "Properties", "kind": 1024, - "children": [647, 646, 645, 648, 649] + "children": [671, 670, 669, 672, 673] } ], "sources": [ { "fileName": "src/types.ts", - "line": 29, + "line": 19, "character": 17 } ], @@ -15296,14 +15935,14 @@ ] }, { - "id": 650, + "id": 674, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 653, + "id": 677, "name": "count", "kind": 1024, "kindString": "Property", @@ -15311,7 +15950,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 27, + "line": 17, "character": 2 } ], @@ -15330,7 +15969,7 @@ } }, { - "id": 652, + "id": 676, "name": "data", "kind": 1024, "kindString": "Property", @@ -15338,18 +15977,18 @@ "sources": [ { "fileName": "src/types.ts", - "line": 26, + "line": 16, "character": 2 } ], "type": { "type": "reference", - "id": 656, + "id": 680, "name": "T" } }, { - "id": 651, + "id": 675, "name": "error", "kind": 1024, "kindString": "Property", @@ -15357,7 +15996,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 25, + "line": 15, "character": 2 } ], @@ -15367,7 +16006,7 @@ } }, { - "id": 654, + "id": 678, "name": "status", "kind": 1024, "kindString": "Property", @@ -15375,7 +16014,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 21, + "line": 11, "character": 2 } ], @@ -15389,7 +16028,7 @@ } }, { - "id": 655, + "id": 679, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -15397,7 +16036,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 22, + "line": 12, "character": 2 } ], @@ -15415,19 +16054,19 @@ { "title": "Properties", "kind": 1024, - "children": [653, 652, 651, 654, 655] + "children": [677, 676, 675, 678, 679] } ], "sources": [ { "fileName": "src/types.ts", - "line": 24, + "line": 14, "character": 17 } ], "typeParameter": [ { - "id": 656, + "id": 680, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -15442,123 +16081,7 @@ ] }, { - "id": 661, - "name": "PostgrestError", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "Error format", - "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" - }, - "sources": [ - { - "fileName": "src/types.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 662, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 666, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 10, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 663, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 9, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [666, 664, 665, 663] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 8, - "character": 29 - } - ] - } - } - }, - { - "id": 659, + "id": 683, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -15566,13 +16089,13 @@ "sources": [ { "fileName": "src/types.ts", - "line": 39, + "line": 29, "character": 12 } ], "typeParameter": [ { - "id": 660, + "id": 684, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -15581,14 +16104,14 @@ ], "type": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", - "id": 660, + "id": 684, "name": "T" }, { @@ -15602,7 +16125,7 @@ } }, { - "id": 642, + "id": 666, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", @@ -15610,13 +16133,13 @@ "sources": [ { "fileName": "src/types.ts", - "line": 40, + "line": 30, "character": 12 } ], "typeParameter": [ { - "id": 643, + "id": 667, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -15625,13 +16148,13 @@ ], "type": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", - "id": 643, + "id": 667, "name": "T" } } @@ -15640,7 +16163,7 @@ } }, { - "id": 657, + "id": 681, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -15648,13 +16171,13 @@ "sources": [ { "fileName": "src/types.ts", - "line": 38, + "line": 28, "character": 12 } ], "typeParameter": [ { - "id": 658, + "id": 682, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -15666,11 +16189,11 @@ "types": [ { "type": "reference", - "id": 650, + "id": 674, "typeArguments": [ { "type": "reference", - "id": 658, + "id": 682, "name": "T" } ], @@ -15678,34 +16201,545 @@ }, { "type": "reference", - "id": 644, + "id": 668, "name": "PostgrestResponseFailure" } ] } + }, + { + "id": 685, + "name": "UnstableGetResult", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "Main entry point for constructing the result type of a PostgREST query." + }, + "sources": [ + { + "fileName": "src/select-query-parser/result.ts", + "line": 33, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 686, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Database schema." + }, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 687, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The type of a row in the current table." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 688, + "name": "RelationName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The name of the current table or view." + } + }, + { + "id": 689, + "name": "Relationships", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Relationships of the current table." + } + }, + { + "id": 690, + "name": "Query", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The select query string literal to parse.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 686, + "name": "Schema" + } + ], + "name": "IsAny" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 690, + "name": "Query" + } + ], + "name": "ParseQuery" + }, + "extendsType": { + "type": "inferred", + "name": "ParsedQuery" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "ParsedQuery" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Ast.Node" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ParsedQuery" + } + ], + "name": "ProcessNodesWithoutSchema" + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "reference", + "name": "ParsedQuery" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 689, + "name": "Relationships" + }, + "extendsType": { + "type": "literal", + "value": null + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 690, + "name": "Query" + } + ], + "name": "ParseQuery" + }, + "extendsType": { + "type": "inferred", + "name": "ParsedQuery" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "ParsedQuery" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Ast.Node" + } + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ParsedQuery" + }, + { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + "falseType": { + "type": "literal", + "value": "rpc_call" + } + }, + { + "type": "reference", + "id": 687, + "name": "Row" + } + ], + "name": "RPCCallNodes" + }, + "falseType": { + "type": "reference", + "name": "ParsedQuery" + } + }, + "falseType": { + "type": "reference", + "id": 687, + "name": "Row" + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 690, + "name": "Query" + } + ], + "name": "ParseQuery" + }, + "extendsType": { + "type": "inferred", + "name": "ParsedQuery" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "ParsedQuery" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Ast.Node" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 689, + "name": "Relationships" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "GenericRelationship" + } + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 686, + "name": "Schema" + }, + { + "type": "reference", + "id": 687, + "name": "Row" + }, + { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + { + "type": "reference", + "id": 689, + "name": "Relationships" + }, + { + "type": "reference", + "name": "ParsedQuery" + } + ], + "name": "ProcessNodes" + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "Invalid Relationships cannot infer result type" + } + ], + "name": "SelectQueryError" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "Invalid RelationName cannot infer result type" + } + ], + "name": "SelectQueryError" + } + }, + "falseType": { + "type": "reference", + "name": "ParsedQuery" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + } + }, + { + "id": 1, + "name": "default", + "kind": 32, + "kindString": "Variable", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 17, + "character": 0 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 2, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 7, + "name": "PostgrestBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 615, + "name": "default" + } + } + }, + { + "id": 3, + "name": "PostgrestClient", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 9, + "name": "default" + } + } + }, + { + "id": 8, + "name": "PostgrestError", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 654, + "name": "default" + } + } + }, + { + "id": 5, + "name": "PostgrestFilterBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 151, + "name": "default" + } + } + }, + { + "id": 4, + "name": "PostgrestQueryBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 64, + "name": "default" + } + } + }, + { + "id": 6, + "name": "PostgrestTransformBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 491, + "name": "default" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [7, 3, 8, 5, 4, 6] + } + ] + } + } } ], "groups": [ { "title": "Classes", "kind": 128, - "children": [609, 1, 143, 56, 489] + "children": [615, 9, 654, 151, 64, 491] }, { "title": "Interfaces", "kind": 256, - "children": [644, 650] + "children": [668, 674] }, { "title": "Type Aliases", "kind": 4194304, - "children": [661, 659, 642, 657] + "children": [683, 666, 681, 685] + }, + { + "title": "Variables", + "kind": 32, + "children": [1] } ], "sources": [ { "fileName": "src/index.ts", - "line": 1, + "line": 2, "character": 0 } ] diff --git a/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json index 8a81b65df6e..9f135c5ead2 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json @@ -7,7 +7,7 @@ "originalName": "", "children": [ { - "id": 609, + "id": 615, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -16,7 +16,7 @@ }, "children": [ { - "id": 610, + "id": 616, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -24,46 +24,65 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 23, "character": 2 } ], "signatures": [ { - "id": 611, + "id": 617, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 612, + "id": 618, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 619, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "parameters": [ { - "id": 613, + "id": 620, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default", "dereferenced": { - "id": 609, + "id": 615, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -75,17 +94,17 @@ { "title": "Constructors", "kind": 512, - "children": [610] + "children": [616] }, { "title": "Properties", "kind": 1024, - "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] + "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] }, { "title": "Methods", "kind": 2048, - "children": [629, 627] + "children": [636, 640, 634] } ], "sources": [ @@ -97,17 +116,32 @@ ], "typeParameter": [ { - "id": 641, + "id": 652, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 653, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "extendedBy": [ { "type": "reference", - "id": 489, + "id": 491, "name": "PostgrestTransformBuilder" } ], @@ -116,16 +150,40 @@ "type": "reference", "typeArguments": [ { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } ], "qualifiedName": "PromiseLike", @@ -139,12 +197,17 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" } ], "name": "default" @@ -153,7 +216,7 @@ ] }, { - "id": 618, + "id": 625, "name": "body", "kind": 1024, "kindString": "Property", @@ -164,7 +227,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -174,7 +237,7 @@ } }, { - "id": 621, + "id": 628, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -184,28 +247,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 622, + "id": 629, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 623, + "id": 630, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 624, + "id": 631, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -229,7 +292,7 @@ } }, { - "id": 625, + "id": 632, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -264,7 +327,7 @@ } }, { - "id": 616, + "id": 623, "name": "headers", "kind": 1024, "kindString": "Property", @@ -274,7 +337,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -296,7 +359,7 @@ } }, { - "id": 626, + "id": 633, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -306,7 +369,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -316,7 +379,7 @@ } }, { - "id": 614, + "id": 621, "name": "method", "kind": 1024, "kindString": "Property", @@ -326,7 +389,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -357,7 +420,7 @@ } }, { - "id": 617, + "id": 624, "name": "schema", "kind": 1024, "kindString": "Property", @@ -365,48 +428,6 @@ "isProtected": true, "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 619, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 620, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", @@ -414,6 +435,48 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 626, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 627, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -422,7 +485,7 @@ } }, { - "id": 615, + "id": 622, "name": "url", "kind": 1024, "kindString": "Property", @@ -432,7 +495,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -444,7 +507,74 @@ } }, { - "id": 629, + "id": 636, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 637, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 638, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 639, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 640, "name": "then", "kind": 2048, "kindString": "Method", @@ -452,39 +582,63 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 630, + "id": 641, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 631, + "id": 642, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } }, { - "id": 632, + "id": 643, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -497,7 +651,7 @@ ], "parameters": [ { - "id": 633, + "id": 644, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -514,36 +668,60 @@ { "type": "reflection", "declaration": { - "id": 634, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 635, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 636, + "id": 647, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } } ], @@ -552,7 +730,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -560,7 +738,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -578,7 +756,7 @@ } }, { - "id": 637, + "id": 648, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -595,21 +773,21 @@ { "type": "reflection", "declaration": { - "id": 638, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 639, + "id": 650, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 640, + "id": 651, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -625,7 +803,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -633,7 +811,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -659,12 +837,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -686,7 +864,7 @@ } }, { - "id": 627, + "id": 634, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -694,13 +872,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 628, + "id": 635, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -710,16 +888,42 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 609, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 612, - "name": "Result" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + }, + { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] } } ] @@ -729,17 +933,17 @@ { "title": "Constructors", "kind": 512, - "children": [610] + "children": [616] }, { "title": "Properties", "kind": 1024, - "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] + "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] }, { "title": "Methods", "kind": 2048, - "children": [629, 627] + "children": [636, 640, 634] } ], "sources": [ @@ -751,17 +955,32 @@ ], "typeParameter": [ { - "id": 641, + "id": 652, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 653, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "extendedBy": [ { "type": "reference", - "id": 489, + "id": 491, "name": "PostgrestTransformBuilder" } ], @@ -770,16 +989,40 @@ "type": "reference", "typeArguments": [ { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } ], "qualifiedName": "PromiseLike", @@ -789,7 +1032,7 @@ ] }, { - "id": 1, + "id": 9, "name": "PostgrestClient", "kind": 128, "kindString": "Class", @@ -799,7 +1042,7 @@ }, "children": [ { - "id": 2, + "id": 10, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -813,7 +1056,7 @@ ], "signatures": [ { - "id": 3, + "id": 11, "name": "new PostgrestClient", "kind": 16384, "kindString": "Constructor signature", @@ -823,7 +1066,7 @@ }, "typeParameter": [ { - "id": 4, + "id": 12, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -834,7 +1077,7 @@ } }, { - "id": 5, + "id": 13, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -854,7 +1097,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -874,7 +1117,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } } @@ -883,7 +1126,7 @@ } }, { - "id": 6, + "id": 14, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -898,12 +1141,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -931,7 +1174,7 @@ ], "parameters": [ { - "id": 7, + "id": 15, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -945,7 +1188,7 @@ } }, { - "id": 8, + "id": 16, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -957,14 +1200,14 @@ "type": { "type": "reflection", "declaration": { - "id": 9, + "id": 17, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 12, + "id": 20, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -981,14 +1224,14 @@ "type": { "type": "reflection", "declaration": { - "id": 13, + "id": 21, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 14, + "id": 22, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -998,7 +1241,7 @@ }, "parameters": [ { - "id": 15, + "id": 23, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1022,7 +1265,7 @@ } }, { - "id": 16, + "id": 24, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1057,7 +1300,7 @@ } }, { - "id": 10, + "id": 18, "name": "headers", "kind": 1024, "kindString": "Property", @@ -1092,7 +1335,7 @@ } }, { - "id": 11, + "id": 19, "name": "schema", "kind": 1024, "kindString": "Property", @@ -1111,7 +1354,7 @@ ], "type": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName", "dereferenced": {} } @@ -1121,7 +1364,7 @@ { "title": "Properties", "kind": 1024, - "children": [12, 10, 11] + "children": [20, 18, 19] } ] } @@ -1131,21 +1374,21 @@ ], "type": { "type": "reference", - "id": 1, + "id": 9, "typeArguments": [ { "type": "reference", - "id": 4, + "id": 12, "name": "Database" }, { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" }, { "type": "reference", - "id": 6, + "id": 14, "name": "Schema" } ], @@ -1155,7 +1398,7 @@ ] }, { - "id": 20, + "id": 28, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -1172,21 +1415,21 @@ "type": { "type": "reflection", "declaration": { - "id": 21, + "id": 29, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 22, + "id": 30, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 23, + "id": 31, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1210,7 +1453,7 @@ } }, { - "id": 24, + "id": 32, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1245,7 +1488,7 @@ } }, { - "id": 18, + "id": 26, "name": "headers", "kind": 1024, "kindString": "Property", @@ -1275,7 +1518,7 @@ } }, { - "id": 19, + "id": 27, "name": "schemaName", "kind": 1024, "kindString": "Property", @@ -1291,13 +1534,13 @@ ], "type": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName", "dereferenced": {} } }, { - "id": 17, + "id": 25, "name": "url", "kind": 1024, "kindString": "Property", @@ -1315,7 +1558,7 @@ } }, { - "id": 25, + "id": 33, "name": "from", "kind": 2048, "kindString": "Method", @@ -1329,7 +1572,7 @@ ], "signatures": [ { - "id": 26, + "id": 34, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1339,7 +1582,7 @@ }, "typeParameter": [ { - "id": 27, + "id": 35, "name": "TableName", "kind": 131072, "kindString": "Type parameter", @@ -1350,7 +1593,7 @@ } }, { - "id": 28, + "id": 36, "name": "Table", "kind": 131072, "kindString": "Type parameter", @@ -1363,7 +1606,7 @@ ], "parameters": [ { - "id": 29, + "id": 37, "name": "relation", "kind": 32768, "kindString": "Parameter", @@ -1373,7 +1616,7 @@ }, "type": { "type": "reference", - "id": 27, + "id": 35, "name": "TableName", "dereferenced": {} } @@ -1381,41 +1624,41 @@ ], "type": { "type": "reference", - "id": 56, + "id": 64, "typeArguments": [ { "type": "reference", - "id": 6, + "id": 14, "name": "Schema" }, { "type": "reference", - "id": 28, + "id": 36, "name": "Table" }, { "type": "reference", - "id": 27, + "id": 35, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 28, + "id": 36, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { - "id": 30, + "id": 38, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 31, + "id": 39, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -1437,7 +1680,7 @@ { "title": "Properties", "kind": 1024, - "children": [31] + "children": [39] } ] } @@ -1456,7 +1699,7 @@ } }, { - "id": 32, + "id": 40, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1466,7 +1709,7 @@ }, "typeParameter": [ { - "id": 33, + "id": 41, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", @@ -1477,7 +1720,7 @@ } }, { - "id": 34, + "id": 42, "name": "View", "kind": 131072, "kindString": "Type parameter", @@ -1490,7 +1733,7 @@ ], "parameters": [ { - "id": 35, + "id": 43, "name": "relation", "kind": 32768, "kindString": "Parameter", @@ -1500,7 +1743,7 @@ }, "type": { "type": "reference", - "id": 33, + "id": 41, "name": "ViewName", "dereferenced": {} } @@ -1508,41 +1751,41 @@ ], "type": { "type": "reference", - "id": 56, + "id": 64, "typeArguments": [ { "type": "reference", - "id": 6, + "id": 14, "name": "Schema" }, { "type": "reference", - "id": 34, + "id": 42, "name": "View" }, { "type": "reference", - "id": 33, + "id": 41, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 34, + "id": 42, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { - "id": 36, + "id": 44, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 37, + "id": 45, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -1564,7 +1807,7 @@ { "title": "Properties", "kind": 1024, - "children": [37] + "children": [45] } ] } @@ -1585,7 +1828,7 @@ ] }, { - "id": 42, + "id": 50, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -1599,7 +1842,7 @@ ], "signatures": [ { - "id": 43, + "id": 51, "name": "rpc", "kind": 4096, "kindString": "Call signature", @@ -1609,7 +1852,7 @@ }, "typeParameter": [ { - "id": 44, + "id": 52, "name": "FnName", "kind": 131072, "kindString": "Type parameter", @@ -1620,7 +1863,7 @@ } }, { - "id": 45, + "id": 53, "name": "Fn", "kind": 131072, "kindString": "Type parameter", @@ -1633,7 +1876,7 @@ ], "parameters": [ { - "id": 46, + "id": 54, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -1643,13 +1886,13 @@ }, "type": { "type": "reference", - "id": 44, + "id": 52, "name": "FnName", "dereferenced": {} } }, { - "id": 47, + "id": 55, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -1665,14 +1908,14 @@ }, "objectType": { "type": "reference", - "id": 45, + "id": 53, "name": "Fn" } }, "defaultValue": "{}" }, { - "id": 48, + "id": 56, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -1684,14 +1927,14 @@ "type": { "type": "reflection", "declaration": { - "id": 49, + "id": 57, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 52, + "id": 60, "name": "count", "kind": 1024, "kindString": "Property", @@ -1727,7 +1970,7 @@ } }, { - "id": 51, + "id": 59, "name": "get", "kind": 1024, "kindString": "Property", @@ -1750,7 +1993,7 @@ } }, { - "id": 50, + "id": 58, "name": "head", "kind": 1024, "kindString": "Property", @@ -1777,7 +2020,7 @@ { "title": "Properties", "kind": 1024, - "children": [52, 51, 50] + "children": [60, 59, 58] } ] } @@ -1787,11 +2030,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 6, + "id": 14, "name": "Schema" }, { @@ -1804,7 +2047,7 @@ }, "objectType": { "type": "reference", - "id": 45, + "id": 53, "name": "Fn" } }, @@ -1880,17 +2123,18 @@ }, "objectType": { "type": "reference", - "id": 45, + "id": 53, "name": "Fn" } }, { - "type": "intrinsic", - "name": "unknown" + "type": "reference", + "id": 52, + "name": "FnName" }, { - "type": "intrinsic", - "name": "unknown" + "type": "literal", + "value": null } ], "name": "default" @@ -1899,7 +2143,7 @@ ] }, { - "id": 38, + "id": 46, "name": "schema", "kind": 2048, "kindString": "Method", @@ -1913,7 +2157,7 @@ ], "signatures": [ { - "id": 39, + "id": 47, "name": "schema", "kind": 4096, "kindString": "Call signature", @@ -1924,7 +2168,7 @@ }, "typeParameter": [ { - "id": 40, + "id": 48, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", @@ -1937,7 +2181,7 @@ ], "parameters": [ { - "id": 41, + "id": 49, "name": "schema", "kind": 32768, "kindString": "Parameter", @@ -1947,7 +2191,7 @@ }, "type": { "type": "reference", - "id": 40, + "id": 48, "name": "DynamicSchema", "dereferenced": {} } @@ -1955,16 +2199,16 @@ ], "type": { "type": "reference", - "id": 1, + "id": 9, "typeArguments": [ { "type": "reference", - "id": 4, + "id": 12, "name": "Database" }, { "type": "reference", - "id": 40, + "id": 48, "name": "DynamicSchema" }, { @@ -1973,12 +2217,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 40, + "id": 48, "name": "DynamicSchema" }, "objectType": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -2013,17 +2257,17 @@ { "title": "Constructors", "kind": 512, - "children": [2] + "children": [10] }, { "title": "Properties", "kind": 1024, - "children": [20, 18, 19, 17] + "children": [28, 26, 27, 25] }, { "title": "Methods", "kind": 2048, - "children": [25, 42, 38] + "children": [33, 50, 46] } ], "sources": [ @@ -2035,7 +2279,7 @@ ], "typeParameter": [ { - "id": 53, + "id": 61, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -2049,7 +2293,7 @@ } }, { - "id": 54, + "id": 62, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -2069,7 +2313,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } } @@ -2086,7 +2330,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -2106,7 +2350,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } } @@ -2115,7 +2359,7 @@ } }, { - "id": 55, + "id": 63, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -2130,12 +2374,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -2147,12 +2391,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 5, + "id": 13, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 4, + "id": 12, "name": "Database" } }, @@ -2165,28 +2409,258 @@ ] }, { - "id": 143, + "id": 654, + "name": "PostgrestError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "shortText": "Error format", + "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" + }, + "children": [ + { + "id": 655, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 2 + } + ], + "signatures": [ + { + "id": 656, + "name": "new PostgrestError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 657, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 658, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 662, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 73 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 660, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 661, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 659, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 25 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [662, 660, 661, 659] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 654, + "name": "default" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + }, + { + "id": 665, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 9, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 663, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 7, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 664, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 8, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [655] + }, + { + "title": "Properties", + "kind": 1024, + "children": [665, 663, 664] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 6, + "character": 21 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ] + }, + { + "id": 151, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 144, + "id": 152, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 145, + "id": 153, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 146, + "id": 154, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -2197,7 +2671,7 @@ } }, { - "id": 147, + "id": 155, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -2220,14 +2694,14 @@ } }, { - "id": 148, + "id": 156, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 149, + "id": 157, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -2238,7 +2712,7 @@ } }, { - "id": 150, + "id": 158, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -2251,24 +2725,28 @@ ], "parameters": [ { - "id": 151, + "id": 159, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 156, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default", "dereferenced": { - "id": 609, + "id": 615, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -2277,7 +2755,7 @@ }, "children": [ { - "id": 610, + "id": 616, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2285,56 +2763,80 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 23, "character": 2 } ], "signatures": [ { - "id": 611, + "id": 617, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 612, + "id": 618, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 619, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "parameters": [ { - "id": 613, + "id": 620, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default", - "dereferenced": "[Circular ~.children.2.children.0.signatures.0.parameters.0.type.dereferenced]" + "dereferenced": "[Circular ~.children.3.children.0.signatures.0.parameters.0.type.dereferenced]" } } ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" } ], "name": "default" @@ -2343,7 +2845,7 @@ ] }, { - "id": 618, + "id": 625, "name": "body", "kind": 1024, "kindString": "Property", @@ -2354,7 +2856,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -2364,7 +2866,7 @@ } }, { - "id": 621, + "id": 628, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -2374,28 +2876,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 622, + "id": 629, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 623, + "id": 630, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 624, + "id": 631, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -2419,7 +2921,7 @@ } }, { - "id": 625, + "id": 632, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -2454,7 +2956,7 @@ } }, { - "id": 616, + "id": 623, "name": "headers", "kind": 1024, "kindString": "Property", @@ -2464,7 +2966,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -2486,7 +2988,7 @@ } }, { - "id": 626, + "id": 633, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -2496,7 +2998,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -2506,7 +3008,7 @@ } }, { - "id": 614, + "id": 621, "name": "method", "kind": 1024, "kindString": "Property", @@ -2516,7 +3018,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -2547,7 +3049,7 @@ } }, { - "id": 617, + "id": 624, "name": "schema", "kind": 1024, "kindString": "Property", @@ -2555,48 +3057,6 @@ "isProtected": true, "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 619, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 620, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", @@ -2604,6 +3064,48 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 626, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 627, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -2612,7 +3114,7 @@ } }, { - "id": 615, + "id": 622, "name": "url", "kind": 1024, "kindString": "Property", @@ -2622,7 +3124,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -2634,7 +3136,74 @@ } }, { - "id": 629, + "id": 636, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 637, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 638, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 639, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 640, "name": "then", "kind": 2048, "kindString": "Method", @@ -2642,39 +3211,63 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 630, + "id": 641, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 631, + "id": 642, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } }, { - "id": 632, + "id": 643, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -2687,7 +3280,7 @@ ], "parameters": [ { - "id": 633, + "id": 644, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -2704,36 +3297,60 @@ { "type": "reflection", "declaration": { - "id": 634, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 635, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 636, + "id": 647, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } } ], @@ -2742,7 +3359,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -2750,7 +3367,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -2768,7 +3385,7 @@ } }, { - "id": 637, + "id": 648, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -2785,21 +3402,21 @@ { "type": "reflection", "declaration": { - "id": 638, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 639, + "id": 650, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 640, + "id": 651, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -2815,7 +3432,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -2823,7 +3440,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -2849,12 +3466,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -2876,7 +3493,7 @@ } }, { - "id": 627, + "id": 634, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -2884,13 +3501,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 628, + "id": 635, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -2900,16 +3517,42 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 609, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 612, - "name": "Result" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + }, + { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] } } ] @@ -2919,17 +3562,17 @@ { "title": "Constructors", "kind": 512, - "children": [610] + "children": [616] }, { "title": "Properties", "kind": 1024, - "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] + "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] }, { "title": "Methods", "kind": 2048, - "children": [629, 627] + "children": [636, 640, 634] } ], "sources": [ @@ -2941,17 +3584,32 @@ ], "typeParameter": [ { - "id": 641, + "id": 652, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 653, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "extendedBy": [ { "type": "reference", - "id": 489, + "id": 491, "name": "PostgrestTransformBuilder" } ], @@ -2960,16 +3618,40 @@ "type": "reference", "typeArguments": [ { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } ], "qualifiedName": "PromiseLike", @@ -2983,31 +3665,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -3015,19 +3697,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 491, + "id": 493, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 490, + "id": 492, "name": "default.constructor" } }, { - "id": 461, + "id": 459, "name": "body", "kind": 1024, "kindString": "Property", @@ -3038,7 +3720,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -3048,12 +3730,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 583, "name": "default.body" } }, { - "id": 464, + "id": 462, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -3063,28 +3745,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 465, + "id": 463, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 466, + "id": 464, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 467, + "id": 465, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -3108,7 +3790,7 @@ } }, { - "id": 468, + "id": 466, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -3143,12 +3825,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 584, + "id": 586, "name": "default.fetch" } }, { - "id": 459, + "id": 457, "name": "headers", "kind": 1024, "kindString": "Property", @@ -3158,7 +3840,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -3180,12 +3862,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 581, "name": "default.headers" } }, { - "id": 469, + "id": 467, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -3195,7 +3877,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -3205,12 +3887,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 589, + "id": 591, "name": "default.isMaybeSingle" } }, { - "id": 457, + "id": 455, "name": "method", "kind": 1024, "kindString": "Property", @@ -3220,7 +3902,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -3251,12 +3933,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 579, "name": "default.method" } }, { - "id": 460, + "id": 458, "name": "schema", "kind": 1024, "kindString": "Property", @@ -3264,58 +3946,6 @@ "isProtected": true, "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 580, - "name": "default.schema" - } - }, - { - "id": 462, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 582, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 463, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", @@ -3323,6 +3953,58 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 582, + "name": "default.schema" + } + }, + { + "id": 460, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false", + "inheritedFrom": { + "type": "reference", + "id": 584, + "name": "default.shouldThrowOnError" + } + }, + { + "id": 461, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -3331,12 +4013,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 583, + "id": 585, "name": "default.signal" } }, { - "id": 458, + "id": 456, "name": "url", "kind": 1024, "kindString": "Property", @@ -3346,7 +4028,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -3358,12 +4040,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 578, + "id": 580, "name": "default.url" } }, { - "id": 429, + "id": 427, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -3377,7 +4059,7 @@ ], "signatures": [ { - "id": 430, + "id": 428, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", @@ -3387,7 +4069,7 @@ }, "parameters": [ { - "id": 431, + "id": 429, "name": "signal", "kind": 32768, "kindString": "Parameter", @@ -3405,31 +4087,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -3437,19 +4119,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 550, + "id": 552, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", - "id": 549, + "id": 551, "name": "default.abortSignal" } }, { - "id": 273, + "id": 271, "name": "containedBy", "kind": 2048, "kindString": "Method", @@ -3457,13 +4139,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 281, + "line": 342, "character": 2 } ], "signatures": [ { - "id": 274, + "id": 272, "name": "containedBy", "kind": 4096, "kindString": "Call signature", @@ -3473,7 +4155,7 @@ }, "typeParameter": [ { - "id": 275, + "id": 273, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3486,7 +4168,7 @@ ], "parameters": [ { - "id": 276, + "id": 274, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3496,13 +4178,13 @@ }, "type": { "type": "reference", - "id": 275, + "id": 273, "name": "ColumnName", "dereferenced": {} } }, { - "id": 277, + "id": 275, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3542,12 +4224,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 275, + "id": 273, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -3559,31 +4241,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -3591,7 +4273,7 @@ } }, { - "id": 278, + "id": 276, "name": "containedBy", "kind": 4096, "kindString": "Call signature", @@ -3601,7 +4283,7 @@ }, "parameters": [ { - "id": 279, + "id": 277, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3615,7 +4297,7 @@ } }, { - "id": 280, + "id": 278, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3663,31 +4345,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -3697,7 +4379,7 @@ ] }, { - "id": 265, + "id": 263, "name": "contains", "kind": 2048, "kindString": "Method", @@ -3705,13 +4387,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 254, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 266, + "id": 264, "name": "contains", "kind": 4096, "kindString": "Call signature", @@ -3721,7 +4403,7 @@ }, "typeParameter": [ { - "id": 267, + "id": 265, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3734,7 +4416,7 @@ ], "parameters": [ { - "id": 268, + "id": 266, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3744,13 +4426,13 @@ }, "type": { "type": "reference", - "id": 267, + "id": 265, "name": "ColumnName", "dereferenced": {} } }, { - "id": 269, + "id": 267, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3790,12 +4472,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 267, + "id": 265, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -3807,31 +4489,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -3839,7 +4521,7 @@ } }, { - "id": 270, + "id": 268, "name": "contains", "kind": 4096, "kindString": "Call signature", @@ -3849,7 +4531,7 @@ }, "parameters": [ { - "id": 271, + "id": 269, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3863,7 +4545,7 @@ } }, { - "id": 272, + "id": 270, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3911,31 +4593,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -3945,7 +4627,7 @@ ] }, { - "id": 438, + "id": 436, "name": "csv", "kind": 2048, "kindString": "Method", @@ -3959,7 +4641,7 @@ ], "signatures": [ { - "id": 439, + "id": 437, "name": "csv", "kind": 4096, "kindString": "Call signature", @@ -3969,30 +4651,34 @@ }, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "intrinsic", "name": "string" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 559, + "id": 561, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", - "id": 558, + "id": 560, "name": "default.csv" } }, { - "id": 152, + "id": 160, "name": "eq", "kind": 2048, "kindString": "Method", @@ -4000,13 +4686,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 35, + "line": 87, "character": 2 } ], "signatures": [ { - "id": 153, + "id": 161, "name": "eq", "kind": 4096, "kindString": "Call signature", @@ -4017,7 +4703,7 @@ }, "typeParameter": [ { - "id": 154, + "id": 162, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4030,7 +4716,7 @@ ], "parameters": [ { - "id": 155, + "id": 163, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4040,13 +4726,13 @@ }, "type": { "type": "reference", - "id": 154, + "id": 162, "name": "ColumnName", "dereferenced": {} } }, { - "id": 156, + "id": 164, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4055,150 +4741,110 @@ "shortText": "The value to filter with\n" }, "type": { - "type": "reference", - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { "type": "reference", "id": 154, - "name": "ColumnName" + "name": "Schema" }, - "objectType": { + { "type": "reference", - "id": 147, + "id": 155, "name": "Row" + }, + { + "type": "reference", + "id": 162, + "name": "ColumnName" } - } - ], - "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 157, - "name": "eq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is equal to `value`.", - "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" - }, - "typeParameter": [ - { - "id": 158, - "name": "Value", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 159, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 160, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "intrinsic", + "name": "never" + }, + "trueType": { + "type": "intrinsic", + "name": "unknown" + }, + "falseType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 158, - "name": "Value" + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 162, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ResolvedFilterValue" + } + ], + "qualifiedName": "NonNullable", + "package": "typescript", + "name": "NonNullable" + }, + "falseType": { + "type": "intrinsic", + "name": "never" } - ], - "qualifiedName": "NonNullable", - "package": "typescript", - "name": "NonNullable" + } } } ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -4208,7 +4854,7 @@ ] }, { - "id": 442, + "id": 440, "name": "explain", "kind": 2048, "kindString": "Method", @@ -4222,7 +4868,7 @@ ], "signatures": [ { - "id": 443, + "id": 441, "name": "explain", "kind": 4096, "kindString": "Call signature", @@ -4233,7 +4879,7 @@ }, "parameters": [ { - "id": 444, + "id": 442, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -4245,14 +4891,14 @@ "type": { "type": "reflection", "declaration": { - "id": 445, + "id": 443, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 446, + "id": 444, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -4275,7 +4921,7 @@ } }, { - "id": 449, + "id": 447, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -4298,7 +4944,7 @@ } }, { - "id": 451, + "id": 449, "name": "format", "kind": 1024, "kindString": "Property", @@ -4330,7 +4976,7 @@ } }, { - "id": 448, + "id": 446, "name": "settings", "kind": 1024, "kindString": "Property", @@ -4353,7 +4999,7 @@ } }, { - "id": 447, + "id": 445, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -4376,7 +5022,7 @@ } }, { - "id": 450, + "id": 448, "name": "wal", "kind": 1024, "kindString": "Property", @@ -4403,7 +5049,7 @@ { "title": "Properties", "kind": 1024, - "children": [446, 449, 451, 448, 447, 450] + "children": [444, 447, 449, 446, 445, 448] } ] } @@ -4416,18 +5062,22 @@ "types": [ { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "intrinsic", "name": "string" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "array", @@ -4447,6 +5097,10 @@ "package": "typescript", "name": "Record" } + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -4455,19 +5109,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 563, + "id": 565, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", - "id": 562, + "id": 564, "name": "default.explain" } }, { - "id": 368, + "id": 366, "name": "filter", "kind": 2048, "kindString": "Method", @@ -4475,13 +5129,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 508, + "line": 569, "character": 2 } ], "signatures": [ { - "id": 369, + "id": 367, "name": "filter", "kind": 4096, "kindString": "Call signature", @@ -4492,7 +5146,7 @@ }, "typeParameter": [ { - "id": 370, + "id": 368, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4505,7 +5159,7 @@ ], "parameters": [ { - "id": 371, + "id": 369, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4515,13 +5169,13 @@ }, "type": { "type": "reference", - "id": 370, + "id": 368, "name": "ColumnName", "dereferenced": {} } }, { - "id": 372, + "id": 370, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -4628,7 +5282,7 @@ } }, { - "id": 373, + "id": 371, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4644,31 +5298,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -4676,7 +5330,7 @@ } }, { - "id": 374, + "id": 372, "name": "filter", "kind": 4096, "kindString": "Call signature", @@ -4687,7 +5341,7 @@ }, "parameters": [ { - "id": 375, + "id": 373, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4701,7 +5355,7 @@ } }, { - "id": 376, + "id": 374, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -4715,7 +5369,7 @@ } }, { - "id": 377, + "id": 375, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4731,31 +5385,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -4765,7 +5419,7 @@ ] }, { - "id": 440, + "id": 438, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -4779,7 +5433,7 @@ ], "signatures": [ { - "id": 441, + "id": 439, "name": "geojson", "kind": 4096, "kindString": "Call signature", @@ -4789,7 +5443,7 @@ }, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", @@ -4806,25 +5460,29 @@ "qualifiedName": "Record", "package": "typescript", "name": "Record" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 561, + "id": 563, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", - "id": 560, + "id": 562, "name": "default.geojson" } }, { - "id": 169, + "id": 170, "name": "gt", "kind": 2048, "kindString": "Method", @@ -4832,13 +5490,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 66, + "line": 120, "character": 2 } ], "signatures": [ { - "id": 170, + "id": 171, "name": "gt", "kind": 4096, "kindString": "Call signature", @@ -4848,7 +5506,7 @@ }, "typeParameter": [ { - "id": 171, + "id": 172, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4861,7 +5519,7 @@ ], "parameters": [ { - "id": 172, + "id": 173, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4871,13 +5529,13 @@ }, "type": { "type": "reference", - "id": 171, + "id": 172, "name": "ColumnName", "dereferenced": {} } }, { - "id": 173, + "id": 174, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4889,12 +5547,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 171, + "id": 172, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -4902,31 +5560,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -4934,7 +5592,7 @@ } }, { - "id": 174, + "id": 175, "name": "gt", "kind": 4096, "kindString": "Call signature", @@ -4944,7 +5602,7 @@ }, "parameters": [ { - "id": 175, + "id": 176, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4958,7 +5616,7 @@ } }, { - "id": 176, + "id": 177, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4974,31 +5632,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5008,7 +5666,7 @@ ] }, { - "id": 177, + "id": 178, "name": "gte", "kind": 2048, "kindString": "Method", @@ -5016,13 +5674,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 79, + "line": 133, "character": 2 } ], "signatures": [ { - "id": 178, + "id": 179, "name": "gte", "kind": 4096, "kindString": "Call signature", @@ -5032,7 +5690,7 @@ }, "typeParameter": [ { - "id": 179, + "id": 180, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5045,7 +5703,7 @@ ], "parameters": [ { - "id": 180, + "id": 181, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5055,13 +5713,13 @@ }, "type": { "type": "reference", - "id": 179, + "id": 180, "name": "ColumnName", "dereferenced": {} } }, { - "id": 181, + "id": 182, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -5073,12 +5731,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 179, + "id": 180, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -5086,31 +5744,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5118,7 +5776,7 @@ } }, { - "id": 182, + "id": 183, "name": "gte", "kind": 4096, "kindString": "Call signature", @@ -5128,7 +5786,7 @@ }, "parameters": [ { - "id": 183, + "id": 184, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5142,7 +5800,7 @@ } }, { - "id": 184, + "id": 185, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -5158,31 +5816,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5192,7 +5850,7 @@ ] }, { - "id": 225, + "id": 226, "name": "ilike", "kind": 2048, "kindString": "Method", @@ -5200,13 +5858,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 163, + "line": 217, "character": 2 } ], "signatures": [ { - "id": 226, + "id": 227, "name": "ilike", "kind": 4096, "kindString": "Call signature", @@ -5215,21 +5873,21 @@ "shortText": "Match only rows where `column` matches `pattern` case-insensitively." }, "typeParameter": [ - { - "id": 227, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ { "id": 228, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 229, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5239,13 +5897,13 @@ }, "type": { "type": "reference", - "id": 227, + "id": 228, "name": "ColumnName", "dereferenced": {} } }, { - "id": 229, + "id": 230, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -5261,31 +5919,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5293,7 +5951,7 @@ } }, { - "id": 230, + "id": 231, "name": "ilike", "kind": 4096, "kindString": "Call signature", @@ -5303,7 +5961,7 @@ }, "parameters": [ { - "id": 231, + "id": 232, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5317,7 +5975,7 @@ } }, { - "id": 232, + "id": 233, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -5333,31 +5991,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5367,389 +6025,11 @@ ] }, { - "id": 233, + "id": 234, "name": "ilikeAllOf", "kind": 2048, "kindString": "Method", "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 176, - "character": 2 - } - ], - "signatures": [ - { - "id": 234, - "name": "ilikeAllOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." - }, - "typeParameter": [ - { - "id": 235, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 236, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 235, - "name": "ColumnName", - "dereferenced": {} - } - }, - { - "id": 237, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 238, - "name": "ilikeAllOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." - }, - "parameters": [ - { - "id": 239, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 240, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 241, - "name": "ilikeAnyOf", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 192, - "character": 2 - } - ], - "signatures": [ - { - "id": 242, - "name": "ilikeAnyOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." - }, - "typeParameter": [ - { - "id": 243, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 244, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "reference", - "id": 243, - "name": "ColumnName", - "dereferenced": {} - } - }, - { - "id": 245, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 246, - "name": "ilikeAnyOf", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." - }, - "parameters": [ - { - "id": 247, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 248, - "name": "patterns", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The patterns to match with\n" - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 257, - "name": "in", - "kind": 2048, - "kindString": "Method", - "flags": {}, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", @@ -5759,17 +6039,17 @@ ], "signatures": [ { - "id": 258, - "name": "in", + "id": 235, + "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." + "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." }, "typeParameter": [ { - "id": 259, + "id": 236, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5782,7 +6062,7 @@ ], "parameters": [ { - "id": 260, + "id": 237, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5792,19 +6072,19 @@ }, "type": { "type": "reference", - "id": 259, + "id": 236, "name": "ColumnName", "dereferenced": {} } }, { - "id": 261, - "name": "values", + "id": 238, + "name": "patterns", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values array to filter with\n" + "shortText": "The patterns to match with\n" }, "type": { "type": "typeOperator", @@ -5812,17 +6092,8 @@ "target": { "type": "array", "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 259, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 147, - "name": "Row" - } + "type": "intrinsic", + "name": "string" } } } @@ -5830,31 +6101,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5862,17 +6133,17 @@ } }, { - "id": 262, - "name": "in", + "id": 239, + "name": "ilikeAllOf", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Match only rows where `column` is included in the `values` array." + "shortText": "Match only rows where `column` matches all of `patterns` case-insensitively." }, "parameters": [ { - "id": 263, + "id": 240, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5886,7 +6157,306 @@ } }, { - "id": 264, + "id": 241, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 242, + "name": "ilikeAnyOf", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 246, + "character": 2 + } + ], + "signatures": [ + { + "id": 243, + "name": "ilikeAnyOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + }, + "typeParameter": [ + { + "id": 244, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 245, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 244, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 246, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 247, + "name": "ilikeAnyOf", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` matches any of `patterns` case-insensitively." + }, + "parameters": [ + { + "id": 248, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 249, + "name": "patterns", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The patterns to match with\n" + }, + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 258, + "name": "in", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestFilterBuilder.ts", + "line": 290, + "character": 2 + } + ], + "signatures": [ + { + "id": 259, + "name": "in", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Match only rows where `column` is included in the `values` array." + }, + "typeParameter": [ + { + "id": 260, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 261, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to filter on" + }, + "type": { + "type": "reference", + "id": 260, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 262, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -5900,8 +6470,72 @@ "target": { "type": "array", "elementType": { - "type": "intrinsic", - "name": "unknown" + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 260, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "intrinsic", + "name": "never" + }, + "trueType": { + "type": "intrinsic", + "name": "unknown" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 260, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "trueType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } } } } @@ -5909,31 +6543,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -5943,7 +6577,7 @@ ] }, { - "id": 249, + "id": 250, "name": "is", "kind": 2048, "kindString": "Method", @@ -5951,13 +6585,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 208, + "line": 262, "character": 2 } ], "signatures": [ { - "id": 250, + "id": 251, "name": "is", "kind": 4096, "kindString": "Call signature", @@ -5968,7 +6602,7 @@ }, "typeParameter": [ { - "id": 251, + "id": 252, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5981,7 +6615,7 @@ ], "parameters": [ { - "id": 252, + "id": 253, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5991,13 +6625,13 @@ }, "type": { "type": "reference", - "id": 251, + "id": 252, "name": "ColumnName", "dereferenced": {} } }, { - "id": 253, + "id": 254, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -6015,12 +6649,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 251, + "id": 252, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } }, @@ -6037,12 +6671,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 251, + "id": 252, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } }, @@ -6059,12 +6693,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 251, + "id": 252, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } }, @@ -6080,31 +6714,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6112,7 +6746,7 @@ } }, { - "id": 254, + "id": 255, "name": "is", "kind": 4096, "kindString": "Call signature", @@ -6123,7 +6757,7 @@ }, "parameters": [ { - "id": 255, + "id": 256, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6137,7 +6771,7 @@ } }, { - "id": 256, + "id": 257, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -6162,31 +6796,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6196,7 +6830,7 @@ ] }, { - "id": 201, + "id": 202, "name": "like", "kind": 2048, "kindString": "Method", @@ -6204,13 +6838,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 118, + "line": 172, "character": 2 } ], "signatures": [ { - "id": 202, + "id": 203, "name": "like", "kind": 4096, "kindString": "Call signature", @@ -6220,7 +6854,7 @@ }, "typeParameter": [ { - "id": 203, + "id": 204, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6233,7 +6867,7 @@ ], "parameters": [ { - "id": 204, + "id": 205, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6243,13 +6877,13 @@ }, "type": { "type": "reference", - "id": 203, + "id": 204, "name": "ColumnName", "dereferenced": {} } }, { - "id": 205, + "id": 206, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -6265,31 +6899,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6297,7 +6931,7 @@ } }, { - "id": 206, + "id": 207, "name": "like", "kind": 4096, "kindString": "Call signature", @@ -6307,7 +6941,7 @@ }, "parameters": [ { - "id": 207, + "id": 208, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6321,7 +6955,7 @@ } }, { - "id": 208, + "id": 209, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -6337,31 +6971,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6371,7 +7005,7 @@ ] }, { - "id": 209, + "id": 210, "name": "likeAllOf", "kind": 2048, "kindString": "Method", @@ -6379,13 +7013,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 131, + "line": 185, "character": 2 } ], "signatures": [ { - "id": 210, + "id": 211, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", @@ -6395,7 +7029,7 @@ }, "typeParameter": [ { - "id": 211, + "id": 212, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6408,7 +7042,7 @@ ], "parameters": [ { - "id": 212, + "id": 213, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6418,13 +7052,13 @@ }, "type": { "type": "reference", - "id": 211, + "id": 212, "name": "ColumnName", "dereferenced": {} } }, { - "id": 213, + "id": 214, "name": "patterns", "kind": 32768, "kindString": "Parameter", @@ -6447,31 +7081,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6479,7 +7113,7 @@ } }, { - "id": 214, + "id": 215, "name": "likeAllOf", "kind": 4096, "kindString": "Call signature", @@ -6489,7 +7123,7 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6503,7 +7137,7 @@ } }, { - "id": 216, + "id": 217, "name": "patterns", "kind": 32768, "kindString": "Parameter", @@ -6526,31 +7160,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6560,7 +7194,7 @@ ] }, { - "id": 217, + "id": 218, "name": "likeAnyOf", "kind": 2048, "kindString": "Method", @@ -6568,13 +7202,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 147, + "line": 201, "character": 2 } ], "signatures": [ { - "id": 218, + "id": 219, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", @@ -6584,7 +7218,7 @@ }, "typeParameter": [ { - "id": 219, + "id": 220, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6597,7 +7231,7 @@ ], "parameters": [ { - "id": 220, + "id": 221, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6607,13 +7241,13 @@ }, "type": { "type": "reference", - "id": 219, + "id": 220, "name": "ColumnName", "dereferenced": {} } }, { - "id": 221, + "id": 222, "name": "patterns", "kind": 32768, "kindString": "Parameter", @@ -6636,31 +7270,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6668,7 +7302,7 @@ } }, { - "id": 222, + "id": 223, "name": "likeAnyOf", "kind": 4096, "kindString": "Call signature", @@ -6678,7 +7312,7 @@ }, "parameters": [ { - "id": 223, + "id": 224, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6692,7 +7326,7 @@ } }, { - "id": 224, + "id": 225, "name": "patterns", "kind": 32768, "kindString": "Parameter", @@ -6715,31 +7349,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6749,7 +7383,7 @@ ] }, { - "id": 414, + "id": 412, "name": "limit", "kind": 2048, "kindString": "Method", @@ -6763,7 +7397,7 @@ ], "signatures": [ { - "id": 415, + "id": 413, "name": "limit", "kind": 4096, "kindString": "Call signature", @@ -6773,7 +7407,7 @@ }, "parameters": [ { - "id": 416, + "id": 414, "name": "count", "kind": 32768, "kindString": "Parameter", @@ -6787,7 +7421,7 @@ } }, { - "id": 417, + "id": 415, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6799,14 +7433,14 @@ "type": { "type": "reflection", "declaration": { - "id": 418, + "id": 416, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 419, + "id": 417, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -6829,7 +7463,7 @@ } }, { - "id": 420, + "id": 418, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -6856,7 +7490,7 @@ { "title": "Properties", "kind": 1024, - "children": [419, 420] + "children": [417, 418] } ] } @@ -6866,31 +7500,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -6898,19 +7532,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 535, + "id": 537, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", - "id": 534, + "id": 536, "name": "default.limit" } }, { - "id": 185, + "id": 186, "name": "lt", "kind": 2048, "kindString": "Method", @@ -6918,13 +7552,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 92, + "line": 146, "character": 2 } ], "signatures": [ { - "id": 186, + "id": 187, "name": "lt", "kind": 4096, "kindString": "Call signature", @@ -6934,7 +7568,7 @@ }, "typeParameter": [ { - "id": 187, + "id": 188, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6947,7 +7581,7 @@ ], "parameters": [ { - "id": 188, + "id": 189, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6957,13 +7591,13 @@ }, "type": { "type": "reference", - "id": 187, + "id": 188, "name": "ColumnName", "dereferenced": {} } }, { - "id": 189, + "id": 190, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -6975,12 +7609,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 187, + "id": 188, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -6988,31 +7622,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7020,7 +7654,7 @@ } }, { - "id": 190, + "id": 191, "name": "lt", "kind": 4096, "kindString": "Call signature", @@ -7030,7 +7664,7 @@ }, "parameters": [ { - "id": 191, + "id": 192, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7044,7 +7678,7 @@ } }, { - "id": 192, + "id": 193, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -7060,31 +7694,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7094,7 +7728,7 @@ ] }, { - "id": 193, + "id": 194, "name": "lte", "kind": 2048, "kindString": "Method", @@ -7102,13 +7736,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 105, + "line": 159, "character": 2 } ], "signatures": [ { - "id": 194, + "id": 195, "name": "lte", "kind": 4096, "kindString": "Call signature", @@ -7118,7 +7752,7 @@ }, "typeParameter": [ { - "id": 195, + "id": 196, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7131,7 +7765,7 @@ ], "parameters": [ { - "id": 196, + "id": 197, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7141,13 +7775,13 @@ }, "type": { "type": "reference", - "id": 195, + "id": 196, "name": "ColumnName", "dereferenced": {} } }, { - "id": 197, + "id": 198, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -7159,12 +7793,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 195, + "id": 196, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -7172,31 +7806,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7204,7 +7838,7 @@ } }, { - "id": 198, + "id": 199, "name": "lte", "kind": 4096, "kindString": "Call signature", @@ -7214,7 +7848,7 @@ }, "parameters": [ { - "id": 199, + "id": 200, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7228,7 +7862,7 @@ } }, { - "id": 200, + "id": 201, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -7244,31 +7878,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7278,7 +7912,7 @@ ] }, { - "id": 345, + "id": 343, "name": "match", "kind": 2048, "kindString": "Method", @@ -7286,13 +7920,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 441, + "line": 502, "character": 2 } ], "signatures": [ { - "id": 346, + "id": 344, "name": "match", "kind": 4096, "kindString": "Call signature", @@ -7302,7 +7936,7 @@ }, "typeParameter": [ { - "id": 347, + "id": 345, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7315,7 +7949,7 @@ ], "parameters": [ { - "id": 348, + "id": 346, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -7328,19 +7962,19 @@ "typeArguments": [ { "type": "reference", - "id": 347, + "id": 345, "name": "ColumnName" }, { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 347, + "id": 345, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -7353,31 +7987,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7385,7 +8019,7 @@ } }, { - "id": 349, + "id": 347, "name": "match", "kind": 4096, "kindString": "Call signature", @@ -7395,7 +8029,7 @@ }, "parameters": [ { - "id": 350, + "id": 348, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -7423,31 +8057,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7457,7 +8091,7 @@ ] }, { - "id": 435, + "id": 433, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -7471,7 +8105,7 @@ ], "signatures": [ { - "id": 436, + "id": 434, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", @@ -7482,7 +8116,7 @@ }, "typeParameter": [ { - "id": 437, + "id": 435, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -7491,7 +8125,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, "extendsType": { @@ -7514,7 +8148,7 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "union", @@ -7525,29 +8159,33 @@ }, { "type": "reference", - "id": 437, + "id": 435, "name": "ResultOne" } ] + }, + { + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 556, + "id": 558, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", - "id": 555, + "id": 557, "name": "default.maybeSingle" } }, { - "id": 161, + "id": 165, "name": "neq", "kind": 2048, "kindString": "Method", @@ -7555,13 +8193,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 53, + "line": 108, "character": 2 } ], "signatures": [ { - "id": 162, + "id": 166, "name": "neq", "kind": 4096, "kindString": "Call signature", @@ -7571,7 +8209,7 @@ }, "typeParameter": [ { - "id": 163, + "id": 167, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7584,7 +8222,7 @@ ], "parameters": [ { - "id": 164, + "id": 168, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7594,13 +8232,13 @@ }, "type": { "type": "reference", - "id": 163, + "id": 167, "name": "ColumnName", "dereferenced": {} } }, { - "id": 165, + "id": 169, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -7609,119 +8247,102 @@ "shortText": "The value to filter with\n" }, "type": { - "type": "indexedAccess", - "indexType": { + "type": "conditional", + "checkType": { "type": "reference", - "id": 163, - "name": "ColumnName" + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 167, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" }, - "objectType": { - "type": "reference", - "id": 147, - "name": "Row" + "extendsType": { + "type": "intrinsic", + "name": "never" + }, + "trueType": { + "type": "intrinsic", + "name": "unknown" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 167, + "name": "ColumnName" + } + ], + "name": "ResolveFilterValue" + }, + "extendsType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "trueType": { + "type": "reference", + "name": "ResolvedFilterValue" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } } } } ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, - "name": "Relationships" - } - ], - "name": "default" - } - }, - { - "id": 166, - "name": "neq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Match only rows where `column` is not equal to `value`." - }, - "parameters": [ - { - "id": 167, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to filter on" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 168, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The value to filter with\n" - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 146, - "name": "Schema" - }, - { - "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7731,7 +8352,7 @@ ] }, { - "id": 351, + "id": 349, "name": "not", "kind": 2048, "kindString": "Method", @@ -7739,13 +8360,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 457, + "line": 518, "character": 2 } ], "signatures": [ { - "id": 352, + "id": 350, "name": "not", "kind": 4096, "kindString": "Call signature", @@ -7756,7 +8377,7 @@ }, "typeParameter": [ { - "id": 353, + "id": 351, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7769,7 +8390,7 @@ ], "parameters": [ { - "id": 354, + "id": 352, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7779,13 +8400,13 @@ }, "type": { "type": "reference", - "id": 353, + "id": 351, "name": "ColumnName", "dereferenced": {} } }, { - "id": 355, + "id": 353, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -7799,7 +8420,7 @@ } }, { - "id": 356, + "id": 354, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -7811,12 +8432,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 353, + "id": 351, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -7824,31 +8445,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7856,7 +8477,7 @@ } }, { - "id": 357, + "id": 355, "name": "not", "kind": 4096, "kindString": "Call signature", @@ -7867,7 +8488,7 @@ }, "parameters": [ { - "id": 358, + "id": 356, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7881,7 +8502,7 @@ } }, { - "id": 359, + "id": 357, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -7895,7 +8516,7 @@ } }, { - "id": 360, + "id": 358, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -7911,31 +8532,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -7945,7 +8566,7 @@ ] }, { - "id": 361, + "id": 359, "name": "or", "kind": 2048, "kindString": "Method", @@ -7953,13 +8574,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 496, + "line": 557, "character": 2 } ], "signatures": [ { - "id": 362, + "id": 360, "name": "or", "kind": 4096, "kindString": "Call signature", @@ -7970,7 +8591,7 @@ }, "parameters": [ { - "id": 363, + "id": 361, "name": "filters", "kind": 32768, "kindString": "Parameter", @@ -7984,7 +8605,7 @@ } }, { - "id": 364, + "id": 362, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7996,14 +8617,14 @@ "type": { "type": "reflection", "declaration": { - "id": 365, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 366, + "id": 364, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -8016,7 +8637,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 501, + "line": 562, "character": 9 } ], @@ -8026,7 +8647,7 @@ } }, { - "id": 367, + "id": 365, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -8039,7 +8660,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 501, + "line": 562, "character": 32 } ], @@ -8053,7 +8674,7 @@ { "title": "Properties", "kind": 1024, - "children": [366, 367] + "children": [364, 365] } ] } @@ -8063,31 +8684,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8097,7 +8718,7 @@ ] }, { - "id": 383, + "id": 381, "name": "order", "kind": 2048, "kindString": "Method", @@ -8111,7 +8732,7 @@ ], "signatures": [ { - "id": 384, + "id": 382, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -8121,37 +8742,37 @@ "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "typeParameter": [ + { + "id": 383, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 384, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 383, + "name": "ColumnName", + "dereferenced": {} + } + }, { "id": 385, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 386, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 385, - "name": "ColumnName", - "dereferenced": {} - } - }, - { - "id": 387, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -8164,14 +8785,14 @@ "type": { "type": "reflection", "declaration": { - "id": 388, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 389, + "id": 387, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -8194,7 +8815,7 @@ } }, { - "id": 390, + "id": 388, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -8217,7 +8838,7 @@ } }, { - "id": 391, + "id": 389, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -8244,7 +8865,7 @@ { "title": "Properties", "kind": 1024, - "children": [389, 390, 391] + "children": [387, 388, 389] } ] } @@ -8253,31 +8874,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8285,12 +8906,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 504, + "id": 506, "name": "default.order" } }, { - "id": 392, + "id": 390, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -8301,7 +8922,7 @@ }, "parameters": [ { - "id": 393, + "id": 391, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8315,7 +8936,7 @@ } }, { - "id": 394, + "id": 392, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -8328,14 +8949,14 @@ "type": { "type": "reflection", "declaration": { - "id": 395, + "id": 393, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 396, + "id": 394, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -8358,7 +8979,7 @@ } }, { - "id": 397, + "id": 395, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -8381,7 +9002,7 @@ } }, { - "id": 398, + "id": 396, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -8408,7 +9029,7 @@ { "title": "Properties", "kind": 1024, - "children": [396, 397, 398] + "children": [394, 395, 396] } ] } @@ -8417,31 +9038,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8449,12 +9070,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 512, + "id": 514, "name": "default.order" } }, { - "id": 399, + "id": 397, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -8471,7 +9092,7 @@ }, "typeParameter": [ { - "id": 400, + "id": 398, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8484,7 +9105,7 @@ ], "parameters": [ { - "id": 401, + "id": 399, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8494,13 +9115,13 @@ }, "type": { "type": "reference", - "id": 400, + "id": 398, "name": "ColumnName", "dereferenced": {} } }, { - "id": 402, + "id": 400, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -8513,14 +9134,14 @@ "type": { "type": "reflection", "declaration": { - "id": 403, + "id": 401, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 404, + "id": 402, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -8540,7 +9161,7 @@ } }, { - "id": 406, + "id": 404, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -8560,7 +9181,7 @@ } }, { - "id": 405, + "id": 403, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -8584,7 +9205,7 @@ { "title": "Properties", "kind": 1024, - "children": [404, 406, 405] + "children": [402, 404, 403] } ] } @@ -8593,31 +9214,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8625,12 +9246,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 519, + "id": 521, "name": "default.order" } }, { - "id": 407, + "id": 405, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -8647,7 +9268,7 @@ }, "parameters": [ { - "id": 408, + "id": 406, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8661,7 +9282,7 @@ } }, { - "id": 409, + "id": 407, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -8674,14 +9295,14 @@ "type": { "type": "reflection", "declaration": { - "id": 410, + "id": 408, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 411, + "id": 409, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -8701,7 +9322,7 @@ } }, { - "id": 413, + "id": 411, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -8721,7 +9342,7 @@ } }, { - "id": 412, + "id": 410, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -8745,7 +9366,7 @@ { "title": "Properties", "kind": 1024, - "children": [411, 413, 412] + "children": [409, 411, 410] } ] } @@ -8754,31 +9375,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8786,19 +9407,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 527, + "id": 529, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", - "id": 503, + "id": 505, "name": "default.order" } }, { - "id": 321, + "id": 319, "name": "overlaps", "kind": 2048, "kindString": "Method", @@ -8806,13 +9427,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 380, + "line": 441, "character": 2 } ], "signatures": [ { - "id": 322, + "id": 320, "name": "overlaps", "kind": 4096, "kindString": "Call signature", @@ -8822,7 +9443,7 @@ }, "typeParameter": [ { - "id": 323, + "id": 321, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -8835,7 +9456,7 @@ ], "parameters": [ { - "id": 324, + "id": 322, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8845,13 +9466,13 @@ }, "type": { "type": "reference", - "id": 323, + "id": 321, "name": "ColumnName", "dereferenced": {} } }, { - "id": 325, + "id": 323, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -8875,12 +9496,12 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 323, + "id": 321, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 147, + "id": 155, "name": "Row" } } @@ -8892,31 +9513,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -8924,7 +9545,7 @@ } }, { - "id": 326, + "id": 324, "name": "overlaps", "kind": 4096, "kindString": "Call signature", @@ -8934,7 +9555,7 @@ }, "parameters": [ { - "id": 327, + "id": 325, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -8948,7 +9569,7 @@ } }, { - "id": 328, + "id": 326, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -8980,31 +9601,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9014,7 +9635,7 @@ ] }, { - "id": 421, + "id": 419, "name": "range", "kind": 2048, "kindString": "Method", @@ -9028,17 +9649,17 @@ ], "signatures": [ { - "id": 422, + "id": 420, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by starting at an offset (`from`) and ending at the offset (`from + 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." + "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." }, "parameters": [ { - "id": 423, + "id": 421, "name": "from", "kind": 32768, "kindString": "Parameter", @@ -9052,7 +9673,7 @@ } }, { - "id": 424, + "id": 422, "name": "to", "kind": 32768, "kindString": "Parameter", @@ -9066,7 +9687,7 @@ } }, { - "id": 425, + "id": 423, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -9078,14 +9699,14 @@ "type": { "type": "reflection", "declaration": { - "id": 426, + "id": 424, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 427, + "id": 425, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -9108,7 +9729,7 @@ } }, { - "id": 428, + "id": 426, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -9135,7 +9756,7 @@ { "title": "Properties", "kind": 1024, - "children": [427, 428] + "children": [425, 426] } ] } @@ -9145,31 +9766,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9177,19 +9798,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 542, + "id": 544, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", - "id": 541, + "id": 543, "name": "default.range" } }, { - "id": 313, + "id": 311, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", @@ -9197,13 +9818,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 365, + "line": 426, "character": 2 } ], "signatures": [ { - "id": 314, + "id": 312, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", @@ -9213,7 +9834,7 @@ }, "typeParameter": [ { - "id": 315, + "id": 313, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9226,7 +9847,7 @@ ], "parameters": [ { - "id": 316, + "id": 314, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9236,13 +9857,13 @@ }, "type": { "type": "reference", - "id": 315, + "id": 313, "name": "ColumnName", "dereferenced": {} } }, { - "id": 317, + "id": 315, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -9258,31 +9879,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9290,7 +9911,7 @@ } }, { - "id": 318, + "id": 316, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", @@ -9300,7 +9921,7 @@ }, "parameters": [ { - "id": 319, + "id": 317, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9314,7 +9935,7 @@ } }, { - "id": 320, + "id": 318, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -9330,31 +9951,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9364,7 +9985,7 @@ ] }, { - "id": 281, + "id": 279, "name": "rangeGt", "kind": 2048, "kindString": "Method", @@ -9372,13 +9993,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 307, + "line": 368, "character": 2 } ], "signatures": [ { - "id": 282, + "id": 280, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", @@ -9388,7 +10009,7 @@ }, "typeParameter": [ { - "id": 283, + "id": 281, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9401,7 +10022,7 @@ ], "parameters": [ { - "id": 284, + "id": 282, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9411,13 +10032,13 @@ }, "type": { "type": "reference", - "id": 283, + "id": 281, "name": "ColumnName", "dereferenced": {} } }, { - "id": 285, + "id": 283, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -9433,31 +10054,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9465,7 +10086,7 @@ } }, { - "id": 286, + "id": 284, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", @@ -9475,7 +10096,7 @@ }, "parameters": [ { - "id": 287, + "id": 285, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9489,7 +10110,7 @@ } }, { - "id": 288, + "id": 286, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -9505,31 +10126,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9539,7 +10160,7 @@ ] }, { - "id": 289, + "id": 287, "name": "rangeGte", "kind": 2048, "kindString": "Method", @@ -9547,13 +10168,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 321, + "line": 382, "character": 2 } ], "signatures": [ { - "id": 290, + "id": 288, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", @@ -9563,7 +10184,7 @@ }, "typeParameter": [ { - "id": 291, + "id": 289, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9576,7 +10197,7 @@ ], "parameters": [ { - "id": 292, + "id": 290, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9586,13 +10207,13 @@ }, "type": { "type": "reference", - "id": 291, + "id": 289, "name": "ColumnName", "dereferenced": {} } }, { - "id": 293, + "id": 291, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -9608,31 +10229,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9640,7 +10261,7 @@ } }, { - "id": 294, + "id": 292, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", @@ -9650,7 +10271,7 @@ }, "parameters": [ { - "id": 295, + "id": 293, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9664,7 +10285,7 @@ } }, { - "id": 296, + "id": 294, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -9680,31 +10301,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9714,7 +10335,7 @@ ] }, { - "id": 297, + "id": 295, "name": "rangeLt", "kind": 2048, "kindString": "Method", @@ -9722,13 +10343,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 336, + "line": 397, "character": 2 } ], "signatures": [ { - "id": 298, + "id": 296, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", @@ -9738,7 +10359,7 @@ }, "typeParameter": [ { - "id": 299, + "id": 297, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9751,7 +10372,7 @@ ], "parameters": [ { - "id": 300, + "id": 298, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9761,13 +10382,13 @@ }, "type": { "type": "reference", - "id": 299, + "id": 297, "name": "ColumnName", "dereferenced": {} } }, { - "id": 301, + "id": 299, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -9783,31 +10404,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9815,7 +10436,7 @@ } }, { - "id": 302, + "id": 300, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", @@ -9825,7 +10446,7 @@ }, "parameters": [ { - "id": 303, + "id": 301, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9839,7 +10460,7 @@ } }, { - "id": 304, + "id": 302, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -9855,31 +10476,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9889,7 +10510,7 @@ ] }, { - "id": 305, + "id": 303, "name": "rangeLte", "kind": 2048, "kindString": "Method", @@ -9897,13 +10518,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 350, + "line": 411, "character": 2 } ], "signatures": [ { - "id": 306, + "id": 304, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", @@ -9913,7 +10534,7 @@ }, "typeParameter": [ { - "id": 307, + "id": 305, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9926,7 +10547,7 @@ ], "parameters": [ { - "id": 308, + "id": 306, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9936,13 +10557,13 @@ }, "type": { "type": "reference", - "id": 307, + "id": 305, "name": "ColumnName", "dereferenced": {} } }, { - "id": 309, + "id": 307, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -9958,31 +10579,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -9990,7 +10611,7 @@ } }, { - "id": 310, + "id": 308, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", @@ -10000,7 +10621,7 @@ }, "parameters": [ { - "id": 311, + "id": 309, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -10014,7 +10635,7 @@ } }, { - "id": 312, + "id": 310, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -10030,31 +10651,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -10064,7 +10685,7 @@ ] }, { - "id": 454, + "id": 452, "name": "returns", "kind": 2048, "kindString": "Method", @@ -10078,7 +10699,7 @@ ], "signatures": [ { - "id": 455, + "id": 453, "name": "returns", "kind": 4096, "kindString": "Call signature", @@ -10088,7 +10709,7 @@ }, "typeParameter": [ { - "id": 456, + "id": 454, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", @@ -10100,31 +10721,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 456, + "id": 454, "name": "NewResult" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -10132,19 +10753,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 575, + "id": 577, "name": "default.returns" } } ], "inheritedFrom": { "type": "reference", - "id": 574, + "id": 576, "name": "default.returns" } }, { - "id": 452, + "id": 450, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -10158,7 +10779,7 @@ ], "signatures": [ { - "id": 453, + "id": 451, "name": "rollback", "kind": 4096, "kindString": "Call signature", @@ -10169,31 +10790,31 @@ }, "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -10201,19 +10822,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 573, + "id": 575, "name": "default.rollback" } } ], "inheritedFrom": { "type": "reference", - "id": 572, + "id": 574, "name": "default.rollback" } }, { - "id": 378, + "id": 376, "name": "select", "kind": 2048, "kindString": "Method", @@ -10227,7 +10848,7 @@ ], "signatures": [ { - "id": 379, + "id": 377, "name": "select", "kind": 4096, "kindString": "Call signature", @@ -10238,7 +10859,7 @@ }, "typeParameter": [ { - "id": 380, + "id": 378, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -10253,37 +10874,38 @@ } }, { - "id": 381, + "id": 379, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", + "id": 685, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" }, { "type": "reference", - "id": 380, + "id": 378, "name": "Query" } ], @@ -10293,7 +10915,7 @@ ], "parameters": [ { - "id": 382, + "id": 380, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -10305,7 +10927,7 @@ }, "type": { "type": "reference", - "id": 380, + "id": 378, "name": "Query", "dereferenced": {} } @@ -10313,34 +10935,34 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 381, + "id": 379, "name": "NewResultOne" } }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -10348,19 +10970,111 @@ }, "inheritedFrom": { "type": "reference", - "id": 499, + "id": 501, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", - "id": 498, + "id": 500, "name": "default.select" } }, { - "id": 432, + "id": 470, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 471, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 472, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 473, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 595, + "name": "default.setHeader" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 594, + "name": "default.setHeader" + } + }, + { + "id": 430, "name": "single", "kind": 2048, "kindString": "Method", @@ -10374,7 +11088,7 @@ ], "signatures": [ { - "id": 433, + "id": 431, "name": "single", "kind": 4096, "kindString": "Call signature", @@ -10385,7 +11099,7 @@ }, "typeParameter": [ { - "id": 434, + "id": 432, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -10394,7 +11108,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, "extendsType": { @@ -10417,31 +11131,35 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 434, + "id": 432, "name": "ResultOne" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, "inheritedFrom": { "type": "reference", - "id": 553, + "id": 555, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", - "id": 552, + "id": 554, "name": "default.single" } }, { - "id": 329, + "id": 327, "name": "textSearch", "kind": 2048, "kindString": "Method", @@ -10449,13 +11167,13 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 403, + "line": 464, "character": 2 } ], "signatures": [ { - "id": 330, + "id": 328, "name": "textSearch", "kind": 4096, "kindString": "Call signature", @@ -10465,7 +11183,7 @@ }, "typeParameter": [ { - "id": 331, + "id": 329, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -10478,7 +11196,7 @@ ], "parameters": [ { - "id": 332, + "id": 330, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -10488,13 +11206,13 @@ }, "type": { "type": "reference", - "id": 331, + "id": 329, "name": "ColumnName", "dereferenced": {} } }, { - "id": 333, + "id": 331, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -10508,7 +11226,7 @@ } }, { - "id": 334, + "id": 332, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -10521,14 +11239,14 @@ "type": { "type": "reflection", "declaration": { - "id": 335, + "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 336, + "id": 334, "name": "config", "kind": 1024, "kindString": "Property", @@ -10541,7 +11259,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 406, + "line": 467, "character": 16 } ], @@ -10551,7 +11269,7 @@ } }, { - "id": 337, + "id": 335, "name": "type", "kind": 1024, "kindString": "Property", @@ -10564,7 +11282,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 406, + "line": 467, "character": 33 } ], @@ -10591,7 +11309,7 @@ { "title": "Properties", "kind": 1024, - "children": [336, 337] + "children": [334, 335] } ] } @@ -10600,31 +11318,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -10632,7 +11350,7 @@ } }, { - "id": 338, + "id": 336, "name": "textSearch", "kind": 4096, "kindString": "Call signature", @@ -10642,7 +11360,7 @@ }, "parameters": [ { - "id": 339, + "id": 337, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -10656,7 +11374,7 @@ } }, { - "id": 340, + "id": 338, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -10670,7 +11388,7 @@ } }, { - "id": 341, + "id": 339, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -10683,14 +11401,14 @@ "type": { "type": "reflection", "declaration": { - "id": 342, + "id": 340, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 343, + "id": 341, "name": "config", "kind": 1024, "kindString": "Property", @@ -10703,7 +11421,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 411, + "line": 472, "character": 16 } ], @@ -10713,7 +11431,7 @@ } }, { - "id": 344, + "id": 342, "name": "type", "kind": 1024, "kindString": "Property", @@ -10726,7 +11444,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 411, + "line": 472, "character": 33 } ], @@ -10753,7 +11471,7 @@ { "title": "Properties", "kind": 1024, - "children": [343, 344] + "children": [341, 342] } ] } @@ -10762,31 +11480,31 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -10796,7 +11514,7 @@ ] }, { - "id": 472, + "id": 474, "name": "then", "kind": 2048, "kindString": "Method", @@ -10804,31 +11522,31 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 473, + "id": 475, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 474, + "id": 476, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 156, "name": "Result" } ], @@ -10836,7 +11554,7 @@ } }, { - "id": 475, + "id": 477, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -10849,7 +11567,7 @@ ], "parameters": [ { - "id": 476, + "id": 478, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -10866,32 +11584,32 @@ { "type": "reflection", "declaration": { - "id": 477, + "id": 479, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 478, + "id": 480, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 479, + "id": 481, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 156, "name": "Result" } ], @@ -10904,7 +11622,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -10912,7 +11630,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -10930,7 +11648,7 @@ } }, { - "id": 480, + "id": 482, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -10947,21 +11665,21 @@ { "type": "reflection", "declaration": { - "id": 481, + "id": 483, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 482, + "id": 484, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 483, + "id": 485, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -10977,7 +11695,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -10985,7 +11703,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -11011,12 +11729,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -11028,19 +11746,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 593, + "id": 599, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 592, + "id": 598, "name": "default.then" } }, { - "id": 470, + "id": 468, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -11048,13 +11766,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 471, + "id": 469, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -11064,47 +11782,68 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 143, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 146, - "name": "Schema" + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 154, + "name": "Schema" + }, + { + "type": "reference", + "id": 155, + "name": "Row" + }, + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "reference", + "id": 157, + "name": "RelationName" + }, + { + "type": "reference", + "id": 158, + "name": "Relationships" + } + ], + "name": "default" }, { "type": "reference", - "id": 147, - "name": "Row" - }, - { - "type": "reference", - "id": 148, - "name": "Result" - }, - { - "type": "reference", - "id": 149, - "name": "RelationName" - }, - { - "type": "reference", - "id": 150, - "name": "Relationships" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 156, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] }, "inheritedFrom": { "type": "reference", - "id": 591, + "id": 593, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 590, + "id": 592, "name": "default.throwOnError" } } @@ -11113,33 +11852,33 @@ { "title": "Constructors", "kind": 512, - "children": [144] + "children": [152] }, { "title": "Properties", "kind": 1024, - "children": [461, 464, 459, 469, 457, 460, 462, 463, 458] + "children": [459, 462, 457, 467, 455, 458, 460, 461, 456] }, { "title": "Methods", "kind": 2048, "children": [ - 429, 273, 265, 438, 152, 442, 368, 440, 169, 177, 225, 233, 241, 257, 249, 201, 209, - 217, 414, 185, 193, 345, 435, 161, 351, 361, 383, 321, 421, 313, 281, 289, 297, 305, - 454, 452, 378, 432, 329, 472, 470 + 427, 271, 263, 436, 160, 440, 366, 438, 170, 178, 226, 234, 242, 258, 250, 202, 210, + 218, 412, 186, 194, 343, 433, 165, 349, 359, 381, 319, 419, 311, 279, 287, 295, 303, + 452, 450, 376, 470, 430, 327, 474, 468 ] } ], "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 28, + "line": 72, "character": 21 } ], "typeParameter": [ { - "id": 484, + "id": 486, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -11150,7 +11889,7 @@ } }, { - "id": 485, + "id": 487, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -11173,14 +11912,14 @@ } }, { - "id": 486, + "id": 488, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 487, + "id": 489, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -11191,7 +11930,7 @@ } }, { - "id": 488, + "id": 490, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -11205,31 +11944,31 @@ "extendedTypes": [ { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 146, + "id": 154, "name": "Schema" }, { "type": "reference", - "id": 147, + "id": 155, "name": "Row" }, { "type": "reference", - "id": 148, + "id": 156, "name": "Result" }, { "type": "reference", - "id": 149, + "id": 157, "name": "RelationName" }, { "type": "reference", - "id": 150, + "id": 158, "name": "Relationships" } ], @@ -11238,14 +11977,14 @@ ] }, { - "id": 56, + "id": 64, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 57, + "id": 65, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -11259,14 +11998,14 @@ ], "signatures": [ { - "id": 58, + "id": 66, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 59, + "id": 67, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -11277,7 +12016,7 @@ } }, { - "id": 60, + "id": 68, "name": "Relation", "kind": 131072, "kindString": "Type parameter", @@ -11297,7 +12036,7 @@ } }, { - "id": 61, + "id": 69, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -11308,7 +12047,7 @@ } }, { - "id": 64, + "id": 72, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -11317,20 +12056,20 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { - "id": 62, + "id": 70, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 63, + "id": 71, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -11352,7 +12091,7 @@ { "title": "Properties", "kind": 1024, - "children": [63] + "children": [71] } ] } @@ -11370,7 +12109,7 @@ ], "parameters": [ { - "id": 65, + "id": 73, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -11383,7 +12122,7 @@ } }, { - "id": 66, + "id": 74, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -11391,14 +12130,14 @@ "type": { "type": "reflection", "declaration": { - "id": 67, + "id": 75, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 70, + "id": 78, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -11415,21 +12154,21 @@ "type": { "type": "reflection", "declaration": { - "id": 71, + "id": 79, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 72, + "id": 80, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 73, + "id": 81, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -11453,7 +12192,7 @@ } }, { - "id": 74, + "id": 82, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -11488,7 +12227,7 @@ } }, { - "id": 68, + "id": 76, "name": "headers", "kind": 1024, "kindString": "Property", @@ -11520,7 +12259,7 @@ } }, { - "id": 69, + "id": 77, "name": "schema", "kind": 1024, "kindString": "Property", @@ -11544,7 +12283,7 @@ { "title": "Properties", "kind": 1024, - "children": [70, 68, 69] + "children": [78, 76, 77] } ] } @@ -11553,26 +12292,26 @@ ], "type": { "type": "reference", - "id": 56, + "id": 64, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -11582,7 +12321,7 @@ ] }, { - "id": 79, + "id": 87, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -11599,21 +12338,21 @@ "type": { "type": "reflection", "declaration": { - "id": 80, + "id": 88, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 81, + "id": 89, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 82, + "id": 90, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -11637,7 +12376,7 @@ } }, { - "id": 83, + "id": 91, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -11672,7 +12411,7 @@ } }, { - "id": 76, + "id": 84, "name": "headers", "kind": 1024, "kindString": "Property", @@ -11702,7 +12441,7 @@ } }, { - "id": 77, + "id": 85, "name": "schema", "kind": 1024, "kindString": "Property", @@ -11722,7 +12461,7 @@ } }, { - "id": 78, + "id": 86, "name": "signal", "kind": 1024, "kindString": "Property", @@ -11744,7 +12483,7 @@ } }, { - "id": 75, + "id": 83, "name": "url", "kind": 1024, "kindString": "Property", @@ -11764,7 +12503,7 @@ } }, { - "id": 132, + "id": 140, "name": "delete", "kind": 2048, "kindString": "Method", @@ -11778,7 +12517,7 @@ ], "signatures": [ { - "id": 133, + "id": 141, "name": "delete", "kind": 4096, "kindString": "Call signature", @@ -11789,7 +12528,7 @@ }, "parameters": [ { - "id": 134, + "id": 142, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -11801,14 +12540,14 @@ "type": { "type": "reflection", "declaration": { - "id": 135, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 136, + "id": 144, "name": "count", "kind": 1024, "kindString": "Property", @@ -11848,7 +12587,7 @@ { "title": "Properties", "kind": 1024, - "children": [136] + "children": [144] } ] } @@ -11858,11 +12597,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -11873,7 +12612,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -11883,12 +12622,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -11898,7 +12637,7 @@ ] }, { - "id": 93, + "id": 101, "name": "insert", "kind": 2048, "kindString": "Method", @@ -11912,7 +12651,7 @@ ], "signatures": [ { - "id": 94, + "id": 102, "name": "insert", "kind": 4096, "kindString": "Call signature", @@ -11923,7 +12662,7 @@ }, "typeParameter": [ { - "id": 95, + "id": 103, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -11948,7 +12687,7 @@ ], "parameters": [ { - "id": 96, + "id": 104, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -11958,13 +12697,13 @@ }, "type": { "type": "reference", - "id": 95, + "id": 103, "name": "Row", "dereferenced": {} } }, { - "id": 97, + "id": 105, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -11977,14 +12716,14 @@ "type": { "type": "reflection", "declaration": { - "id": 98, + "id": 106, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 99, + "id": 107, "name": "count", "kind": 1024, "kindString": "Property", @@ -12024,7 +12763,7 @@ { "title": "Properties", "kind": 1024, - "children": [99] + "children": [107] } ] } @@ -12033,11 +12772,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -12048,7 +12787,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -12058,12 +12797,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -12071,7 +12810,7 @@ } }, { - "id": 100, + "id": 108, "name": "insert", "kind": 4096, "kindString": "Call signature", @@ -12082,7 +12821,7 @@ }, "typeParameter": [ { - "id": 101, + "id": 109, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -12107,7 +12846,7 @@ ], "parameters": [ { - "id": 102, + "id": 110, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -12119,13 +12858,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 101, + "id": 109, "name": "Row" } } }, { - "id": 103, + "id": 111, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -12138,14 +12877,14 @@ "type": { "type": "reflection", "declaration": { - "id": 104, + "id": 112, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 105, + "id": 113, "name": "count", "kind": 1024, "kindString": "Property", @@ -12181,7 +12920,7 @@ } }, { - "id": 106, + "id": 114, "name": "defaultToNull", "kind": 1024, "kindString": "Property", @@ -12208,7 +12947,7 @@ { "title": "Properties", "kind": 1024, - "children": [105, 106] + "children": [113, 114] } ] } @@ -12217,11 +12956,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -12232,7 +12971,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -12242,12 +12981,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -12257,7 +12996,7 @@ ] }, { - "id": 84, + "id": 92, "name": "select", "kind": 2048, "kindString": "Method", @@ -12271,7 +13010,7 @@ ], "signatures": [ { - "id": 85, + "id": 93, "name": "select", "kind": 4096, "kindString": "Call signature", @@ -12281,7 +13020,7 @@ }, "typeParameter": [ { - "id": 86, + "id": 94, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -12296,17 +13035,18 @@ } }, { - "id": 87, + "id": 95, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", + "id": 685, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -12317,23 +13057,23 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" }, { "type": "reference", - "id": 86, + "id": 94, "name": "Query" } ], @@ -12343,7 +13083,7 @@ ], "parameters": [ { - "id": 88, + "id": 96, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -12355,13 +13095,13 @@ }, "type": { "type": "reference", - "id": 86, + "id": 94, "name": "Query", "dereferenced": {} } }, { - "id": 89, + "id": 97, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -12373,14 +13113,14 @@ "type": { "type": "reflection", "declaration": { - "id": 90, + "id": 98, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 92, + "id": 100, "name": "count", "kind": 1024, "kindString": "Property", @@ -12416,7 +13156,7 @@ } }, { - "id": 91, + "id": 99, "name": "head", "kind": 1024, "kindString": "Property", @@ -12443,7 +13183,7 @@ { "title": "Properties", "kind": 1024, - "children": [92, 91] + "children": [100, 99] } ] } @@ -12453,11 +13193,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -12468,7 +13208,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -12476,18 +13216,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 87, + "id": 95, "name": "ResultOne" } }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -12497,7 +13237,7 @@ ] }, { - "id": 125, + "id": 133, "name": "update", "kind": 2048, "kindString": "Method", @@ -12511,7 +13251,7 @@ ], "signatures": [ { - "id": 126, + "id": 134, "name": "update", "kind": 4096, "kindString": "Call signature", @@ -12522,7 +13262,7 @@ }, "typeParameter": [ { - "id": 127, + "id": 135, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -12547,7 +13287,7 @@ ], "parameters": [ { - "id": 128, + "id": 136, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -12557,13 +13297,13 @@ }, "type": { "type": "reference", - "id": 127, + "id": 135, "name": "Row", "dereferenced": {} } }, { - "id": 129, + "id": 137, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -12575,14 +13315,14 @@ "type": { "type": "reflection", "declaration": { - "id": 130, + "id": 138, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 131, + "id": 139, "name": "count", "kind": 1024, "kindString": "Property", @@ -12622,7 +13362,7 @@ { "title": "Properties", "kind": 1024, - "children": [131] + "children": [139] } ] } @@ -12632,11 +13372,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -12647,7 +13387,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -12657,12 +13397,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -12672,7 +13412,7 @@ ] }, { - "id": 107, + "id": 115, "name": "upsert", "kind": 2048, "kindString": "Method", @@ -12685,211 +13425,6 @@ } ], "signatures": [ - { - "id": 108, - "name": "upsert", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "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`.", - "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" - }, - "typeParameter": [ - { - "id": 109, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "parameters": [ - { - "id": 110, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" - }, - "type": { - "type": "reference", - "id": 109, - "name": "Row", - "dereferenced": {} - } - }, - { - "id": 111, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Named parameters\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 112, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 115, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "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.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 189, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 114, - "name": "ignoreDuplicates", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 188, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 113, - "name": "onConflict", - "kind": 1024, - "kindString": "Property", - "flags": { - "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.\n" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 187, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [115, 114, 113] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 143, - "typeArguments": [ - { - "type": "reference", - "id": 59, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 60, - "name": "Relation" - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 61, - "name": "RelationName" - }, - { - "type": "reference", - "id": 64, - "name": "Relationships" - } - ], - "name": "default" - } - }, { "id": 116, "name": "upsert", @@ -12936,12 +13471,10 @@ "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 117, - "name": "Row" - } + "type": "reference", + "id": 117, + "name": "Row", + "dereferenced": {} } }, { @@ -12975,6 +13508,213 @@ "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.\n" }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 189, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "exact" + }, + { + "type": "literal", + "value": "planned" + }, + { + "type": "literal", + "value": "estimated" + } + ] + } + }, + { + "id": 122, + "name": "ignoreDuplicates", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 188, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 121, + "name": "onConflict", + "kind": 1024, + "kindString": "Property", + "flags": { + "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.\n" + }, + "sources": [ + { + "fileName": "src/PostgrestQueryBuilder.ts", + "line": 187, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [123, 122, 121] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 151, + "typeArguments": [ + { + "type": "reference", + "id": 67, + "name": "Schema" + }, + { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "Row" + }, + "objectType": { + "type": "reference", + "id": 68, + "name": "Relation" + } + }, + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 69, + "name": "RelationName" + }, + { + "type": "reference", + "id": 72, + "name": "Relationships" + } + ], + "name": "default" + } + }, + { + "id": 124, + "name": "upsert", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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`.", + "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" + }, + "typeParameter": [ + { + "id": 125, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "parameters": [ + { + "id": 126, + "name": "values", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 125, + "name": "Row" + } + } + }, + { + "id": 127, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Named parameters\n" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 128, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 131, + "name": "count", + "kind": 1024, + "kindString": "Property", + "flags": { + "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.\n" + }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", @@ -13001,7 +13741,7 @@ } }, { - "id": 124, + "id": 132, "name": "defaultToNull", "kind": 1024, "kindString": "Property", @@ -13024,7 +13764,7 @@ } }, { - "id": 122, + "id": 130, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", @@ -13047,7 +13787,7 @@ } }, { - "id": 121, + "id": 129, "name": "onConflict", "kind": 1024, "kindString": "Property", @@ -13074,7 +13814,7 @@ { "title": "Properties", "kind": 1024, - "children": [123, 124, 122, 121] + "children": [131, 132, 130, 129] } ] } @@ -13083,11 +13823,11 @@ ], "type": { "type": "reference", - "id": 143, + "id": 151, "typeArguments": [ { "type": "reference", - "id": 59, + "id": 67, "name": "Schema" }, { @@ -13098,7 +13838,7 @@ }, "objectType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" } }, @@ -13108,12 +13848,12 @@ }, { "type": "reference", - "id": 61, + "id": 69, "name": "RelationName" }, { "type": "reference", - "id": 64, + "id": 72, "name": "Relationships" } ], @@ -13127,17 +13867,17 @@ { "title": "Constructors", "kind": 512, - "children": [57] + "children": [65] }, { "title": "Properties", "kind": 1024, - "children": [79, 76, 77, 78, 75] + "children": [87, 84, 85, 86, 83] }, { "title": "Methods", "kind": 2048, - "children": [132, 93, 84, 125, 107] + "children": [140, 101, 92, 133, 115] } ], "sources": [ @@ -13149,7 +13889,7 @@ ], "typeParameter": [ { - "id": 137, + "id": 145, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -13160,7 +13900,7 @@ } }, { - "id": 138, + "id": 146, "name": "Relation", "kind": 131072, "kindString": "Type parameter", @@ -13180,7 +13920,7 @@ } }, { - "id": 139, + "id": 147, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -13191,7 +13931,7 @@ } }, { - "id": 142, + "id": 150, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -13200,20 +13940,20 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 60, + "id": 68, "name": "Relation" }, "extendsType": { "type": "reflection", "declaration": { - "id": 140, + "id": 148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 141, + "id": 149, "name": "Relationships", "kind": 1024, "kindString": "Property", @@ -13235,7 +13975,7 @@ { "title": "Properties", "kind": 1024, - "children": [141] + "children": [149] } ], "sources": [ @@ -13260,28 +14000,28 @@ ] }, { - "id": 489, + "id": 491, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 490, + "id": 492, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 491, + "id": 493, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 492, + "id": 494, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -13292,7 +14032,7 @@ } }, { - "id": 493, + "id": 495, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -13315,14 +14055,14 @@ } }, { - "id": 494, + "id": 496, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 495, + "id": 497, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -13333,7 +14073,7 @@ } }, { - "id": 496, + "id": 498, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -13346,24 +14086,28 @@ ], "parameters": [ { - "id": 497, + "id": 499, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 496, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default", "dereferenced": { - "id": 609, + "id": 615, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -13372,7 +14116,7 @@ }, "children": [ { - "id": 610, + "id": 616, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -13380,56 +14124,80 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 20, + "line": 23, "character": 2 } ], "signatures": [ { - "id": 611, + "id": 617, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 612, + "id": 618, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 619, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "parameters": [ { - "id": 613, + "id": 620, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "literal", + "value": false } ], "name": "default", - "dereferenced": "[Circular ~.children.4.children.0.signatures.0.parameters.0.type.dereferenced]" + "dereferenced": "[Circular ~.children.5.children.0.signatures.0.parameters.0.type.dereferenced]" } } ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 612, + "id": 618, "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" } ], "name": "default" @@ -13438,7 +14206,7 @@ ] }, { - "id": 618, + "id": 625, "name": "body", "kind": 1024, "kindString": "Property", @@ -13449,7 +14217,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -13459,7 +14227,7 @@ } }, { - "id": 621, + "id": 628, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -13469,28 +14237,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 622, + "id": 629, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 623, + "id": 630, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 624, + "id": 631, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -13514,7 +14282,7 @@ } }, { - "id": 625, + "id": 632, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -13549,7 +14317,7 @@ } }, { - "id": 616, + "id": 623, "name": "headers", "kind": 1024, "kindString": "Property", @@ -13559,7 +14327,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -13581,7 +14349,7 @@ } }, { - "id": 626, + "id": 633, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -13591,7 +14359,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -13601,7 +14369,7 @@ } }, { - "id": 614, + "id": 621, "name": "method", "kind": 1024, "kindString": "Property", @@ -13611,7 +14379,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -13642,7 +14410,7 @@ } }, { - "id": 617, + "id": 624, "name": "schema", "kind": 1024, "kindString": "Property", @@ -13650,48 +14418,6 @@ "isProtected": true, "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 619, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 620, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, "sources": [ { "fileName": "src/PostgrestBuilder.ts", @@ -13699,6 +14425,48 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 626, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 627, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -13707,7 +14475,7 @@ } }, { - "id": 615, + "id": 622, "name": "url", "kind": 1024, "kindString": "Property", @@ -13717,7 +14485,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -13729,7 +14497,74 @@ } }, { - "id": 629, + "id": 636, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 637, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 638, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 639, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 640, "name": "then", "kind": 2048, "kindString": "Method", @@ -13737,39 +14572,63 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 630, + "id": 641, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 631, + "id": 642, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } }, { - "id": 632, + "id": 643, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -13782,7 +14641,7 @@ ], "parameters": [ { - "id": 633, + "id": 644, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -13799,36 +14658,60 @@ { "type": "reflection", "declaration": { - "id": 634, + "id": 645, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 635, + "id": 646, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 636, + "id": 647, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } } ], @@ -13837,7 +14720,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -13845,7 +14728,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -13863,7 +14746,7 @@ } }, { - "id": 637, + "id": 648, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -13880,21 +14763,21 @@ { "type": "reflection", "declaration": { - "id": 638, + "id": 649, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 639, + "id": 650, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 640, + "id": 651, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -13910,7 +14793,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -13918,7 +14801,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -13944,12 +14827,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -13971,7 +14854,7 @@ } }, { - "id": 627, + "id": 634, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -13979,13 +14862,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 628, + "id": 635, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -13995,16 +14878,42 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 609, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 612, - "name": "Result" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + } + ], + "name": "default" + }, + { + "type": "reference", + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] } } ] @@ -14014,17 +14923,17 @@ { "title": "Constructors", "kind": 512, - "children": [610] + "children": [616] }, { "title": "Properties", "kind": 1024, - "children": [618, 621, 616, 626, 614, 617, 619, 620, 615] + "children": [625, 628, 623, 633, 621, 624, 626, 627, 622] }, { "title": "Methods", "kind": 2048, - "children": [629, 627] + "children": [636, 640, 634] } ], "sources": [ @@ -14036,17 +14945,32 @@ ], "typeParameter": [ { - "id": 641, + "id": 652, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 653, + "name": "ThrowOnError", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "default": { + "type": "literal", + "value": false + } } ], "extendedBy": [ { "type": "reference", - "id": 489, + "id": 491, "name": "PostgrestTransformBuilder" } ], @@ -14055,16 +14979,40 @@ "type": "reference", "typeArguments": [ { - "type": "reference", - "id": 657, - "typeArguments": [ - { - "type": "reference", - "id": 612, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" + "type": "conditional", + "checkType": { + "type": "reference", + "id": 619, + "name": "ThrowOnError" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "reference", + "id": 674, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestResponseSuccess" + }, + "falseType": { + "type": "reference", + "id": 681, + "typeArguments": [ + { + "type": "reference", + "id": 618, + "name": "Result" + } + ], + "name": "PostgrestSingleResponse" + } } ], "qualifiedName": "PromiseLike", @@ -14078,31 +15026,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -14110,19 +15058,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 611, + "id": 617, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 610, + "id": 616, "name": "default.constructor" } }, { - "id": 581, + "id": 583, "name": "body", "kind": 1024, "kindString": "Property", @@ -14133,7 +15081,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 14, + "line": 17, "character": 12 } ], @@ -14143,12 +15091,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 618, + "id": 625, "name": "default.body" } }, { - "id": 584, + "id": 586, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -14158,28 +15106,28 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 17, + "line": 20, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 585, + "id": 587, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 586, + "id": 588, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 587, + "id": 589, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -14203,7 +15151,7 @@ } }, { - "id": 588, + "id": 590, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -14238,12 +15186,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 621, + "id": 628, "name": "default.fetch" } }, { - "id": 579, + "id": 581, "name": "headers", "kind": 1024, "kindString": "Property", @@ -14253,7 +15201,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 12, + "line": 15, "character": 12 } ], @@ -14275,12 +15223,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 616, + "id": 623, "name": "default.headers" } }, { - "id": 589, + "id": 591, "name": "isMaybeSingle", "kind": 1024, "kindString": "Property", @@ -14290,7 +15238,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 18, + "line": 21, "character": 12 } ], @@ -14300,12 +15248,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 626, + "id": 633, "name": "default.isMaybeSingle" } }, { - "id": 577, + "id": 579, "name": "method", "kind": 1024, "kindString": "Property", @@ -14315,7 +15263,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 10, + "line": 13, "character": 12 } ], @@ -14346,65 +15294,13 @@ }, "inheritedFrom": { "type": "reference", - "id": 614, + "id": 621, "name": "default.method" } }, - { - "id": 580, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 617, - "name": "default.schema" - } - }, { "id": 582, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 619, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 583, - "name": "signal", + "name": "schema", "kind": 1024, "kindString": "Property", "flags": { @@ -14418,6 +15314,58 @@ "character": 12 } ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 624, + "name": "default.schema" + } + }, + { + "id": 584, + "name": "shouldThrowOnError", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false", + "inheritedFrom": { + "type": "reference", + "id": 626, + "name": "default.shouldThrowOnError" + } + }, + { + "id": 585, + "name": "signal", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 19, + "character": 12 + } + ], "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -14426,12 +15374,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 620, + "id": 627, "name": "default.signal" } }, { - "id": 578, + "id": 580, "name": "url", "kind": 1024, "kindString": "Property", @@ -14441,7 +15389,7 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 11, + "line": 14, "character": 12 } ], @@ -14453,12 +15401,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 615, + "id": 622, "name": "default.url" } }, { - "id": 549, + "id": 551, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -14472,7 +15420,7 @@ ], "signatures": [ { - "id": 550, + "id": 552, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", @@ -14482,7 +15430,7 @@ }, "parameters": [ { - "id": 551, + "id": 553, "name": "signal", "kind": 32768, "kindString": "Parameter", @@ -14500,31 +15448,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -14534,7 +15482,7 @@ ] }, { - "id": 558, + "id": 560, "name": "csv", "kind": 2048, "kindString": "Method", @@ -14548,7 +15496,7 @@ ], "signatures": [ { - "id": 559, + "id": 561, "name": "csv", "kind": 4096, "kindString": "Call signature", @@ -14558,11 +15506,15 @@ }, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "intrinsic", "name": "string" + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -14571,7 +15523,7 @@ ] }, { - "id": 562, + "id": 564, "name": "explain", "kind": 2048, "kindString": "Method", @@ -14585,7 +15537,7 @@ ], "signatures": [ { - "id": 563, + "id": 565, "name": "explain", "kind": 4096, "kindString": "Call signature", @@ -14596,7 +15548,7 @@ }, "parameters": [ { - "id": 564, + "id": 566, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -14608,14 +15560,14 @@ "type": { "type": "reflection", "declaration": { - "id": 565, + "id": 567, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 566, + "id": 568, "name": "analyze", "kind": 1024, "kindString": "Property", @@ -14638,7 +15590,7 @@ } }, { - "id": 569, + "id": 571, "name": "buffers", "kind": 1024, "kindString": "Property", @@ -14661,7 +15613,7 @@ } }, { - "id": 571, + "id": 573, "name": "format", "kind": 1024, "kindString": "Property", @@ -14693,7 +15645,7 @@ } }, { - "id": 568, + "id": 570, "name": "settings", "kind": 1024, "kindString": "Property", @@ -14716,7 +15668,7 @@ } }, { - "id": 567, + "id": 569, "name": "verbose", "kind": 1024, "kindString": "Property", @@ -14739,7 +15691,7 @@ } }, { - "id": 570, + "id": 572, "name": "wal", "kind": 1024, "kindString": "Property", @@ -14766,7 +15718,7 @@ { "title": "Properties", "kind": 1024, - "children": [566, 569, 571, 568, 567, 570] + "children": [568, 571, 573, 570, 569, 572] } ] } @@ -14779,18 +15731,22 @@ "types": [ { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "intrinsic", "name": "string" + }, + { + "type": "literal", + "value": false } ], "name": "default" }, { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "array", @@ -14810,6 +15766,10 @@ "package": "typescript", "name": "Record" } + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -14820,7 +15780,7 @@ ] }, { - "id": 560, + "id": 562, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -14834,7 +15794,7 @@ ], "signatures": [ { - "id": 561, + "id": 563, "name": "geojson", "kind": 4096, "kindString": "Call signature", @@ -14844,7 +15804,7 @@ }, "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", @@ -14861,6 +15821,10 @@ "qualifiedName": "Record", "package": "typescript", "name": "Record" + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -14869,7 +15833,7 @@ ] }, { - "id": 534, + "id": 536, "name": "limit", "kind": 2048, "kindString": "Method", @@ -14883,7 +15847,7 @@ ], "signatures": [ { - "id": 535, + "id": 537, "name": "limit", "kind": 4096, "kindString": "Call signature", @@ -14893,7 +15857,7 @@ }, "parameters": [ { - "id": 536, + "id": 538, "name": "count", "kind": 32768, "kindString": "Parameter", @@ -14907,7 +15871,7 @@ } }, { - "id": 537, + "id": 539, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -14919,14 +15883,14 @@ "type": { "type": "reflection", "declaration": { - "id": 538, + "id": 540, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 539, + "id": 541, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -14949,7 +15913,7 @@ } }, { - "id": 540, + "id": 542, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -14976,7 +15940,7 @@ { "title": "Properties", "kind": 1024, - "children": [539, 540] + "children": [541, 542] } ] } @@ -14986,31 +15950,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -15020,7 +15984,7 @@ ] }, { - "id": 555, + "id": 557, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -15034,7 +15998,7 @@ ], "signatures": [ { - "id": 556, + "id": 558, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", @@ -15045,7 +16009,7 @@ }, "typeParameter": [ { - "id": 557, + "id": 559, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -15054,7 +16018,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, "extendsType": { @@ -15077,7 +16041,7 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "union", @@ -15088,10 +16052,14 @@ }, { "type": "reference", - "id": 437, + "id": 435, "name": "ResultOne" } ] + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -15100,7 +16068,7 @@ ] }, { - "id": 503, + "id": 505, "name": "order", "kind": 2048, "kindString": "Method", @@ -15114,7 +16082,7 @@ ], "signatures": [ { - "id": 504, + "id": 506, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -15124,37 +16092,37 @@ "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use `!inner` in the query.\n" }, "typeParameter": [ - { - "id": 505, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 506, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The column to order by" - }, - "type": { - "type": "reference", - "id": 385, - "name": "ColumnName", - "dereferenced": {} - } - }, { "id": 507, + "name": "ColumnName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "parameters": [ + { + "id": 508, + "name": "column", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The column to order by" + }, + "type": { + "type": "reference", + "id": 383, + "name": "ColumnName", + "dereferenced": {} + } + }, + { + "id": 509, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -15167,14 +16135,14 @@ "type": { "type": "reflection", "declaration": { - "id": 508, + "id": 510, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 509, + "id": 511, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -15197,7 +16165,7 @@ } }, { - "id": 510, + "id": 512, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -15220,7 +16188,7 @@ } }, { - "id": 511, + "id": 513, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -15247,7 +16215,7 @@ { "title": "Properties", "kind": 1024, - "children": [509, 510, 511] + "children": [511, 512, 513] } ] } @@ -15256,31 +16224,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -15288,7 +16256,7 @@ } }, { - "id": 512, + "id": 514, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -15299,7 +16267,7 @@ }, "parameters": [ { - "id": 513, + "id": 515, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -15313,7 +16281,7 @@ } }, { - "id": 514, + "id": 516, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -15326,14 +16294,14 @@ "type": { "type": "reflection", "declaration": { - "id": 515, + "id": 517, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 516, + "id": 518, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -15356,7 +16324,7 @@ } }, { - "id": 517, + "id": 519, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -15379,7 +16347,7 @@ } }, { - "id": 518, + "id": 520, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -15406,7 +16374,7 @@ { "title": "Properties", "kind": 1024, - "children": [516, 517, 518] + "children": [518, 519, 520] } ] } @@ -15415,31 +16383,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -15447,7 +16415,7 @@ } }, { - "id": 519, + "id": 521, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -15464,7 +16432,7 @@ }, "typeParameter": [ { - "id": 520, + "id": 522, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -15477,7 +16445,7 @@ ], "parameters": [ { - "id": 521, + "id": 523, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -15487,13 +16455,13 @@ }, "type": { "type": "reference", - "id": 400, + "id": 398, "name": "ColumnName", "dereferenced": {} } }, { - "id": 522, + "id": 524, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -15506,14 +16474,14 @@ "type": { "type": "reflection", "declaration": { - "id": 523, + "id": 525, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 524, + "id": 526, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -15533,7 +16501,7 @@ } }, { - "id": 526, + "id": 528, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -15553,7 +16521,7 @@ } }, { - "id": 525, + "id": 527, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -15577,7 +16545,7 @@ { "title": "Properties", "kind": 1024, - "children": [524, 526, 525] + "children": [526, 528, 527] } ] } @@ -15586,31 +16554,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -15618,7 +16586,7 @@ } }, { - "id": 527, + "id": 529, "name": "order", "kind": 4096, "kindString": "Call signature", @@ -15635,7 +16603,7 @@ }, "parameters": [ { - "id": 528, + "id": 530, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -15649,7 +16617,7 @@ } }, { - "id": 529, + "id": 531, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -15662,14 +16630,14 @@ "type": { "type": "reflection", "declaration": { - "id": 530, + "id": 532, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 531, + "id": 533, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -15689,7 +16657,7 @@ } }, { - "id": 533, + "id": 535, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -15709,7 +16677,7 @@ } }, { - "id": 532, + "id": 534, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -15733,7 +16701,7 @@ { "title": "Properties", "kind": 1024, - "children": [531, 533, 532] + "children": [533, 535, 534] } ] } @@ -15742,31 +16710,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -15776,7 +16744,7 @@ ] }, { - "id": 541, + "id": 543, "name": "range", "kind": 2048, "kindString": "Method", @@ -15790,17 +16758,17 @@ ], "signatures": [ { - "id": 542, + "id": 544, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limit the query result by starting at an offset (`from`) and ending at the offset (`from + 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." + "shortText": "Limit the query result by starting at an offset `from` and ending at the offset `to`.\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third\nand fourth rows of the query." }, "parameters": [ { - "id": 543, + "id": 545, "name": "from", "kind": 32768, "kindString": "Parameter", @@ -15814,7 +16782,7 @@ } }, { - "id": 544, + "id": 546, "name": "to", "kind": 32768, "kindString": "Parameter", @@ -15828,7 +16796,7 @@ } }, { - "id": 545, + "id": 547, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -15840,14 +16808,14 @@ "type": { "type": "reflection", "declaration": { - "id": 546, + "id": 548, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 547, + "id": 549, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -15870,7 +16838,7 @@ } }, { - "id": 548, + "id": 550, "name": "referencedTable", "kind": 1024, "kindString": "Property", @@ -15897,7 +16865,7 @@ { "title": "Properties", "kind": 1024, - "children": [547, 548] + "children": [549, 550] } ] } @@ -15907,31 +16875,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -15941,7 +16909,7 @@ ] }, { - "id": 574, + "id": 576, "name": "returns", "kind": 2048, "kindString": "Method", @@ -15955,7 +16923,7 @@ ], "signatures": [ { - "id": 575, + "id": 577, "name": "returns", "kind": 4096, "kindString": "Call signature", @@ -15965,7 +16933,7 @@ }, "typeParameter": [ { - "id": 576, + "id": 578, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", @@ -15977,31 +16945,31 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 456, + "id": 454, "name": "NewResult" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -16011,7 +16979,7 @@ ] }, { - "id": 572, + "id": 574, "name": "rollback", "kind": 2048, "kindString": "Method", @@ -16025,7 +16993,7 @@ ], "signatures": [ { - "id": 573, + "id": 575, "name": "rollback", "kind": 4096, "kindString": "Call signature", @@ -16036,31 +17004,31 @@ }, "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -16070,7 +17038,7 @@ ] }, { - "id": 498, + "id": 500, "name": "select", "kind": 2048, "kindString": "Method", @@ -16084,7 +17052,7 @@ ], "signatures": [ { - "id": 499, + "id": 501, "name": "select", "kind": 4096, "kindString": "Call signature", @@ -16095,7 +17063,7 @@ }, "typeParameter": [ { - "id": 500, + "id": 502, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -16110,37 +17078,38 @@ } }, { - "id": 501, + "id": 503, "name": "NewResultOne", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", + "id": 685, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" }, { "type": "reference", - "id": 380, + "id": 378, "name": "Query" } ], @@ -16150,7 +17119,7 @@ ], "parameters": [ { - "id": 502, + "id": 504, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -16162,7 +17131,7 @@ }, "type": { "type": "reference", - "id": 380, + "id": 378, "name": "Query", "dereferenced": {} } @@ -16170,34 +17139,34 @@ ], "type": { "type": "reference", - "id": 489, + "id": 491, "typeArguments": [ { "type": "reference", - "id": 492, + "id": 494, "name": "Schema" }, { "type": "reference", - "id": 493, + "id": 495, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 381, + "id": 379, "name": "NewResultOne" } }, { "type": "reference", - "id": 495, + "id": 497, "name": "RelationName" }, { "type": "reference", - "id": 496, + "id": 498, "name": "Relationships" } ], @@ -16207,7 +17176,99 @@ ] }, { - "id": 552, + "id": 594, + "name": "setHeader", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestBuilder.ts", + "line": 56, + "character": 2 + } + ], + "signatures": [ + { + "id": 595, + "name": "setHeader", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Set an HTTP header for the request." + }, + "parameters": [ + { + "id": 596, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 597, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 491, + "typeArguments": [ + { + "type": "reference", + "id": 494, + "name": "Schema" + }, + { + "type": "reference", + "id": 495, + "name": "Row" + }, + { + "type": "reference", + "id": 496, + "name": "Result" + }, + { + "type": "reference", + "id": 497, + "name": "RelationName" + }, + { + "type": "reference", + "id": 498, + "name": "Relationships" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 637, + "name": "default.setHeader" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 636, + "name": "default.setHeader" + } + }, + { + "id": 554, "name": "single", "kind": 2048, "kindString": "Method", @@ -16221,7 +17282,7 @@ ], "signatures": [ { - "id": 553, + "id": 555, "name": "single", "kind": 4096, "kindString": "Call signature", @@ -16232,7 +17293,7 @@ }, "typeParameter": [ { - "id": 554, + "id": 556, "name": "ResultOne", "kind": 131072, "kindString": "Type parameter", @@ -16241,7 +17302,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 494, + "id": 496, "name": "Result" }, "extendsType": { @@ -16264,12 +17325,16 @@ ], "type": { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 434, + "id": 432, "name": "ResultOne" + }, + { + "type": "literal", + "value": false } ], "name": "default" @@ -16278,7 +17343,7 @@ ] }, { - "id": 592, + "id": 598, "name": "then", "kind": 2048, "kindString": "Method", @@ -16286,31 +17351,31 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 50, + "line": 62, "character": 2 } ], "signatures": [ { - "id": 593, + "id": 599, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 594, + "id": 600, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 496, "name": "Result" } ], @@ -16318,7 +17383,7 @@ } }, { - "id": 595, + "id": 601, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -16331,7 +17396,7 @@ ], "parameters": [ { - "id": 596, + "id": 602, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -16348,32 +17413,32 @@ { "type": "reflection", "declaration": { - "id": 597, + "id": 603, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 598, + "id": 604, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 599, + "id": 605, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 496, "name": "Result" } ], @@ -16386,7 +17451,7 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { @@ -16394,7 +17459,7 @@ "typeArguments": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" } ], @@ -16412,7 +17477,7 @@ } }, { - "id": 600, + "id": 606, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -16429,21 +17494,21 @@ { "type": "reflection", "declaration": { - "id": 601, + "id": 607, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 602, + "id": 608, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 603, + "id": 609, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -16459,7 +17524,7 @@ "types": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" }, { @@ -16467,7 +17532,7 @@ "typeArguments": [ { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ], @@ -16493,12 +17558,12 @@ "types": [ { "type": "reference", - "id": 474, + "id": 476, "name": "TResult1" }, { "type": "reference", - "id": 475, + "id": 477, "name": "TResult2" } ] @@ -16510,19 +17575,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 630, + "id": 641, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 629, + "id": 640, "name": "default.then" } }, { - "id": 590, + "id": 592, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -16530,13 +17595,13 @@ "sources": [ { "fileName": "src/PostgrestBuilder.ts", - "line": 45, + "line": 48, "character": 2 } ], "signatures": [ { - "id": 591, + "id": 593, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -16546,47 +17611,68 @@ "text": "{@link https://github.com/supabase/supabase-js/issues/92}\n" }, "type": { - "type": "reference", - "id": 489, - "typeArguments": [ + "type": "intersection", + "types": [ { "type": "reference", - "id": 492, - "name": "Schema" + "id": 491, + "typeArguments": [ + { + "type": "reference", + "id": 494, + "name": "Schema" + }, + { + "type": "reference", + "id": 495, + "name": "Row" + }, + { + "type": "reference", + "id": 496, + "name": "Result" + }, + { + "type": "reference", + "id": 497, + "name": "RelationName" + }, + { + "type": "reference", + "id": 498, + "name": "Relationships" + } + ], + "name": "default" }, { "type": "reference", - "id": 493, - "name": "Row" - }, - { - "type": "reference", - "id": 494, - "name": "Result" - }, - { - "type": "reference", - "id": 495, - "name": "RelationName" - }, - { - "type": "reference", - "id": 496, - "name": "Relationships" + "id": 615, + "typeArguments": [ + { + "type": "reference", + "id": 496, + "name": "Result" + }, + { + "type": "literal", + "value": true + } + ], + "name": "default" } - ], - "name": "default" + ] }, "inheritedFrom": { "type": "reference", - "id": 628, + "id": 635, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 627, + "id": 634, "name": "default.throwOnError" } } @@ -16595,17 +17681,17 @@ { "title": "Constructors", "kind": 512, - "children": [490] + "children": [492] }, { "title": "Properties", "kind": 1024, - "children": [581, 584, 579, 589, 577, 580, 582, 583, 578] + "children": [583, 586, 581, 591, 579, 582, 584, 585, 580] }, { "title": "Methods", "kind": 2048, - "children": [549, 558, 562, 560, 534, 555, 503, 541, 574, 572, 498, 552, 592, 590] + "children": [551, 560, 564, 562, 536, 557, 505, 543, 576, 574, 500, 594, 554, 598, 592] } ], "sources": [ @@ -16617,7 +17703,7 @@ ], "typeParameter": [ { - "id": 604, + "id": 610, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -16628,7 +17714,7 @@ } }, { - "id": 605, + "id": 611, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -16651,14 +17737,14 @@ } }, { - "id": 606, + "id": 612, "name": "Result", "kind": 131072, "kindString": "Type parameter", "flags": {} }, { - "id": 607, + "id": 613, "name": "RelationName", "kind": 131072, "kindString": "Type parameter", @@ -16669,7 +17755,7 @@ } }, { - "id": 608, + "id": 614, "name": "Relationships", "kind": 131072, "kindString": "Type parameter", @@ -16683,11 +17769,11 @@ "extendedTypes": [ { "type": "reference", - "id": 609, + "id": 615, "typeArguments": [ { "type": "reference", - "id": 494, + "id": 496, "name": "Result" } ], @@ -16697,20 +17783,20 @@ "extendedBy": [ { "type": "reference", - "id": 143, + "id": 151, "name": "PostgrestFilterBuilder" } ] }, { - "id": 644, + "id": 668, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 647, + "id": 671, "name": "count", "kind": 1024, "kindString": "Property", @@ -16718,7 +17804,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 32, + "line": 22, "character": 2 } ], @@ -16728,7 +17814,7 @@ } }, { - "id": 646, + "id": 670, "name": "data", "kind": 1024, "kindString": "Property", @@ -16736,7 +17822,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 31, + "line": 21, "character": 2 } ], @@ -16746,7 +17832,7 @@ } }, { - "id": 645, + "id": 669, "name": "error", "kind": 1024, "kindString": "Property", @@ -16754,134 +17840,248 @@ "sources": [ { "fileName": "src/types.ts", - "line": 30, + "line": 20, "character": 2 } ], "type": { "type": "reference", - "id": 661, - "name": "PostgrestError", + "id": 654, + "name": "default", "dereferenced": { - "id": 661, + "id": 654, "name": "PostgrestError", - "kind": 4194304, - "kindString": "Type alias", + "kind": 128, + "kindString": "Class", "flags": {}, "comment": { "shortText": "Error format", "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" }, - "sources": [ + "children": [ { - "fileName": "src/types.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 662, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 655, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, - "children": [ - { - "id": 666, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 10, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 663, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 9, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [666, 664, 665, 663] - } - ], "sources": [ { - "fileName": "src/types.ts", - "line": 8, - "character": 29 + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 2 } - ] + ], + "signatures": [ + { + "id": 656, + "name": "new PostgrestError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 657, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 658, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 662, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 73 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 660, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 661, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 659, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 25 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [662, 660, 661, 659] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 654, + "name": "default" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + }, + { + "id": 665, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 9, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 663, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 7, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 664, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 8, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } - } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [655] + }, + { + "title": "Properties", + "kind": 1024, + "children": [665, 663, 664] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 6, + "character": 21 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ] } } }, { - "id": 648, + "id": 672, "name": "status", "kind": 1024, "kindString": "Property", @@ -16889,7 +18089,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 21, + "line": 11, "character": 2 } ], @@ -16903,7 +18103,7 @@ } }, { - "id": 649, + "id": 673, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -16911,7 +18111,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 22, + "line": 12, "character": 2 } ], @@ -16929,13 +18129,13 @@ { "title": "Properties", "kind": 1024, - "children": [647, 646, 645, 648, 649] + "children": [671, 670, 669, 672, 673] } ], "sources": [ { "fileName": "src/types.ts", - "line": 29, + "line": 19, "character": 17 } ], @@ -16947,14 +18147,14 @@ ] }, { - "id": 650, + "id": 674, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 653, + "id": 677, "name": "count", "kind": 1024, "kindString": "Property", @@ -16962,7 +18162,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 27, + "line": 17, "character": 2 } ], @@ -16981,7 +18181,7 @@ } }, { - "id": 652, + "id": 676, "name": "data", "kind": 1024, "kindString": "Property", @@ -16989,19 +18189,19 @@ "sources": [ { "fileName": "src/types.ts", - "line": 26, + "line": 16, "character": 2 } ], "type": { "type": "reference", - "id": 656, + "id": 680, "name": "T", "dereferenced": {} } }, { - "id": 651, + "id": 675, "name": "error", "kind": 1024, "kindString": "Property", @@ -17009,7 +18209,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 25, + "line": 15, "character": 2 } ], @@ -17019,7 +18219,7 @@ } }, { - "id": 654, + "id": 678, "name": "status", "kind": 1024, "kindString": "Property", @@ -17027,7 +18227,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 21, + "line": 11, "character": 2 } ], @@ -17041,7 +18241,7 @@ } }, { - "id": 655, + "id": 679, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -17049,7 +18249,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 22, + "line": 12, "character": 2 } ], @@ -17067,19 +18267,19 @@ { "title": "Properties", "kind": 1024, - "children": [653, 652, 651, 654, 655] + "children": [677, 676, 675, 678, 679] } ], "sources": [ { "fileName": "src/types.ts", - "line": 24, + "line": 14, "character": 17 } ], "typeParameter": [ { - "id": 656, + "id": 680, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -17094,123 +18294,7 @@ ] }, { - "id": 661, - "name": "PostgrestError", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "Error format", - "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" - }, - "sources": [ - { - "fileName": "src/types.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 662, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 666, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 10, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 663, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 9, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [666, 664, 665, 663] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 8, - "character": 29 - } - ] - } - } - }, - { - "id": 659, + "id": 683, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -17218,13 +18302,13 @@ "sources": [ { "fileName": "src/types.ts", - "line": 39, + "line": 29, "character": 12 } ], "typeParameter": [ { - "id": 660, + "id": 684, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -17233,14 +18317,14 @@ ], "type": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", - "id": 660, + "id": 684, "name": "T" }, { @@ -17254,7 +18338,7 @@ } }, { - "id": 642, + "id": 666, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", @@ -17262,13 +18346,13 @@ "sources": [ { "fileName": "src/types.ts", - "line": 40, + "line": 30, "character": 12 } ], "typeParameter": [ { - "id": 643, + "id": 667, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -17277,13 +18361,13 @@ ], "type": { "type": "reference", - "id": 657, + "id": 681, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", - "id": 643, + "id": 667, "name": "T" } } @@ -17292,7 +18376,7 @@ } }, { - "id": 657, + "id": 681, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -17300,13 +18384,13 @@ "sources": [ { "fileName": "src/types.ts", - "line": 38, + "line": 28, "character": 12 } ], "typeParameter": [ { - "id": 658, + "id": 682, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -17317,14 +18401,14 @@ "type": "union", "types": [ { - "id": 650, + "id": 674, "name": "PostgrestResponseSuccess", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 653, + "id": 677, "name": "count", "kind": 1024, "kindString": "Property", @@ -17332,7 +18416,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 27, + "line": 17, "character": 2 } ], @@ -17351,7 +18435,7 @@ } }, { - "id": 652, + "id": 676, "name": "data", "kind": 1024, "kindString": "Property", @@ -17359,19 +18443,19 @@ "sources": [ { "fileName": "src/types.ts", - "line": 26, + "line": 16, "character": 2 } ], "type": { "type": "reference", - "id": 656, + "id": 680, "name": "T", "dereferenced": {} } }, { - "id": 651, + "id": 675, "name": "error", "kind": 1024, "kindString": "Property", @@ -17379,7 +18463,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 25, + "line": 15, "character": 2 } ], @@ -17389,7 +18473,7 @@ } }, { - "id": 654, + "id": 678, "name": "status", "kind": 1024, "kindString": "Property", @@ -17397,7 +18481,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 21, + "line": 11, "character": 2 } ], @@ -17411,7 +18495,7 @@ } }, { - "id": 655, + "id": 679, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -17419,7 +18503,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 22, + "line": 12, "character": 2 } ], @@ -17437,19 +18521,19 @@ { "title": "Properties", "kind": 1024, - "children": [653, 652, 651, 654, 655] + "children": [677, 676, 675, 678, 679] } ], "sources": [ { "fileName": "src/types.ts", - "line": 24, + "line": 14, "character": 17 } ], "typeParameter": [ { - "id": 656, + "id": 680, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -17464,14 +18548,14 @@ ] }, { - "id": 644, + "id": 668, "name": "PostgrestResponseFailure", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 647, + "id": 671, "name": "count", "kind": 1024, "kindString": "Property", @@ -17479,7 +18563,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 32, + "line": 22, "character": 2 } ], @@ -17489,7 +18573,7 @@ } }, { - "id": 646, + "id": 670, "name": "data", "kind": 1024, "kindString": "Property", @@ -17497,7 +18581,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 31, + "line": 21, "character": 2 } ], @@ -17507,7 +18591,7 @@ } }, { - "id": 645, + "id": 669, "name": "error", "kind": 1024, "kindString": "Property", @@ -17515,134 +18599,248 @@ "sources": [ { "fileName": "src/types.ts", - "line": 30, + "line": 20, "character": 2 } ], "type": { "type": "reference", - "id": 661, - "name": "PostgrestError", + "id": 654, + "name": "default", "dereferenced": { - "id": 661, + "id": 654, "name": "PostgrestError", - "kind": 4194304, - "kindString": "Type alias", + "kind": 128, + "kindString": "Class", "flags": {}, "comment": { "shortText": "Error format", "text": "{@link https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes}\n" }, - "sources": [ + "children": [ { - "fileName": "src/types.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 662, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "id": 655, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", "flags": {}, - "children": [ - { - "id": 666, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 10, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 663, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 9, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [666, 664, 665, 663] - } - ], "sources": [ { - "fileName": "src/types.ts", - "line": 8, - "character": 29 + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 2 } - ] + ], + "signatures": [ + { + "id": 656, + "name": "new PostgrestError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 657, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 658, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 662, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 73 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 660, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 661, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 59 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 659, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 11, + "character": 25 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [662, 660, 661, 659] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 654, + "name": "default" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + }, + { + "id": 665, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 9, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 663, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 7, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 664, + "name": "hint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 8, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } - } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [655] + }, + { + "title": "Properties", + "kind": 1024, + "children": [665, 663, 664] + } + ], + "sources": [ + { + "fileName": "src/PostgrestError.ts", + "line": 6, + "character": 21 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ] } } }, { - "id": 648, + "id": 672, "name": "status", "kind": 1024, "kindString": "Property", @@ -17650,7 +18848,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 21, + "line": 11, "character": 2 } ], @@ -17664,7 +18862,7 @@ } }, { - "id": 649, + "id": 673, "name": "statusText", "kind": 1024, "kindString": "Property", @@ -17672,7 +18870,7 @@ "sources": [ { "fileName": "src/types.ts", - "line": 22, + "line": 12, "character": 2 } ], @@ -17690,13 +18888,13 @@ { "title": "Properties", "kind": 1024, - "children": [647, 646, 645, 648, 649] + "children": [671, 670, 669, 672, 673] } ], "sources": [ { "fileName": "src/types.ts", - "line": 29, + "line": 19, "character": 17 } ], @@ -17709,29 +18907,540 @@ } ] } + }, + { + "id": 685, + "name": "UnstableGetResult", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "Main entry point for constructing the result type of a PostgREST query." + }, + "sources": [ + { + "fileName": "src/select-query-parser/result.ts", + "line": 33, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 686, + "name": "Schema", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Database schema." + }, + "type": { + "type": "reference", + "name": "GenericSchema" + } + }, + { + "id": 687, + "name": "Row", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The type of a row in the current table." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 688, + "name": "RelationName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The name of the current table or view." + } + }, + { + "id": 689, + "name": "Relationships", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "Relationships of the current table." + } + }, + { + "id": 690, + "name": "Query", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "comment": { + "shortText": "The select query string literal to parse.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 686, + "name": "Schema" + } + ], + "name": "IsAny" + }, + "extendsType": { + "type": "literal", + "value": true + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 690, + "name": "Query" + } + ], + "name": "ParseQuery" + }, + "extendsType": { + "type": "inferred", + "name": "ParsedQuery" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "ParsedQuery" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Ast.Node" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ParsedQuery" + } + ], + "name": "ProcessNodesWithoutSchema" + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "reference", + "name": "ParsedQuery" + } + }, + "falseType": { + "type": "intrinsic", + "name": "any" + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 689, + "name": "Relationships" + }, + "extendsType": { + "type": "literal", + "value": null + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 690, + "name": "Query" + } + ], + "name": "ParseQuery" + }, + "extendsType": { + "type": "inferred", + "name": "ParsedQuery" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "ParsedQuery" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Ast.Node" + } + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ParsedQuery" + }, + { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + "falseType": { + "type": "literal", + "value": "rpc_call" + } + }, + { + "type": "reference", + "id": 687, + "name": "Row" + } + ], + "name": "RPCCallNodes" + }, + "falseType": { + "type": "reference", + "name": "ParsedQuery" + } + }, + "falseType": { + "type": "reference", + "id": 687, + "name": "Row" + } + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 690, + "name": "Query" + } + ], + "name": "ParseQuery" + }, + "extendsType": { + "type": "inferred", + "name": "ParsedQuery" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "name": "ParsedQuery" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Ast.Node" + } + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "id": 689, + "name": "Relationships" + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "reference", + "name": "GenericRelationship" + } + }, + "trueType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 686, + "name": "Schema" + }, + { + "type": "reference", + "id": 687, + "name": "Row" + }, + { + "type": "reference", + "id": 688, + "name": "RelationName" + }, + { + "type": "reference", + "id": 689, + "name": "Relationships" + }, + { + "type": "reference", + "name": "ParsedQuery" + } + ], + "name": "ProcessNodes" + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "Invalid Relationships cannot infer result type" + } + ], + "name": "SelectQueryError" + } + }, + "falseType": { + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "Invalid RelationName cannot infer result type" + } + ], + "name": "SelectQueryError" + } + }, + "falseType": { + "type": "reference", + "name": "ParsedQuery" + } + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + } + }, + { + "id": 1, + "name": "default", + "kind": 32, + "kindString": "Variable", + "flags": {}, + "sources": [ + { + "fileName": "src/index.ts", + "line": 17, + "character": 0 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 2, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 7, + "name": "PostgrestBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 615, + "name": "default" + } + } + }, + { + "id": 3, + "name": "PostgrestClient", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 9, + "name": "default" + } + } + }, + { + "id": 8, + "name": "PostgrestError", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 654, + "name": "default" + } + } + }, + { + "id": 5, + "name": "PostgrestFilterBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 151, + "name": "default" + } + } + }, + { + "id": 4, + "name": "PostgrestQueryBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 64, + "name": "default" + } + } + }, + { + "id": 6, + "name": "PostgrestTransformBuilder", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "type": { + "type": "query", + "queryType": { + "type": "reference", + "id": 491, + "name": "default" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [7, 3, 8, 5, 4, 6] + } + ] + } + } } ], "groups": [ { "title": "Classes", "kind": 128, - "children": [609, 1, 143, 56, 489] + "children": [615, 9, 654, 151, 64, 491] }, { "title": "Interfaces", "kind": 256, - "children": [644, 650] + "children": [668, 674] }, { "title": "Type Aliases", "kind": 4194304, - "children": [661, 659, 642, 657] + "children": [683, 666, 681, 685] + }, + { + "title": "Variables", + "kind": 32, + "children": [1] } ], "sources": [ { "fileName": "src/index.ts", - "line": 1, + "line": 2, "character": 0 } ] diff --git a/apps/docs/spec/enrichments/tsdoc_v2/realtime.json b/apps/docs/spec/enrichments/tsdoc_v2/realtime.json index 706bbbf7536..08613f9142d 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/realtime.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/realtime.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 588, + "id": 614, "name": "REALTIME_LISTEN_TYPES", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 589, + "id": 615, "name": "BROADCAST", "kind": 16, "kindString": "Enumeration Member", @@ -22,7 +22,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 93, + "line": 98, "character": 2 } ], @@ -33,18 +33,15 @@ "defaultValue": "\"broadcast\"" }, { - "id": 591, + "id": 617, "name": "POSTGRES_CHANGES", "kind": 16, "kindString": "Enumeration Member", "flags": {}, - "comment": { - "shortText": "listen to Postgres changes." - }, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 98, + "line": 100, "character": 2 } ], @@ -55,11 +52,91 @@ "defaultValue": "\"postgres_changes\"" }, { - "id": 590, + "id": 616, "name": "PRESENCE", "kind": 16, "kindString": "Enumeration Member", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 99, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "presence" + }, + "defaultValue": "\"presence\"" + }, + { + "id": 618, + "name": "SYSTEM", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 101, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "system" + }, + "defaultValue": "\"system\"" + } + ], + "groups": [ + { + "title": "Enumeration Members", + "kind": 16, + "children": [615, 617, 616, 618] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 97, + "character": 12 + } + ] + }, + { + "id": 619, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 620, + "name": "ALL", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 91, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "*" + }, + "defaultValue": "\"*\"" + }, + { + "id": 623, + "name": "DELETE", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -67,67 +144,6 @@ "character": 2 } ], - "type": { - "type": "literal", - "value": "presence" - }, - "defaultValue": "\"presence\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [589, 591, 590] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 92, - "character": 12 - } - ] - }, - { - "id": 592, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 593, - "name": "ALL", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "*" - }, - "defaultValue": "\"*\"" - }, - { - "id": 596, - "name": "DELETE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 89, - "character": 2 - } - ], "type": { "type": "literal", "value": "DELETE" @@ -135,7 +151,7 @@ "defaultValue": "\"DELETE\"" }, { - "id": 594, + "id": 621, "name": "INSERT", "kind": 16, "kindString": "Enumeration Member", @@ -143,7 +159,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 87, + "line": 92, "character": 2 } ], @@ -154,7 +170,7 @@ "defaultValue": "\"INSERT\"" }, { - "id": 595, + "id": 622, "name": "UPDATE", "kind": 16, "kindString": "Enumeration Member", @@ -162,7 +178,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 88, + "line": 93, "character": 2 } ], @@ -177,26 +193,26 @@ { "title": "Enumeration Members", "kind": 16, - "children": [593, 596, 594, 595] + "children": [620, 623, 621, 622] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 85, + "line": 90, "character": 12 } ] }, { - "id": 597, + "id": 624, "name": "REALTIME_PRESENCE_LISTEN_EVENTS", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 599, + "id": 626, "name": "JOIN", "kind": 16, "kindString": "Enumeration Member", @@ -215,7 +231,7 @@ "defaultValue": "\"join\"" }, { - "id": 600, + "id": 627, "name": "LEAVE", "kind": 16, "kindString": "Enumeration Member", @@ -234,7 +250,7 @@ "defaultValue": "\"leave\"" }, { - "id": 598, + "id": 625, "name": "SYNC", "kind": 16, "kindString": "Enumeration Member", @@ -257,7 +273,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [599, 600, 598] + "children": [626, 627, 625] } ], "sources": [ @@ -269,18 +285,56 @@ ] }, { - "id": 601, + "id": 628, "name": "REALTIME_SUBSCRIBE_STATES", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 605, + "id": 632, "name": "CHANNEL_ERROR", "kind": 16, "kindString": "Enumeration Member", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 108, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "CHANNEL_ERROR" + }, + "defaultValue": "\"CHANNEL_ERROR\"" + }, + { + "id": 631, + "name": "CLOSED", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 107, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "CLOSED" + }, + "defaultValue": "\"CLOSED\"" + }, + { + "id": 629, + "name": "SUBSCRIBED", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -288,44 +342,6 @@ "character": 2 } ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - }, - "defaultValue": "\"CHANNEL_ERROR\"" - }, - { - "id": 604, - "name": "CLOSED", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 104, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - }, - "defaultValue": "\"CLOSED\"" - }, - { - "id": 602, - "name": "SUBSCRIBED", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 102, - "character": 2 - } - ], "type": { "type": "literal", "value": "SUBSCRIBED" @@ -333,7 +349,7 @@ "defaultValue": "\"SUBSCRIBED\"" }, { - "id": 603, + "id": 630, "name": "TIMED_OUT", "kind": 16, "kindString": "Enumeration Member", @@ -341,7 +357,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 103, + "line": 106, "character": 2 } ], @@ -356,13 +372,13 @@ { "title": "Enumeration Members", "kind": 16, - "children": [605, 604, 602, 603] + "children": [632, 631, 629, 630] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 101, + "line": 104, "character": 12 } ] @@ -386,7 +402,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 134, + "line": 147, "character": 2 } ], @@ -417,7 +433,7 @@ "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions" }, "defaultValue": "..." @@ -430,7 +446,7 @@ "flags": {}, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } @@ -452,7 +468,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 116, + "line": 128, "character": 2 } ], @@ -502,7 +518,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 120, + "line": 132, "character": 6 } ], @@ -522,7 +538,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 6 } ], @@ -537,7 +553,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 14 } ], @@ -578,7 +594,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 121, + "line": 133, "character": 6 } ], @@ -596,7 +612,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 118, + "line": 130, "character": 6 } ], @@ -616,7 +632,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 117, + "line": 129, "character": 19 } ] @@ -637,7 +653,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 143, "character": 2 } ], @@ -655,7 +671,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 127, + "line": 139, "character": 2 } ], @@ -673,7 +689,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 126, + "line": 138, "character": 2 } ], @@ -684,7 +700,7 @@ "defaultValue": "false" }, { - "id": 102, + "id": 103, "name": "params", "kind": 1024, "kindString": "Property", @@ -693,7 +709,7 @@ }, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions" }, "defaultValue": "..." @@ -707,7 +723,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 130, + "line": 142, "character": 2 } ], @@ -717,6 +733,24 @@ "name": "default" } }, + { + "id": 101, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 97, "name": "pushBuffer", @@ -726,7 +760,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 141, "character": 2 } ], @@ -748,7 +782,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 140, "character": 2 } ], @@ -758,7 +792,7 @@ } }, { - "id": 103, + "id": 104, "name": "socket", "kind": 1024, "kindString": "Property", @@ -767,7 +801,7 @@ }, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } }, @@ -780,7 +814,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 125, + "line": 137, "character": 2 } ], @@ -799,7 +833,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 132, + "line": 144, "character": 2 } ], @@ -817,7 +851,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 124, + "line": 136, "character": 2 } ], @@ -827,7 +861,7 @@ } }, { - "id": 101, + "id": 102, "name": "topic", "kind": 1024, "kindString": "Property", @@ -840,108 +874,7 @@ } }, { - "id": 269, - "name": "_fetchWithTimeout", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 538, - "character": 8 - } - ], - "signatures": [ - { - "id": 270, - "name": "_fetchWithTimeout", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 271, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 272, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 273, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 274, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 275, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 276, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 135, + "id": 136, "name": "on", "kind": 2048, "kindString": "Method", @@ -955,7 +888,7 @@ ], "signatures": [ { - "id": 136, + "id": 137, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -965,7 +898,7 @@ }, "parameters": [ { - "id": 137, + "id": 138, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -976,7 +909,7 @@ } }, { - "id": 138, + "id": 139, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -984,14 +917,14 @@ "type": { "type": "reflection", "declaration": { - "id": 139, + "id": 140, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 140, + "id": 141, "name": "event", "kind": 1024, "kindString": "Property", @@ -1013,14 +946,14 @@ { "title": "Properties", "kind": 1024, - "children": [140] + "children": [141] } ] } } }, { - "id": 141, + "id": 142, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -1028,14 +961,14 @@ "type": { "type": "reflection", "declaration": { - "id": 142, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 143, + "id": 144, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -1057,14 +990,14 @@ } }, { - "id": 144, + "id": 145, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 148, + "id": 149, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -1072,20 +1005,20 @@ "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 146, + "id": 147, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 147, + "id": 148, "name": "key", "kind": 32768, "flags": {}, @@ -1106,7 +1039,7 @@ ], "parameters": [ { - "id": 149, + "id": 150, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -1117,7 +1050,7 @@ } }, { - "id": 150, + "id": 151, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -1125,14 +1058,14 @@ "type": { "type": "reflection", "declaration": { - "id": 151, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 153, "name": "event", "kind": 1024, "kindString": "Property", @@ -1154,14 +1087,14 @@ { "title": "Properties", "kind": 1024, - "children": [152] + "children": [153] } ] } } }, { - "id": 153, + "id": 154, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -1169,32 +1102,32 @@ "type": { "type": "reflection", "declaration": { - "id": 154, + "id": 155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 155, + "id": 156, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 156, + "id": 157, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 558, + "id": 584, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 149, "name": "T" } ], @@ -1219,14 +1152,14 @@ } }, { - "id": 157, + "id": 158, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 161, + "id": 162, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -1234,20 +1167,20 @@ "type": { "type": "reflection", "declaration": { - "id": 158, + "id": 159, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 159, + "id": 160, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 160, + "id": 161, "name": "key", "kind": 32768, "flags": {}, @@ -1268,7 +1201,7 @@ ], "parameters": [ { - "id": 162, + "id": 163, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -1279,7 +1212,7 @@ } }, { - "id": 163, + "id": 164, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -1287,14 +1220,14 @@ "type": { "type": "reflection", "declaration": { - "id": 164, + "id": 165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 165, + "id": 166, "name": "event", "kind": 1024, "kindString": "Property", @@ -1316,14 +1249,14 @@ { "title": "Properties", "kind": 1024, - "children": [165] + "children": [166] } ] } } }, { - "id": 166, + "id": 167, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -1331,32 +1264,32 @@ "type": { "type": "reflection", "declaration": { - "id": 167, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 168, + "id": 169, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 169, + "id": 170, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 568, + "id": 594, "typeArguments": [ { "type": "reference", - "id": 161, + "id": 162, "name": "T" } ], @@ -1381,14 +1314,14 @@ } }, { - "id": 170, + "id": 171, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 174, + "id": 175, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -1396,20 +1329,20 @@ "type": { "type": "reflection", "declaration": { - "id": 171, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 172, + "id": 173, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 173, + "id": 174, "name": "key", "kind": 32768, "flags": {}, @@ -1430,7 +1363,7 @@ ], "parameters": [ { - "id": 175, + "id": 176, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -1441,14 +1374,14 @@ } }, { - "id": 176, + "id": 177, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -1459,7 +1392,7 @@ } }, { - "id": 177, + "id": 178, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -1467,32 +1400,32 @@ "type": { "type": "reflection", "declaration": { - "id": 178, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 179, + "id": 180, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 180, + "id": 181, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 524, + "id": 550, "typeArguments": [ { "type": "reference", - "id": 174, + "id": 175, "name": "T" } ], @@ -1517,14 +1450,14 @@ } }, { - "id": 181, + "id": 182, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 185, + "id": 186, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -1532,20 +1465,20 @@ "type": { "type": "reflection", "declaration": { - "id": 182, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 183, + "id": 184, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 184, + "id": 185, "name": "key", "kind": 32768, "flags": {}, @@ -1566,7 +1499,7 @@ ], "parameters": [ { - "id": 186, + "id": 187, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -1577,14 +1510,14 @@ } }, { - "id": 187, + "id": 188, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -1595,7 +1528,7 @@ } }, { - "id": 188, + "id": 189, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -1603,32 +1536,32 @@ "type": { "type": "reflection", "declaration": { - "id": 189, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 190, + "id": 191, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 191, + "id": 192, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 529, + "id": 555, "typeArguments": [ { "type": "reference", - "id": 185, + "id": 186, "name": "T" } ], @@ -1653,14 +1586,14 @@ } }, { - "id": 192, + "id": 193, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 196, + "id": 197, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -1668,20 +1601,20 @@ "type": { "type": "reflection", "declaration": { - "id": 193, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 194, + "id": 195, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 196, "name": "key", "kind": 32768, "flags": {}, @@ -1702,7 +1635,7 @@ ], "parameters": [ { - "id": 197, + "id": 198, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -1713,14 +1646,14 @@ } }, { - "id": 198, + "id": 199, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -1731,7 +1664,7 @@ } }, { - "id": 199, + "id": 200, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -1739,32 +1672,32 @@ "type": { "type": "reflection", "declaration": { - "id": 200, + "id": 201, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 201, + "id": 202, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 202, + "id": 203, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 539, + "id": 565, "typeArguments": [ { "type": "reference", - "id": 196, + "id": 197, "name": "T" } ], @@ -1789,14 +1722,14 @@ } }, { - "id": 203, + "id": 204, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 207, + "id": 208, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -1804,20 +1737,20 @@ "type": { "type": "reflection", "declaration": { - "id": 204, + "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 205, + "id": 206, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 206, + "id": 207, "name": "key", "kind": 32768, "flags": {}, @@ -1838,7 +1771,7 @@ ], "parameters": [ { - "id": 208, + "id": 209, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -1849,14 +1782,14 @@ } }, { - "id": 209, + "id": 210, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -1867,7 +1800,7 @@ } }, { - "id": 210, + "id": 211, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -1875,32 +1808,32 @@ "type": { "type": "reflection", "declaration": { - "id": 211, + "id": 212, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 212, + "id": 213, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 213, + "id": 214, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 548, + "id": 574, "typeArguments": [ { "type": "reference", - "id": 207, + "id": 208, "name": "T" } ], @@ -1925,7 +1858,7 @@ } }, { - "id": 214, + "id": 215, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -1935,7 +1868,7 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -1949,7 +1882,7 @@ } }, { - "id": 216, + "id": 217, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -1960,14 +1893,14 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 218, + "id": 219, "name": "event", "kind": 1024, "kindString": "Property", @@ -1989,14 +1922,14 @@ { "title": "Properties", "kind": 1024, - "children": [218] + "children": [219] } ] } } }, { - "id": 219, + "id": 220, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -2007,21 +1940,21 @@ "type": { "type": "reflection", "declaration": { - "id": 220, + "id": 221, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 221, + "id": 222, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 222, + "id": 223, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -2029,14 +1962,14 @@ "type": { "type": "reflection", "declaration": { - "id": 223, + "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 226, "name": "event", "kind": 1024, "kindString": "Property", @@ -2054,7 +1987,7 @@ } }, { - "id": 224, + "id": 225, "name": "type", "kind": 1024, "kindString": "Property", @@ -2076,18 +2009,18 @@ { "title": "Properties", "kind": 1024, - "children": [225, 224] + "children": [226, 225] } ], "indexSignature": { - "id": 226, + "id": 227, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 227, + "id": 228, "name": "key", "kind": 32768, "flags": {}, @@ -2123,14 +2056,14 @@ } }, { - "id": 228, + "id": 229, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 232, + "id": 233, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -2138,20 +2071,20 @@ "type": { "type": "reflection", "declaration": { - "id": 229, + "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 230, + "id": 231, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 231, + "id": 232, "name": "key", "kind": 32768, "flags": {}, @@ -2172,7 +2105,7 @@ ], "parameters": [ { - "id": 233, + "id": 234, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -2183,7 +2116,7 @@ } }, { - "id": 234, + "id": 235, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -2191,14 +2124,14 @@ "type": { "type": "reflection", "declaration": { - "id": 235, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 236, + "id": 237, "name": "event", "kind": 1024, "kindString": "Property", @@ -2220,14 +2153,14 @@ { "title": "Properties", "kind": 1024, - "children": [236] + "children": [237] } ] } } }, { - "id": 237, + "id": 238, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -2235,21 +2168,21 @@ "type": { "type": "reflection", "declaration": { - "id": 238, + "id": 239, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 239, + "id": 240, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 240, + "id": 241, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -2257,14 +2190,14 @@ "type": { "type": "reflection", "declaration": { - "id": 241, + "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 243, + "id": 244, "name": "event", "kind": 1024, "kindString": "Property", @@ -2282,7 +2215,7 @@ } }, { - "id": 244, + "id": 245, "name": "payload", "kind": 1024, "kindString": "Property", @@ -2296,12 +2229,12 @@ ], "type": { "type": "reference", - "id": 232, + "id": 233, "name": "T" } }, { - "id": 242, + "id": 243, "name": "type", "kind": 1024, "kindString": "Property", @@ -2323,7 +2256,7 @@ { "title": "Properties", "kind": 1024, - "children": [243, 244, 242] + "children": [244, 245, 243] } ] } @@ -2345,11 +2278,138 @@ "id": 64, "name": "default" } + }, + { + "id": 246, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 250, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 247, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 248, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 249, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 251, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "system" + } + }, + { + "id": 252, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 253, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 254, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 255, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 256, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 257, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } } ] }, { - "id": 112, + "id": 113, "name": "presenceState", "kind": 2048, "kindString": "Method", @@ -2363,14 +2423,14 @@ ], "signatures": [ { - "id": 113, + "id": 114, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 118, + "id": 119, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -2378,20 +2438,20 @@ "type": { "type": "reflection", "declaration": { - "id": 114, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 115, + "id": 116, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 116, + "id": 117, "name": "key", "kind": 32768, "flags": {}, @@ -2411,7 +2471,7 @@ "default": { "type": "reflection", "declaration": { - "id": 117, + "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2422,11 +2482,11 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reference", - "id": 118, + "id": 119, "name": "T" } ], @@ -2436,7 +2496,7 @@ ] }, { - "id": 245, + "id": 258, "name": "send", "kind": 2048, "kindString": "Method", @@ -2444,13 +2504,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 425, + "line": 430, "character": 8 } ], "signatures": [ { - "id": 246, + "id": 259, "name": "send", "kind": 4096, "kindString": "Call signature", @@ -2460,7 +2520,7 @@ }, "parameters": [ { - "id": 247, + "id": 260, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -2471,14 +2531,14 @@ "type": { "type": "reflection", "declaration": { - "id": 248, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 263, "name": "event", "kind": 1024, "kindString": "Property", @@ -2489,7 +2549,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 428, + "line": 433, "character": 6 } ], @@ -2499,7 +2559,7 @@ } }, { - "id": 251, + "id": 264, "name": "payload", "kind": 1024, "kindString": "Property", @@ -2512,7 +2572,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 429, + "line": 434, "character": 6 } ], @@ -2522,7 +2582,7 @@ } }, { - "id": 249, + "id": 262, "name": "type", "kind": 1024, "kindString": "Property", @@ -2533,7 +2593,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 427, + "line": 432, "character": 6 } ], @@ -2560,18 +2620,18 @@ { "title": "Properties", "kind": 1024, - "children": [250, 251, 249] + "children": [263, 264, 262] } ], "indexSignature": { - "id": 252, + "id": 265, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 253, + "id": 266, "name": "key", "kind": 32768, "flags": {}, @@ -2590,7 +2650,7 @@ } }, { - "id": 254, + "id": 267, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -2601,20 +2661,20 @@ "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 256, + "id": 269, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 257, + "id": 270, "name": "key", "kind": 32768, "flags": {}, @@ -2639,7 +2699,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -2651,7 +2711,7 @@ ] }, { - "id": 104, + "id": 105, "name": "subscribe", "kind": 2048, "kindString": "Method", @@ -2659,13 +2719,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 198, + "line": 213, "character": 2 } ], "signatures": [ { - "id": 105, + "id": 106, "name": "subscribe", "kind": 4096, "kindString": "Call signature", @@ -2675,7 +2735,7 @@ }, "parameters": [ { - "id": 106, + "id": 107, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -2685,49 +2745,33 @@ "type": { "type": "reflection", "declaration": { - "id": 107, + "id": 108, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 108, + "id": 109, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 109, + "id": 110, "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" - } - ] + "type": "reference", + "id": 628, + "name": "REALTIME_SUBSCRIBE_STATES" } }, { - "id": 110, + "id": 111, "name": "err", "kind": 32768, "kindString": "Parameter", @@ -2752,7 +2796,7 @@ } }, { - "id": 111, + "id": 112, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -2773,7 +2817,7 @@ ] }, { - "id": 119, + "id": 120, "name": "track", "kind": 2048, "kindString": "Method", @@ -2787,14 +2831,14 @@ ], "signatures": [ { - "id": 120, + "id": 121, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 121, + "id": 122, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -2802,20 +2846,20 @@ "type": { "type": "reflection", "declaration": { - "id": 122, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 123, + "id": 124, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 124, + "id": 125, "name": "key", "kind": 32768, "flags": {}, @@ -2834,7 +2878,7 @@ } }, { - "id": 125, + "id": 126, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -2842,20 +2886,20 @@ "type": { "type": "reflection", "declaration": { - "id": 126, + "id": 127, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 127, + "id": 128, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 128, + "id": 129, "name": "key", "kind": 32768, "flags": {}, @@ -2880,7 +2924,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -2892,7 +2936,7 @@ ] }, { - "id": 264, + "id": 277, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -2900,13 +2944,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 495, + "line": 507, "character": 2 } ], "signatures": [ { - "id": 265, + "id": 278, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -2917,7 +2961,7 @@ }, "parameters": [ { - "id": 266, + "id": 279, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -2958,7 +3002,7 @@ ] }, { - "id": 129, + "id": 130, "name": "untrack", "kind": 2048, "kindString": "Method", @@ -2972,14 +3016,14 @@ ], "signatures": [ { - "id": 130, + "id": 131, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 131, + "id": 132, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -2987,20 +3031,20 @@ "type": { "type": "reflection", "declaration": { - "id": 132, + "id": 133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 133, + "id": 134, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 134, + "id": 135, "name": "key", "kind": 32768, "flags": {}, @@ -3025,7 +3069,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -3037,7 +3081,7 @@ ] }, { - "id": 258, + "id": 271, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", @@ -3045,20 +3089,20 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 482, + "line": 494, "character": 2 } ], "signatures": [ { - "id": 259, + "id": 272, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 260, + "id": 273, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -3066,20 +3110,20 @@ "type": { "type": "reflection", "declaration": { - "id": 261, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 262, + "id": 275, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 263, + "id": 276, "name": "key", "kind": 32768, "flags": {}, @@ -3115,31 +3159,31 @@ { "title": "Properties", "kind": 1024, - "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] + "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] }, { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -3147,13 +3191,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -3163,7 +3207,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -3177,7 +3221,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -3186,21 +3230,21 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions" } } ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -3208,7 +3252,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -3228,7 +3336,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -3236,7 +3344,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -3256,7 +3364,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -3264,7 +3372,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -3279,7 +3387,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -3287,7 +3395,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -3307,7 +3415,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -3315,7 +3423,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -3327,7 +3435,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -3335,7 +3443,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -3347,7 +3455,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -3355,7 +3463,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -3366,7 +3474,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -3374,28 +3482,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -3419,7 +3527,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -3450,14 +3558,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -3485,7 +3593,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -3520,7 +3628,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -3530,27 +3638,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -3570,7 +3678,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -3578,7 +3686,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -3589,7 +3697,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -3597,7 +3705,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -3619,7 +3727,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -3627,7 +3754,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -3640,7 +3767,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -3650,27 +3777,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -3690,7 +3817,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -3698,7 +3825,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -3718,7 +3845,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -3726,7 +3853,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -3738,7 +3865,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -3746,7 +3873,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -3756,7 +3883,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -3764,7 +3891,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -3775,7 +3902,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -3783,7 +3910,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -3799,7 +3926,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -3807,7 +3934,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -3818,7 +3945,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -3826,21 +3953,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -3848,7 +3975,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -3863,7 +3990,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -3871,7 +3998,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -3886,7 +4013,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -3894,7 +4021,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -3909,7 +4036,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -3917,7 +4044,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -3936,7 +4063,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -3944,7 +4071,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -3952,7 +4079,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -3963,7 +4090,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -3971,7 +4098,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -3990,7 +4117,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -3998,20 +4238,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -4022,14 +4262,14 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions" }, "defaultValue": "..." @@ -4044,7 +4284,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -4052,13 +4292,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -4074,7 +4314,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -4082,13 +4322,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -4104,7 +4344,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -4112,13 +4352,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -4128,7 +4368,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -4144,7 +4384,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -4168,7 +4408,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -4176,13 +4477,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -4202,7 +4503,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -4210,13 +4511,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -4232,7 +4533,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -4240,13 +4541,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -4257,7 +4558,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -4268,7 +4569,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -4279,7 +4580,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -4300,7 +4601,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -4308,13 +4609,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -4325,14 +4626,14 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage" } } @@ -4345,7 +4646,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -4353,13 +4654,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -4374,7 +4675,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -4387,7 +4688,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -4395,13 +4696,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -4411,7 +4712,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -4431,7 +4732,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -4443,7 +4744,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -4451,29 +4790,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -4487,12 +4827,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -4502,26 +4851,26 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, 381, - 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, 385, 393, 399, + 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, - "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] + "children": [510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, 454] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -4784,7 +5133,7 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reflection", @@ -4823,7 +5172,7 @@ ] }, { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -4831,21 +5180,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -4853,21 +5202,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -4880,21 +5229,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -4904,7 +5253,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -4914,7 +5263,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -4924,7 +5273,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -4938,13 +5287,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -4952,7 +5301,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -4965,21 +5314,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -4989,7 +5338,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -5003,31 +5352,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -5039,13 +5411,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -5053,7 +5425,7 @@ } }, { - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse", "kind": 4194304, "kindString": "Type alias", @@ -5061,7 +5433,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 83, + "line": 88, "character": 12 } ], @@ -5084,7 +5456,7 @@ } }, { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -5092,21 +5464,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -5116,7 +5488,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -5128,7 +5500,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -5138,7 +5510,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -5150,7 +5522,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -5160,7 +5532,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -5170,7 +5542,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -5180,14 +5552,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5195,19 +5567,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -5226,7 +5598,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -5236,7 +5608,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -5246,7 +5618,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -5256,7 +5628,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -5283,7 +5655,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -5293,7 +5665,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -5305,7 +5677,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -5315,14 +5687,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5330,19 +5702,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -5361,7 +5733,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -5371,7 +5743,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -5383,7 +5755,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -5393,7 +5765,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -5403,7 +5775,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -5413,7 +5785,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -5421,57 +5793,39 @@ "type": "reference", "name": "WebSocketLikeConstructor" } - } - ], - "groups": [ + }, { - "title": "Properties", - "kind": 1024, - "children": [498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 20, - "character": 36 - } - ] - } - } - }, - { - "id": 510, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 511, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 513, - "name": "event", + "id": 532, + "name": "worker", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, "character": 2 } ], @@ -5481,7 +5835,116 @@ } }, { - "id": 516, + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, 532, 533] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 29, + "character": 36 + } + ] + } + } + }, + { + "id": 536, + "name": "RealtimeMessage", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 46, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 537, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 539, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -5491,7 +5954,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -5501,7 +5964,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -5509,7 +5972,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -5519,7 +5982,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -5527,7 +5990,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -5537,7 +6000,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -5545,7 +6008,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -5559,13 +6022,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -5573,7 +6036,7 @@ } }, { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -5581,13 +6044,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -5599,7 +6062,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -5611,14 +6074,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -5629,18 +6092,18 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T" } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -5653,7 +6116,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -5663,7 +6126,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -5674,7 +6137,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -5684,7 +6147,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -5697,7 +6160,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -5711,13 +6174,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -5725,7 +6188,7 @@ } }, { - "id": 524, + "id": 550, "name": "RealtimePostgresChangesPayload", "kind": 4194304, "kindString": "Type alias", @@ -5733,13 +6196,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 57, + "line": 62, "character": 12 } ], "typeParameter": [ { - "id": 528, + "id": 554, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -5747,7 +6210,7 @@ "type": { "type": "reflection", "declaration": { - "id": 525, + "id": 551, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5755,19 +6218,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 57, + "line": 62, "character": 53 } ], "indexSignature": { - "id": 526, + "id": 552, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 527, + "id": 553, "name": "key", "kind": 32768, "flags": {}, @@ -5791,11 +6254,11 @@ "types": [ { "type": "reference", - "id": 529, + "id": 555, "typeArguments": [ { "type": "reference", - "id": 528, + "id": 554, "name": "T" } ], @@ -5803,11 +6266,11 @@ }, { "type": "reference", - "id": 539, + "id": 565, "typeArguments": [ { "type": "reference", - "id": 528, + "id": 554, "name": "T" } ], @@ -5815,11 +6278,11 @@ }, { "type": "reference", - "id": 548, + "id": 574, "typeArguments": [ { "type": "reference", - "id": 528, + "id": 554, "name": "T" } ], @@ -5829,7 +6292,7 @@ } }, { - "id": 548, + "id": 574, "name": "RealtimePostgresDeletePayload", "kind": 4194304, "kindString": "Type alias", @@ -5837,13 +6300,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 55, "character": 12 } ], "typeParameter": [ { - "id": 557, + "id": 583, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -5851,7 +6314,7 @@ "type": { "type": "reflection", "declaration": { - "id": 554, + "id": 580, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5859,19 +6322,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 55, "character": 52 } ], "indexSignature": { - "id": 555, + "id": 581, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 556, + "id": 582, "name": "key", "kind": 32768, "flags": {}, @@ -5900,14 +6363,14 @@ { "type": "reflection", "declaration": { - "id": 549, + "id": 575, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 550, + "id": 576, "name": "eventType", "kind": 1024, "kindString": "Property", @@ -5915,7 +6378,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 52, + "line": 57, "character": 4 } ], @@ -5926,7 +6389,7 @@ [ { "type": "reference", - "id": 596, + "id": 623, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" }, "" @@ -5935,7 +6398,7 @@ } }, { - "id": 551, + "id": 577, "name": "new", "kind": 1024, "kindString": "Property", @@ -5943,14 +6406,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 53, + "line": 58, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 552, + "id": 578, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5958,7 +6421,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 53, + "line": 58, "character": 9 } ] @@ -5966,7 +6429,7 @@ } }, { - "id": 553, + "id": 579, "name": "old", "kind": 1024, "kindString": "Property", @@ -5974,7 +6437,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 54, + "line": 59, "character": 4 } ], @@ -5983,7 +6446,7 @@ "typeArguments": [ { "type": "reference", - "id": 557, + "id": 583, "name": "T" } ], @@ -5997,13 +6460,13 @@ { "title": "Properties", "kind": 1024, - "children": [550, 551, 553] + "children": [576, 577, 579] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 51, + "line": 56, "character": 39 } ] @@ -6013,7 +6476,7 @@ } }, { - "id": 529, + "id": 555, "name": "RealtimePostgresInsertPayload", "kind": 4194304, "kindString": "Type alias", @@ -6021,13 +6484,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 36, + "line": 41, "character": 12 } ], "typeParameter": [ { - "id": 538, + "id": 564, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6035,7 +6498,7 @@ "type": { "type": "reflection", "declaration": { - "id": 535, + "id": 561, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6043,19 +6506,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 36, + "line": 41, "character": 52 } ], "indexSignature": { - "id": 536, + "id": 562, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 537, + "id": 563, "name": "key", "kind": 32768, "flags": {}, @@ -6084,14 +6547,14 @@ { "type": "reflection", "declaration": { - "id": 530, + "id": 556, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 531, + "id": 557, "name": "eventType", "kind": 1024, "kindString": "Property", @@ -6099,7 +6562,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 38, + "line": 43, "character": 4 } ], @@ -6110,7 +6573,7 @@ [ { "type": "reference", - "id": 594, + "id": 621, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" }, "" @@ -6119,7 +6582,7 @@ } }, { - "id": 532, + "id": 558, "name": "new", "kind": 1024, "kindString": "Property", @@ -6127,151 +6590,22 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 39, + "line": 44, "character": 4 } ], "type": { "type": "reference", - "id": 538, + "id": 564, "name": "T" } }, { - "id": 533, + "id": 559, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 40, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 534, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 40, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [531, 532, 533] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 37, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 539, - "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 43, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 547, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 43, - "character": 52 - } - ], - "indexSignature": { - "id": 545, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 546, - "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": 540, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 541, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -6279,6 +6613,135 @@ "character": 4 } ], + "type": { + "type": "reflection", + "declaration": { + "id": 560, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 45, + "character": 9 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [557, 558, 559] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 42, + "character": 39 + } + ] + } + } + ] + } + }, + { + "id": 565, + "name": "RealtimePostgresUpdatePayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 48, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 573, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 570, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 48, + "character": 52 + } + ], + "indexSignature": { + "id": 571, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 572, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "name": "RealtimePostgresChangesPayloadBase" + }, + { + "type": "reflection", + "declaration": { + "id": 566, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 567, + "name": "eventType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 50, + "character": 4 + } + ], "type": { "type": "template-literal", "head": "", @@ -6286,7 +6749,7 @@ [ { "type": "reference", - "id": 595, + "id": 622, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" }, "" @@ -6295,7 +6758,7 @@ } }, { - "id": 542, + "id": 568, "name": "new", "kind": 1024, "kindString": "Property", @@ -6303,18 +6766,18 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 46, + "line": 51, "character": 4 } ], "type": { "type": "reference", - "id": 547, + "id": 573, "name": "T" } }, { - "id": 543, + "id": 569, "name": "old", "kind": 1024, "kindString": "Property", @@ -6322,7 +6785,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 47, + "line": 52, "character": 4 } ], @@ -6331,7 +6794,7 @@ "typeArguments": [ { "type": "reference", - "id": 547, + "id": 573, "name": "T" } ], @@ -6345,13 +6808,13 @@ { "title": "Properties", "kind": 1024, - "children": [541, 542, 543] + "children": [567, 568, 569] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 44, + "line": 49, "character": 39 } ] @@ -6361,7 +6824,7 @@ } }, { - "id": 558, + "id": 584, "name": "RealtimePresenceJoinPayload", "kind": 4194304, "kindString": "Type alias", @@ -6375,7 +6838,7 @@ ], "typeParameter": [ { - "id": 567, + "id": 593, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6383,7 +6846,7 @@ "type": { "type": "reflection", "declaration": { - "id": 564, + "id": 590, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6396,14 +6859,14 @@ } ], "indexSignature": { - "id": 565, + "id": 591, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 566, + "id": 592, "name": "key", "kind": 32768, "flags": {}, @@ -6425,14 +6888,14 @@ "type": { "type": "reflection", "declaration": { - "id": 559, + "id": 585, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 562, + "id": 588, "name": "currentPresences", "kind": 1024, "kindString": "Property", @@ -6451,7 +6914,7 @@ "typeArguments": [ { "type": "reference", - "id": 567, + "id": 593, "name": "T" } ], @@ -6460,7 +6923,7 @@ } }, { - "id": 560, + "id": 586, "name": "event", "kind": 1024, "kindString": "Property", @@ -6479,7 +6942,7 @@ [ { "type": "reference", - "id": 599, + "id": 626, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" }, "" @@ -6488,7 +6951,7 @@ } }, { - "id": 561, + "id": 587, "name": "key", "kind": 1024, "kindString": "Property", @@ -6506,7 +6969,7 @@ } }, { - "id": 563, + "id": 589, "name": "newPresences", "kind": 1024, "kindString": "Property", @@ -6525,7 +6988,7 @@ "typeArguments": [ { "type": "reference", - "id": 567, + "id": 593, "name": "T" } ], @@ -6538,7 +7001,7 @@ { "title": "Properties", "kind": 1024, - "children": [562, 560, 561, 563] + "children": [588, 586, 587, 589] } ], "sources": [ @@ -6552,7 +7015,7 @@ } }, { - "id": 568, + "id": 594, "name": "RealtimePresenceLeavePayload", "kind": 4194304, "kindString": "Type alias", @@ -6566,7 +7029,7 @@ ], "typeParameter": [ { - "id": 577, + "id": 603, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6574,7 +7037,7 @@ "type": { "type": "reflection", "declaration": { - "id": 574, + "id": 600, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6587,14 +7050,14 @@ } ], "indexSignature": { - "id": 575, + "id": 601, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 576, + "id": 602, "name": "key", "kind": 32768, "flags": {}, @@ -6616,14 +7079,14 @@ "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 572, + "id": 598, "name": "currentPresences", "kind": 1024, "kindString": "Property", @@ -6642,7 +7105,7 @@ "typeArguments": [ { "type": "reference", - "id": 577, + "id": 603, "name": "T" } ], @@ -6651,7 +7114,7 @@ } }, { - "id": 570, + "id": 596, "name": "event", "kind": 1024, "kindString": "Property", @@ -6670,7 +7133,7 @@ [ { "type": "reference", - "id": 600, + "id": 627, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" }, "" @@ -6679,7 +7142,7 @@ } }, { - "id": 571, + "id": 597, "name": "key", "kind": 1024, "kindString": "Property", @@ -6697,7 +7160,7 @@ } }, { - "id": 573, + "id": 599, "name": "leftPresences", "kind": 1024, "kindString": "Property", @@ -6716,7 +7179,7 @@ "typeArguments": [ { "type": "reference", - "id": 577, + "id": 603, "name": "T" } ], @@ -6729,7 +7192,7 @@ { "title": "Properties", "kind": 1024, - "children": [572, 570, 571, 573] + "children": [598, 596, 597, 599] } ], "sources": [ @@ -6743,7 +7206,7 @@ } }, { - "id": 578, + "id": 604, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", @@ -6757,7 +7220,7 @@ ], "typeParameter": [ { - "id": 586, + "id": 612, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6765,7 +7228,7 @@ "type": { "type": "reflection", "declaration": { - "id": 582, + "id": 608, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6778,14 +7241,14 @@ } ], "indexSignature": { - "id": 583, + "id": 609, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 584, + "id": 610, "name": "key", "kind": 32768, "flags": {}, @@ -6805,7 +7268,7 @@ "default": { "type": "reflection", "declaration": { - "id": 585, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6824,7 +7287,7 @@ "type": { "type": "reflection", "declaration": { - "id": 579, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6837,14 +7300,14 @@ } ], "indexSignature": { - "id": 580, + "id": 606, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 581, + "id": 607, "name": "key", "kind": 32768, "flags": {}, @@ -6861,7 +7324,7 @@ "typeArguments": [ { "type": "reference", - "id": 586, + "id": 612, "name": "T" } ], @@ -6873,7 +7336,7 @@ } }, { - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse", "kind": 4194304, "kindString": "Type alias", @@ -6881,7 +7344,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 42, + "line": 54, "character": 12 } ], @@ -6904,7 +7367,7 @@ } }, { - "id": 606, + "id": 633, "name": "REALTIME_CHANNEL_STATES", "kind": 32, "kindString": "Variable", @@ -6914,7 +7377,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 108, + "line": 111, "character": 13 } ], @@ -6932,22 +7395,22 @@ { "title": "Enumerations", "kind": 8, - "children": [588, 592, 597, 601] + "children": [614, 619, 624, 628] }, { "title": "Classes", "kind": 128, - "children": [64, 359, 1] + "children": [64, 371, 1] }, { "title": "Type Aliases", "kind": 4194304, - "children": [347, 358, 491, 510, 517, 524, 548, 529, 539, 558, 568, 578, 587] + "children": [358, 370, 513, 536, 543, 550, 574, 555, 565, 584, 594, 604, 613] }, { "title": "Variables", "kind": 32, - "children": [606] + "children": [633] } ], "sources": [ diff --git a/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json index 8296398d31c..efdf6dc3142 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 588, + "id": 614, "name": "REALTIME_LISTEN_TYPES", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 589, + "id": 615, "name": "BROADCAST", "kind": 16, "kindString": "Enumeration Member", @@ -22,7 +22,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 93, + "line": 98, "character": 2 } ], @@ -33,18 +33,15 @@ "defaultValue": "\"broadcast\"" }, { - "id": 591, + "id": 617, "name": "POSTGRES_CHANGES", "kind": 16, "kindString": "Enumeration Member", "flags": {}, - "comment": { - "shortText": "listen to Postgres changes." - }, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 98, + "line": 100, "character": 2 } ], @@ -55,11 +52,91 @@ "defaultValue": "\"postgres_changes\"" }, { - "id": 590, + "id": 616, "name": "PRESENCE", "kind": 16, "kindString": "Enumeration Member", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 99, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "presence" + }, + "defaultValue": "\"presence\"" + }, + { + "id": 618, + "name": "SYSTEM", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 101, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "system" + }, + "defaultValue": "\"system\"" + } + ], + "groups": [ + { + "title": "Enumeration Members", + "kind": 16, + "children": [615, 617, 616, 618] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 97, + "character": 12 + } + ] + }, + { + "id": 619, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 620, + "name": "ALL", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 91, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "*" + }, + "defaultValue": "\"*\"" + }, + { + "id": 623, + "name": "DELETE", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -67,67 +144,6 @@ "character": 2 } ], - "type": { - "type": "literal", - "value": "presence" - }, - "defaultValue": "\"presence\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [589, 591, 590] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 92, - "character": 12 - } - ] - }, - { - "id": 592, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 593, - "name": "ALL", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "*" - }, - "defaultValue": "\"*\"" - }, - { - "id": 596, - "name": "DELETE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 89, - "character": 2 - } - ], "type": { "type": "literal", "value": "DELETE" @@ -135,7 +151,7 @@ "defaultValue": "\"DELETE\"" }, { - "id": 594, + "id": 621, "name": "INSERT", "kind": 16, "kindString": "Enumeration Member", @@ -143,7 +159,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 87, + "line": 92, "character": 2 } ], @@ -154,7 +170,7 @@ "defaultValue": "\"INSERT\"" }, { - "id": 595, + "id": 622, "name": "UPDATE", "kind": 16, "kindString": "Enumeration Member", @@ -162,7 +178,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 88, + "line": 93, "character": 2 } ], @@ -177,26 +193,26 @@ { "title": "Enumeration Members", "kind": 16, - "children": [593, 596, 594, 595] + "children": [620, 623, 621, 622] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 85, + "line": 90, "character": 12 } ] }, { - "id": 597, + "id": 624, "name": "REALTIME_PRESENCE_LISTEN_EVENTS", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 599, + "id": 626, "name": "JOIN", "kind": 16, "kindString": "Enumeration Member", @@ -215,7 +231,7 @@ "defaultValue": "\"join\"" }, { - "id": 600, + "id": 627, "name": "LEAVE", "kind": 16, "kindString": "Enumeration Member", @@ -234,7 +250,7 @@ "defaultValue": "\"leave\"" }, { - "id": 598, + "id": 625, "name": "SYNC", "kind": 16, "kindString": "Enumeration Member", @@ -257,7 +273,7 @@ { "title": "Enumeration Members", "kind": 16, - "children": [599, 600, 598] + "children": [626, 627, 625] } ], "sources": [ @@ -269,18 +285,56 @@ ] }, { - "id": 601, + "id": 628, "name": "REALTIME_SUBSCRIBE_STATES", "kind": 8, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 605, + "id": 632, "name": "CHANNEL_ERROR", "kind": 16, "kindString": "Enumeration Member", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 108, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "CHANNEL_ERROR" + }, + "defaultValue": "\"CHANNEL_ERROR\"" + }, + { + "id": 631, + "name": "CLOSED", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 107, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "CLOSED" + }, + "defaultValue": "\"CLOSED\"" + }, + { + "id": 629, + "name": "SUBSCRIBED", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -288,44 +342,6 @@ "character": 2 } ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - }, - "defaultValue": "\"CHANNEL_ERROR\"" - }, - { - "id": 604, - "name": "CLOSED", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 104, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - }, - "defaultValue": "\"CLOSED\"" - }, - { - "id": 602, - "name": "SUBSCRIBED", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 102, - "character": 2 - } - ], "type": { "type": "literal", "value": "SUBSCRIBED" @@ -333,7 +349,7 @@ "defaultValue": "\"SUBSCRIBED\"" }, { - "id": 603, + "id": 630, "name": "TIMED_OUT", "kind": 16, "kindString": "Enumeration Member", @@ -341,7 +357,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 103, + "line": 106, "character": 2 } ], @@ -356,13 +372,13 @@ { "title": "Enumeration Members", "kind": 16, - "children": [605, 604, 602, 603] + "children": [632, 631, 629, 630] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 101, + "line": 104, "character": 12 } ] @@ -386,7 +402,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 134, + "line": 147, "character": 2 } ], @@ -417,10 +433,10 @@ "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -428,21 +444,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -450,21 +466,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -477,21 +493,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -501,7 +517,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -511,7 +527,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -521,7 +537,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -535,13 +551,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -549,7 +565,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -562,21 +578,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -586,7 +602,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -600,31 +616,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -636,13 +675,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -660,17 +699,17 @@ "flags": {}, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -678,13 +717,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -694,7 +733,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -708,7 +747,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -717,10 +756,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -728,21 +767,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -752,7 +791,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -764,7 +803,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -774,7 +813,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -786,7 +825,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -796,7 +835,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -806,7 +845,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -816,14 +855,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -831,19 +870,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -862,7 +901,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -872,7 +911,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -882,7 +921,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -892,7 +931,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -919,7 +958,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -929,7 +968,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -941,7 +980,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -951,14 +990,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -966,19 +1005,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -997,7 +1036,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -1007,7 +1046,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -1019,7 +1058,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -1029,7 +1068,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -1039,7 +1078,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -1049,7 +1088,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -1057,6 +1096,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -1064,15 +1189,20 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, 496, 504, 499, 494, - 493 + 520, 519, 531, 522, 517, 530, 518, 526, 521, 516, + 515, 532, 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -1084,14 +1214,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -1099,7 +1229,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -1119,7 +1313,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -1127,7 +1321,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -1147,7 +1341,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -1155,7 +1349,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -1170,7 +1364,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -1178,7 +1372,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -1198,7 +1392,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -1206,7 +1400,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -1218,7 +1412,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -1226,7 +1420,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -1238,7 +1432,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -1246,7 +1440,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -1257,7 +1451,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -1265,28 +1459,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1310,7 +1504,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1341,14 +1535,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1376,7 +1570,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1411,7 +1605,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -1421,27 +1615,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -1461,7 +1655,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -1469,7 +1663,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -1480,7 +1674,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -1488,7 +1682,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -1510,7 +1704,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -1518,7 +1731,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -1531,7 +1744,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -1541,27 +1754,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -1581,7 +1794,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -1589,7 +1802,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -1609,7 +1822,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -1617,7 +1830,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -1629,7 +1842,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -1637,7 +1850,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -1647,7 +1860,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -1655,7 +1868,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -1666,7 +1879,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -1674,7 +1887,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -1690,7 +1903,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -1698,7 +1911,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -1709,7 +1922,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -1717,21 +1930,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -1739,7 +1952,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -1754,7 +1967,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -1762,7 +1975,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -1777,7 +1990,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -1785,7 +1998,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -1800,7 +2013,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -1808,7 +2021,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -1827,7 +2040,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -1835,7 +2048,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -1843,7 +2056,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -1854,7 +2067,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -1862,7 +2075,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -1881,7 +2094,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -1889,20 +2215,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -1913,17 +2239,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -1931,21 +2257,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -1953,21 +2279,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -1980,21 +2306,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -2004,7 +2330,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -2014,7 +2340,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -2024,7 +2350,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -2038,13 +2364,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -2052,7 +2378,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -2065,21 +2391,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -2089,7 +2415,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -2103,31 +2429,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -2139,13 +2488,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -2165,7 +2514,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -2173,13 +2522,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -2195,7 +2544,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -2203,13 +2552,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -2225,7 +2574,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -2233,13 +2582,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -2249,7 +2598,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -2265,7 +2614,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -2289,7 +2638,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -2297,13 +2707,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -2323,7 +2733,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -2331,13 +2741,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -2353,7 +2763,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -2361,13 +2771,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -2378,7 +2788,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -2389,7 +2799,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -2400,7 +2810,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -2421,7 +2831,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -2429,13 +2839,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -2446,17 +2856,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -2464,21 +2874,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -2486,7 +2896,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -2496,7 +2906,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -2506,7 +2916,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -2516,7 +2926,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -2524,7 +2934,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -2534,7 +2944,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -2542,7 +2952,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -2552,7 +2962,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -2560,7 +2970,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -2574,13 +2984,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -2598,7 +3008,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -2606,13 +3016,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -2627,7 +3037,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -2640,7 +3050,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -2648,13 +3058,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -2664,7 +3074,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -2696,19 +3106,20 @@ "title": "Properties", "kind": 1024, "children": [ - 80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101 + 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, + 102 ] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -2721,7 +3132,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -2733,7 +3144,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -2741,29 +3190,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -2777,12 +3227,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -2792,26 +3251,29 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, - 386, 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, + 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, - "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] + "children": [ + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, + 454 + ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -2836,7 +3298,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 116, + "line": 128, "character": 2 } ], @@ -2886,7 +3348,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 120, + "line": 132, "character": 6 } ], @@ -2906,7 +3368,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 6 } ], @@ -2921,7 +3383,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 14 } ], @@ -2962,7 +3424,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 121, + "line": 133, "character": 6 } ], @@ -2980,7 +3442,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 118, + "line": 130, "character": 6 } ], @@ -3000,7 +3462,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 117, + "line": 129, "character": 19 } ] @@ -3021,7 +3483,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 143, "character": 2 } ], @@ -3039,7 +3501,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 127, + "line": 139, "character": 2 } ], @@ -3057,7 +3519,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 126, + "line": 138, "character": 2 } ], @@ -3068,7 +3530,7 @@ "defaultValue": "false" }, { - "id": 102, + "id": 103, "name": "params", "kind": 1024, "kindString": "Property", @@ -3077,10 +3539,10 @@ }, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -3088,21 +3550,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -3110,21 +3572,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -3137,21 +3599,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -3161,7 +3623,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -3171,7 +3633,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -3181,7 +3643,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -3195,13 +3657,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -3209,7 +3671,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -3222,21 +3684,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -3246,7 +3708,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -3260,31 +3722,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -3296,13 +3781,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -3321,7 +3806,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 130, + "line": 142, "character": 2 } ], @@ -3393,19 +3878,19 @@ "title": "Properties", "kind": 1024, "children": [ - 80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101 + 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 ] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -3576,18 +4061,18 @@ { "title": "Properties", "kind": 1024, - "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] + "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -3659,7 +4144,7 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reflection", @@ -3674,7 +4159,7 @@ ], "name": "RealtimePresenceState", "dereferenced": { - "id": 578, + "id": 604, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", @@ -3688,7 +4173,7 @@ ], "typeParameter": [ { - "id": 586, + "id": 612, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -3696,7 +4181,7 @@ "type": { "type": "reflection", "declaration": { - "id": 582, + "id": 608, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -3709,14 +4194,14 @@ } ], "indexSignature": { - "id": 583, + "id": 609, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 584, + "id": 610, "name": "key", "kind": 32768, "flags": {}, @@ -3736,7 +4221,7 @@ "default": { "type": "reflection", "declaration": { - "id": 585, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -3755,7 +4240,7 @@ "type": { "type": "reflection", "declaration": { - "id": 579, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -3768,14 +4253,14 @@ } ], "indexSignature": { - "id": 580, + "id": 606, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 581, + "id": 607, "name": "key", "kind": 32768, "flags": {}, @@ -3792,7 +4277,7 @@ "typeArguments": [ { "type": "reference", - "id": 586, + "id": 612, "name": "T" } ], @@ -3829,6 +4314,24 @@ } } }, + { + "id": 101, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 97, "name": "pushBuffer", @@ -3838,7 +4341,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 141, "character": 2 } ], @@ -3860,7 +4363,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 140, "character": 2 } ], @@ -3870,7 +4373,7 @@ } }, { - "id": 103, + "id": 104, "name": "socket", "kind": 1024, "kindString": "Property", @@ -3879,17 +4382,17 @@ }, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -3897,13 +4400,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -3913,7 +4416,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -3927,7 +4430,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -3936,10 +4439,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -3947,21 +4450,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -3971,7 +4474,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -3983,7 +4486,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -3993,7 +4496,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -4005,7 +4508,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -4015,7 +4518,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -4025,7 +4528,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -4035,14 +4538,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -4050,19 +4553,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -4081,7 +4584,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -4091,7 +4594,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -4101,7 +4604,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -4111,7 +4614,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -4138,7 +4641,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -4148,7 +4651,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -4160,7 +4663,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -4170,14 +4673,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -4185,19 +4688,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -4216,7 +4719,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -4226,7 +4729,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -4238,7 +4741,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -4248,7 +4751,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -4258,7 +4761,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -4268,7 +4771,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -4276,6 +4779,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -4283,14 +4872,20 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493 + 520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, 532, + 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -4302,14 +4897,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -4317,7 +4912,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -4337,7 +4996,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -4345,7 +5004,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -4365,7 +5024,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -4373,7 +5032,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -4388,7 +5047,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -4396,7 +5055,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -4416,7 +5075,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -4424,7 +5083,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -4436,7 +5095,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -4444,7 +5103,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -4456,7 +5115,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -4464,7 +5123,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -4475,7 +5134,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -4483,28 +5142,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -4528,7 +5187,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -4559,14 +5218,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -4594,7 +5253,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -4629,7 +5288,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -4639,27 +5298,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -4679,7 +5338,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -4687,7 +5346,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -4698,7 +5357,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -4706,7 +5365,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -4728,7 +5387,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -4736,7 +5414,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -4749,7 +5427,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -4759,27 +5437,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -4799,7 +5477,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -4807,7 +5485,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -4827,7 +5505,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -4835,7 +5513,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -4847,7 +5525,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -4855,7 +5533,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -4865,7 +5543,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -4873,7 +5551,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -4884,7 +5562,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -4892,7 +5570,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -4908,7 +5586,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -4916,7 +5594,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -4927,7 +5605,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -4935,21 +5613,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -4957,7 +5635,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -4972,7 +5650,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -4980,7 +5658,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -4995,7 +5673,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -5003,7 +5681,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -5018,7 +5696,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -5026,7 +5704,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -5045,7 +5723,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -5053,7 +5731,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -5061,7 +5739,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -5072,7 +5750,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -5080,7 +5758,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -5099,7 +5777,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -5107,20 +5898,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -5131,17 +5922,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -5149,21 +5940,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -5171,21 +5962,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -5198,21 +5989,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -5222,7 +6013,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -5232,7 +6023,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -5242,7 +6033,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -5256,13 +6047,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -5270,7 +6061,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -5283,21 +6074,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -5307,7 +6098,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -5321,31 +6112,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -5357,13 +6171,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -5383,7 +6197,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -5391,13 +6205,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -5413,7 +6227,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -5421,13 +6235,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -5443,7 +6257,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -5451,13 +6265,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -5467,7 +6281,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -5483,7 +6297,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -5507,7 +6321,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -5515,13 +6390,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -5541,7 +6416,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -5549,13 +6424,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -5571,7 +6446,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -5579,13 +6454,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -5596,7 +6471,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -5607,7 +6482,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -5618,7 +6493,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -5639,7 +6514,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -5647,13 +6522,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -5664,17 +6539,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -5682,21 +6557,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -5704,7 +6579,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -5714,7 +6589,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -5724,7 +6599,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -5734,7 +6609,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -5742,7 +6617,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -5752,7 +6627,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -5760,7 +6635,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -5770,7 +6645,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -5778,7 +6653,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -5792,13 +6667,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -5816,7 +6691,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -5824,13 +6699,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -5845,7 +6720,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -5858,7 +6733,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -5866,13 +6741,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -5882,7 +6757,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -5914,19 +6789,19 @@ "title": "Properties", "kind": 1024, "children": [ - 80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101 + 80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102 ] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -5939,7 +6814,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -5951,7 +6826,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -5959,29 +6872,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -5995,12 +6909,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -6010,26 +6933,28 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, - 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, 385, 393, + 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, - "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] + "children": [ + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, 454 + ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -6045,7 +6970,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 125, + "line": 137, "character": 2 } ], @@ -6064,7 +6989,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 132, + "line": 144, "character": 2 } ], @@ -6082,7 +7007,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 124, + "line": 136, "character": 2 } ], @@ -6092,7 +7017,7 @@ } }, { - "id": 101, + "id": 102, "name": "topic", "kind": 1024, "kindString": "Property", @@ -6105,108 +7030,7 @@ } }, { - "id": 269, - "name": "_fetchWithTimeout", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 538, - "character": 8 - } - ], - "signatures": [ - { - "id": 270, - "name": "_fetchWithTimeout", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 271, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 272, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 273, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 274, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 275, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 276, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 135, + "id": 136, "name": "on", "kind": 2048, "kindString": "Method", @@ -6220,7 +7044,7 @@ ], "signatures": [ { - "id": 136, + "id": 137, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -6230,7 +7054,7 @@ }, "parameters": [ { - "id": 137, + "id": 138, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -6241,7 +7065,7 @@ } }, { - "id": 138, + "id": 139, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -6249,14 +7073,14 @@ "type": { "type": "reflection", "declaration": { - "id": 139, + "id": 140, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 140, + "id": 141, "name": "event", "kind": 1024, "kindString": "Property", @@ -6278,14 +7102,14 @@ { "title": "Properties", "kind": 1024, - "children": [140] + "children": [141] } ] } } }, { - "id": 141, + "id": 142, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -6293,14 +7117,14 @@ "type": { "type": "reflection", "declaration": { - "id": 142, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 143, + "id": 144, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -6322,14 +7146,14 @@ } }, { - "id": 144, + "id": 145, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 148, + "id": 149, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6337,20 +7161,20 @@ "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 146, + "id": 147, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 147, + "id": 148, "name": "key", "kind": 32768, "flags": {}, @@ -6371,7 +7195,7 @@ ], "parameters": [ { - "id": 149, + "id": 150, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -6382,7 +7206,7 @@ } }, { - "id": 150, + "id": 151, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -6390,14 +7214,14 @@ "type": { "type": "reflection", "declaration": { - "id": 151, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 153, "name": "event", "kind": 1024, "kindString": "Property", @@ -6419,14 +7243,14 @@ { "title": "Properties", "kind": 1024, - "children": [152] + "children": [153] } ] } } }, { - "id": 153, + "id": 154, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -6434,32 +7258,32 @@ "type": { "type": "reflection", "declaration": { - "id": 154, + "id": 155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 155, + "id": 156, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 156, + "id": 157, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 558, + "id": 584, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 149, "name": "T" } ], @@ -6484,14 +7308,14 @@ } }, { - "id": 157, + "id": 158, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 161, + "id": 162, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6499,20 +7323,20 @@ "type": { "type": "reflection", "declaration": { - "id": 158, + "id": 159, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 159, + "id": 160, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 160, + "id": 161, "name": "key", "kind": 32768, "flags": {}, @@ -6533,7 +7357,7 @@ ], "parameters": [ { - "id": 162, + "id": 163, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -6544,7 +7368,7 @@ } }, { - "id": 163, + "id": 164, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -6552,14 +7376,14 @@ "type": { "type": "reflection", "declaration": { - "id": 164, + "id": 165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 165, + "id": 166, "name": "event", "kind": 1024, "kindString": "Property", @@ -6581,14 +7405,14 @@ { "title": "Properties", "kind": 1024, - "children": [165] + "children": [166] } ] } } }, { - "id": 166, + "id": 167, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -6596,32 +7420,32 @@ "type": { "type": "reflection", "declaration": { - "id": 167, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 168, + "id": 169, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 169, + "id": 170, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 568, + "id": 594, "typeArguments": [ { "type": "reference", - "id": 161, + "id": 162, "name": "T" } ], @@ -6646,14 +7470,14 @@ } }, { - "id": 170, + "id": 171, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 174, + "id": 175, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6661,20 +7485,20 @@ "type": { "type": "reflection", "declaration": { - "id": 171, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 172, + "id": 173, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 173, + "id": 174, "name": "key", "kind": 32768, "flags": {}, @@ -6695,7 +7519,7 @@ ], "parameters": [ { - "id": 175, + "id": 176, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -6706,14 +7530,14 @@ } }, { - "id": 176, + "id": 177, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -6722,7 +7546,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -6730,13 +7554,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6748,7 +7572,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -6760,14 +7584,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -6778,19 +7602,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -6803,7 +7627,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -6813,7 +7637,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -6824,7 +7648,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -6834,7 +7658,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -6847,7 +7671,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -6861,13 +7685,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -6877,7 +7701,7 @@ } }, { - "id": 177, + "id": 178, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -6885,32 +7709,32 @@ "type": { "type": "reflection", "declaration": { - "id": 178, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 179, + "id": 180, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 180, + "id": 181, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 524, + "id": 550, "typeArguments": [ { "type": "reference", - "id": 174, + "id": 175, "name": "T" } ], @@ -6935,14 +7759,14 @@ } }, { - "id": 181, + "id": 182, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 185, + "id": 186, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6950,20 +7774,20 @@ "type": { "type": "reflection", "declaration": { - "id": 182, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 183, + "id": 184, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 184, + "id": 185, "name": "key", "kind": 32768, "flags": {}, @@ -6984,7 +7808,7 @@ ], "parameters": [ { - "id": 186, + "id": 187, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -6995,14 +7819,14 @@ } }, { - "id": 187, + "id": 188, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -7011,7 +7835,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -7019,13 +7843,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -7037,7 +7861,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -7049,14 +7873,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -7067,19 +7891,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -7092,7 +7916,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -7102,7 +7926,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -7113,7 +7937,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -7123,7 +7947,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -7136,7 +7960,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -7150,13 +7974,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -7166,7 +7990,7 @@ } }, { - "id": 188, + "id": 189, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -7174,32 +7998,32 @@ "type": { "type": "reflection", "declaration": { - "id": 189, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 190, + "id": 191, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 191, + "id": 192, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 529, + "id": 555, "typeArguments": [ { "type": "reference", - "id": 185, + "id": 186, "name": "T" } ], @@ -7224,14 +8048,14 @@ } }, { - "id": 192, + "id": 193, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 196, + "id": 197, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -7239,20 +8063,20 @@ "type": { "type": "reflection", "declaration": { - "id": 193, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 194, + "id": 195, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 196, "name": "key", "kind": 32768, "flags": {}, @@ -7273,7 +8097,7 @@ ], "parameters": [ { - "id": 197, + "id": 198, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -7284,14 +8108,14 @@ } }, { - "id": 198, + "id": 199, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -7300,7 +8124,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -7308,13 +8132,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -7326,7 +8150,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -7338,14 +8162,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -7356,19 +8180,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -7381,7 +8205,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -7391,7 +8215,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -7402,7 +8226,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -7412,7 +8236,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -7425,7 +8249,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -7439,13 +8263,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -7455,7 +8279,7 @@ } }, { - "id": 199, + "id": 200, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -7463,32 +8287,32 @@ "type": { "type": "reflection", "declaration": { - "id": 200, + "id": 201, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 201, + "id": 202, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 202, + "id": 203, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 539, + "id": 565, "typeArguments": [ { "type": "reference", - "id": 196, + "id": 197, "name": "T" } ], @@ -7513,14 +8337,14 @@ } }, { - "id": 203, + "id": 204, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 207, + "id": 208, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -7528,20 +8352,20 @@ "type": { "type": "reflection", "declaration": { - "id": 204, + "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 205, + "id": 206, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 206, + "id": 207, "name": "key", "kind": 32768, "flags": {}, @@ -7562,7 +8386,7 @@ ], "parameters": [ { - "id": 208, + "id": 209, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -7573,14 +8397,14 @@ } }, { - "id": 209, + "id": 210, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -7589,7 +8413,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -7597,13 +8421,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -7615,7 +8439,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -7627,14 +8451,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -7645,19 +8469,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -7670,7 +8494,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -7680,7 +8504,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -7691,7 +8515,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -7701,7 +8525,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -7714,7 +8538,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -7728,13 +8552,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -7744,7 +8568,7 @@ } }, { - "id": 210, + "id": 211, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -7752,32 +8576,32 @@ "type": { "type": "reflection", "declaration": { - "id": 211, + "id": 212, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 212, + "id": 213, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 213, + "id": 214, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 548, + "id": 574, "typeArguments": [ { "type": "reference", - "id": 207, + "id": 208, "name": "T" } ], @@ -7802,7 +8626,7 @@ } }, { - "id": 214, + "id": 215, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -7812,7 +8636,7 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -7826,7 +8650,7 @@ } }, { - "id": 216, + "id": 217, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -7837,14 +8661,14 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 218, + "id": 219, "name": "event", "kind": 1024, "kindString": "Property", @@ -7866,14 +8690,14 @@ { "title": "Properties", "kind": 1024, - "children": [218] + "children": [219] } ] } } }, { - "id": 219, + "id": 220, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -7884,21 +8708,21 @@ "type": { "type": "reflection", "declaration": { - "id": 220, + "id": 221, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 221, + "id": 222, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 222, + "id": 223, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -7906,14 +8730,14 @@ "type": { "type": "reflection", "declaration": { - "id": 223, + "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 226, "name": "event", "kind": 1024, "kindString": "Property", @@ -7931,7 +8755,7 @@ } }, { - "id": 224, + "id": 225, "name": "type", "kind": 1024, "kindString": "Property", @@ -7953,18 +8777,18 @@ { "title": "Properties", "kind": 1024, - "children": [225, 224] + "children": [226, 225] } ], "indexSignature": { - "id": 226, + "id": 227, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 227, + "id": 228, "name": "key", "kind": 32768, "flags": {}, @@ -8000,14 +8824,14 @@ } }, { - "id": 228, + "id": 229, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 232, + "id": 233, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -8015,20 +8839,20 @@ "type": { "type": "reflection", "declaration": { - "id": 229, + "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 230, + "id": 231, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 231, + "id": 232, "name": "key", "kind": 32768, "flags": {}, @@ -8049,7 +8873,7 @@ ], "parameters": [ { - "id": 233, + "id": 234, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -8060,7 +8884,7 @@ } }, { - "id": 234, + "id": 235, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -8068,14 +8892,14 @@ "type": { "type": "reflection", "declaration": { - "id": 235, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 236, + "id": 237, "name": "event", "kind": 1024, "kindString": "Property", @@ -8097,14 +8921,14 @@ { "title": "Properties", "kind": 1024, - "children": [236] + "children": [237] } ] } } }, { - "id": 237, + "id": 238, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -8112,21 +8936,21 @@ "type": { "type": "reflection", "declaration": { - "id": 238, + "id": 239, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 239, + "id": 240, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 240, + "id": 241, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -8134,14 +8958,14 @@ "type": { "type": "reflection", "declaration": { - "id": 241, + "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 243, + "id": 244, "name": "event", "kind": 1024, "kindString": "Property", @@ -8159,7 +8983,7 @@ } }, { - "id": 244, + "id": 245, "name": "payload", "kind": 1024, "kindString": "Property", @@ -8173,12 +8997,12 @@ ], "type": { "type": "reference", - "id": 232, + "id": 233, "name": "T" } }, { - "id": 242, + "id": 243, "name": "type", "kind": 1024, "kindString": "Property", @@ -8200,7 +9024,7 @@ { "title": "Properties", "kind": 1024, - "children": [243, 244, 242] + "children": [244, 245, 243] } ] } @@ -8222,11 +9046,138 @@ "id": 64, "name": "default" } + }, + { + "id": 246, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 250, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 247, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 248, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 249, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 251, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "system" + } + }, + { + "id": 252, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 253, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 254, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 255, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 256, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 257, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } } ] }, { - "id": 112, + "id": 113, "name": "presenceState", "kind": 2048, "kindString": "Method", @@ -8240,14 +9191,14 @@ ], "signatures": [ { - "id": 113, + "id": 114, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 118, + "id": 119, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -8255,20 +9206,20 @@ "type": { "type": "reflection", "declaration": { - "id": 114, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 115, + "id": 116, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 116, + "id": 117, "name": "key", "kind": 32768, "flags": {}, @@ -8288,7 +9239,7 @@ "default": { "type": "reflection", "declaration": { - "id": 117, + "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -8299,11 +9250,11 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reference", - "id": 118, + "id": 119, "name": "T" } ], @@ -8313,7 +9264,7 @@ ] }, { - "id": 245, + "id": 258, "name": "send", "kind": 2048, "kindString": "Method", @@ -8321,13 +9272,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 425, + "line": 430, "character": 8 } ], "signatures": [ { - "id": 246, + "id": 259, "name": "send", "kind": 4096, "kindString": "Call signature", @@ -8337,7 +9288,7 @@ }, "parameters": [ { - "id": 247, + "id": 260, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -8348,14 +9299,14 @@ "type": { "type": "reflection", "declaration": { - "id": 248, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 263, "name": "event", "kind": 1024, "kindString": "Property", @@ -8366,7 +9317,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 428, + "line": 433, "character": 6 } ], @@ -8376,7 +9327,7 @@ } }, { - "id": 251, + "id": 264, "name": "payload", "kind": 1024, "kindString": "Property", @@ -8389,7 +9340,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 429, + "line": 434, "character": 6 } ], @@ -8399,7 +9350,7 @@ } }, { - "id": 249, + "id": 262, "name": "type", "kind": 1024, "kindString": "Property", @@ -8410,7 +9361,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 427, + "line": 432, "character": 6 } ], @@ -8437,18 +9388,18 @@ { "title": "Properties", "kind": 1024, - "children": [250, 251, 249] + "children": [263, 264, 262] } ], "indexSignature": { - "id": 252, + "id": 265, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 253, + "id": 266, "name": "key", "kind": 32768, "flags": {}, @@ -8467,7 +9418,7 @@ } }, { - "id": 254, + "id": 267, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -8478,20 +9429,20 @@ "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 256, + "id": 269, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 257, + "id": 270, "name": "key", "kind": 32768, "flags": {}, @@ -8516,7 +9467,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -8528,7 +9479,7 @@ ] }, { - "id": 104, + "id": 105, "name": "subscribe", "kind": 2048, "kindString": "Method", @@ -8536,13 +9487,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 198, + "line": 213, "character": 2 } ], "signatures": [ { - "id": 105, + "id": 106, "name": "subscribe", "kind": 4096, "kindString": "Call signature", @@ -8552,7 +9503,7 @@ }, "parameters": [ { - "id": 106, + "id": 107, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -8562,49 +9513,33 @@ "type": { "type": "reflection", "declaration": { - "id": 107, + "id": 108, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 108, + "id": 109, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 109, + "id": 110, "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" - } - ] + "type": "reference", + "id": 628, + "name": "REALTIME_SUBSCRIBE_STATES" } }, { - "id": 110, + "id": 111, "name": "err", "kind": 32768, "kindString": "Parameter", @@ -8629,7 +9564,7 @@ } }, { - "id": 111, + "id": 112, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -8650,7 +9585,7 @@ ] }, { - "id": 119, + "id": 120, "name": "track", "kind": 2048, "kindString": "Method", @@ -8664,14 +9599,14 @@ ], "signatures": [ { - "id": 120, + "id": 121, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 121, + "id": 122, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -8679,20 +9614,20 @@ "type": { "type": "reflection", "declaration": { - "id": 122, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 123, + "id": 124, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 124, + "id": 125, "name": "key", "kind": 32768, "flags": {}, @@ -8711,7 +9646,7 @@ } }, { - "id": 125, + "id": 126, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -8719,20 +9654,20 @@ "type": { "type": "reflection", "declaration": { - "id": 126, + "id": 127, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 127, + "id": 128, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 128, + "id": 129, "name": "key", "kind": 32768, "flags": {}, @@ -8757,7 +9692,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -8769,7 +9704,7 @@ ] }, { - "id": 264, + "id": 277, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -8777,13 +9712,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 495, + "line": 507, "character": 2 } ], "signatures": [ { - "id": 265, + "id": 278, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -8794,7 +9729,7 @@ }, "parameters": [ { - "id": 266, + "id": 279, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -8835,7 +9770,7 @@ ] }, { - "id": 129, + "id": 130, "name": "untrack", "kind": 2048, "kindString": "Method", @@ -8849,14 +9784,14 @@ ], "signatures": [ { - "id": 130, + "id": 131, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 131, + "id": 132, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -8864,20 +9799,20 @@ "type": { "type": "reflection", "declaration": { - "id": 132, + "id": 133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 133, + "id": 134, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 134, + "id": 135, "name": "key", "kind": 32768, "flags": {}, @@ -8902,7 +9837,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -8914,7 +9849,7 @@ ] }, { - "id": 258, + "id": 271, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", @@ -8922,20 +9857,20 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 482, + "line": 494, "character": 2 } ], "signatures": [ { - "id": 259, + "id": 272, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 260, + "id": 273, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -8943,20 +9878,20 @@ "type": { "type": "reflection", "declaration": { - "id": 261, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 262, + "id": 275, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 263, + "id": 276, "name": "key", "kind": 32768, "flags": {}, @@ -8992,31 +9927,31 @@ { "title": "Properties", "kind": 1024, - "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] + "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] }, { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -9024,13 +9959,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -9040,7 +9975,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -9054,7 +9989,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -9063,10 +9998,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -9074,21 +10009,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -9098,7 +10033,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -9110,7 +10045,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -9120,7 +10055,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -9132,7 +10067,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -9142,7 +10077,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -9152,7 +10087,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -9162,14 +10097,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9177,19 +10112,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -9208,7 +10143,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -9218,7 +10153,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -9228,7 +10163,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -9238,7 +10173,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -9265,7 +10200,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -9275,7 +10210,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -9287,7 +10222,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -9297,14 +10232,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9312,19 +10247,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -9343,7 +10278,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -9353,7 +10288,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -9365,7 +10300,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -9375,7 +10310,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -9385,7 +10320,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -9395,7 +10330,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -9403,19 +10338,112 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493] + "children": [ + 520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, 532, 533 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -9427,14 +10455,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -9442,7 +10470,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -9462,7 +10554,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -9470,7 +10562,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -9490,7 +10582,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -9498,7 +10590,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -9513,7 +10605,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -9521,7 +10613,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -9541,7 +10633,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -9549,7 +10641,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -9561,7 +10653,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -9569,7 +10661,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -9581,7 +10673,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -9589,7 +10681,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -9600,7 +10692,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -9608,28 +10700,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -9653,7 +10745,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -9684,14 +10776,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -9719,7 +10811,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -9754,7 +10846,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -9764,27 +10856,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -9804,7 +10896,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -9812,7 +10904,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -9823,7 +10915,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -9831,7 +10923,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -9853,7 +10945,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -9861,7 +10972,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -9874,7 +10985,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -9884,27 +10995,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -9924,7 +11035,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -9932,7 +11043,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -9952,7 +11063,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -9960,7 +11071,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -9972,7 +11083,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -9980,7 +11091,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -9990,7 +11101,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -9998,7 +11109,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -10009,7 +11120,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -10017,7 +11128,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -10033,7 +11144,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -10041,7 +11152,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -10052,7 +11163,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -10060,21 +11171,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -10082,7 +11193,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -10097,7 +11208,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -10105,7 +11216,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -10120,7 +11231,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -10128,7 +11239,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -10143,7 +11254,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -10151,7 +11262,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -10170,7 +11281,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -10178,7 +11289,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -10186,7 +11297,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -10197,7 +11308,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -10205,7 +11316,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -10224,7 +11335,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -10232,20 +11456,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -10256,17 +11480,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -10274,21 +11498,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -10296,21 +11520,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -10323,21 +11547,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -10347,7 +11571,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -10357,7 +11581,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -10367,7 +11591,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -10381,13 +11605,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -10395,7 +11619,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -10408,21 +11632,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -10432,7 +11656,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -10446,31 +11670,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -10482,13 +11729,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -10508,7 +11755,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -10516,13 +11763,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -10538,7 +11785,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -10546,13 +11793,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -10568,7 +11815,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -10576,13 +11823,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -10592,7 +11839,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -10608,7 +11855,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -10632,7 +11879,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -10640,13 +11948,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -10666,7 +11974,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -10674,13 +11982,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -10696,7 +12004,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -10704,13 +12012,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -10721,7 +12029,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -10732,7 +12040,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -10743,7 +12051,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -10764,7 +12072,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -10772,13 +12080,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -10789,17 +12097,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -10807,21 +12115,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -10829,7 +12137,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -10839,7 +12147,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -10849,7 +12157,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -10859,7 +12167,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -10867,7 +12175,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -10877,7 +12185,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -10885,7 +12193,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -10895,7 +12203,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -10903,7 +12211,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -10917,13 +12225,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -10941,7 +12249,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -10949,13 +12257,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -10970,7 +12278,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -10983,7 +12291,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -10991,13 +12299,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -11007,7 +12315,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -11038,7 +12346,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 134, + "line": 147, "character": 2 } ], @@ -11069,10 +12377,10 @@ "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -11080,21 +12388,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -11102,21 +12410,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -11129,21 +12437,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -11153,7 +12461,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -11163,7 +12471,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -11173,7 +12481,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -11187,13 +12495,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -11201,7 +12509,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -11214,21 +12522,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -11238,7 +12546,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -11252,31 +12560,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -11288,13 +12619,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -11312,10 +12643,10 @@ "flags": {}, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", @@ -11325,28 +12656,30 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, - 383, 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, + 392, 380, 396, 385, 393, 399, 395, 394, 401, 402, 403, + 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, "children": [ - 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, + 436, 433, 457, 454 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -11371,7 +12704,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 116, + "line": 128, "character": 2 } ], @@ -11421,7 +12754,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 120, + "line": 132, "character": 6 } ], @@ -11441,7 +12774,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 6 } ], @@ -11456,7 +12789,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 14 } ], @@ -11497,7 +12830,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 121, + "line": 133, "character": 6 } ], @@ -11515,7 +12848,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 118, + "line": 130, "character": 6 } ], @@ -11535,7 +12868,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 117, + "line": 129, "character": 19 } ] @@ -11556,7 +12889,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 143, "character": 2 } ], @@ -11574,7 +12907,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 127, + "line": 139, "character": 2 } ], @@ -11592,7 +12925,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 126, + "line": 138, "character": 2 } ], @@ -11603,7 +12936,7 @@ "defaultValue": "false" }, { - "id": 102, + "id": 103, "name": "params", "kind": 1024, "kindString": "Property", @@ -11612,10 +12945,10 @@ }, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -11623,21 +12956,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -11645,21 +12978,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -11672,21 +13005,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -11696,7 +13029,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -11706,7 +13039,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -11716,7 +13049,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -11730,13 +13063,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -11744,7 +13077,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -11757,21 +13090,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -11781,7 +13114,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -11795,31 +13128,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -11831,13 +13187,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -11856,7 +13212,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 130, + "line": 142, "character": 2 } ], @@ -11908,7 +13264,7 @@ "type": "reference", "id": 64, "name": "default", - "dereferenced": "[Circular ~.children.5.children.32.signatures.0.parameters.0.type.dereferenced]" + "dereferenced": "[Circular ~.children.5.children.40.signatures.0.parameters.0.type.dereferenced]" } }, { @@ -12056,7 +13412,7 @@ "type": "reference", "id": 64, "name": "default", - "dereferenced": "[Circular ~.children.5.children.32.signatures.0.parameters.0.type.dereferenced]" + "dereferenced": "[Circular ~.children.5.children.40.signatures.0.parameters.0.type.dereferenced]" } }, { @@ -12124,7 +13480,7 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reflection", @@ -12139,7 +13495,7 @@ ], "name": "RealtimePresenceState", "dereferenced": { - "id": 578, + "id": 604, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", @@ -12153,7 +13509,7 @@ ], "typeParameter": [ { - "id": 586, + "id": 612, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -12161,7 +13517,7 @@ "type": { "type": "reflection", "declaration": { - "id": 582, + "id": 608, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -12174,14 +13530,14 @@ } ], "indexSignature": { - "id": 583, + "id": 609, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 584, + "id": 610, "name": "key", "kind": 32768, "flags": {}, @@ -12201,7 +13557,7 @@ "default": { "type": "reflection", "declaration": { - "id": 585, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -12220,7 +13576,7 @@ "type": { "type": "reflection", "declaration": { - "id": 579, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -12233,14 +13589,14 @@ } ], "indexSignature": { - "id": 580, + "id": 606, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 581, + "id": 607, "name": "key", "kind": 32768, "flags": {}, @@ -12257,7 +13613,7 @@ "typeArguments": [ { "type": "reference", - "id": 586, + "id": 612, "name": "T" } ], @@ -12294,6 +13650,24 @@ } } }, + { + "id": 101, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 97, "name": "pushBuffer", @@ -12303,7 +13677,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 141, "character": 2 } ], @@ -12325,7 +13699,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 140, "character": 2 } ], @@ -12335,7 +13709,7 @@ } }, { - "id": 103, + "id": 104, "name": "socket", "kind": 1024, "kindString": "Property", @@ -12344,10 +13718,10 @@ }, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", @@ -12357,28 +13731,30 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, - 380, 386, 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, + 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, + 421 ] }, { "title": "Methods", "kind": 2048, "children": [ - 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, + 457, 454 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -12394,7 +13770,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 125, + "line": 137, "character": 2 } ], @@ -12413,7 +13789,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 132, + "line": 144, "character": 2 } ], @@ -12431,7 +13807,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 124, + "line": 136, "character": 2 } ], @@ -12441,7 +13817,7 @@ } }, { - "id": 101, + "id": 102, "name": "topic", "kind": 1024, "kindString": "Property", @@ -12454,108 +13830,7 @@ } }, { - "id": 269, - "name": "_fetchWithTimeout", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 538, - "character": 8 - } - ], - "signatures": [ - { - "id": 270, - "name": "_fetchWithTimeout", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 271, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 272, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 273, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 274, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 275, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 276, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 135, + "id": 136, "name": "on", "kind": 2048, "kindString": "Method", @@ -12569,7 +13844,7 @@ ], "signatures": [ { - "id": 136, + "id": 137, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -12579,7 +13854,7 @@ }, "parameters": [ { - "id": 137, + "id": 138, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -12590,7 +13865,7 @@ } }, { - "id": 138, + "id": 139, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -12598,14 +13873,14 @@ "type": { "type": "reflection", "declaration": { - "id": 139, + "id": 140, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 140, + "id": 141, "name": "event", "kind": 1024, "kindString": "Property", @@ -12627,14 +13902,14 @@ { "title": "Properties", "kind": 1024, - "children": [140] + "children": [141] } ] } } }, { - "id": 141, + "id": 142, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -12642,14 +13917,14 @@ "type": { "type": "reflection", "declaration": { - "id": 142, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 143, + "id": 144, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -12671,14 +13946,14 @@ } }, { - "id": 144, + "id": 145, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 148, + "id": 149, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -12686,20 +13961,20 @@ "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 146, + "id": 147, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 147, + "id": 148, "name": "key", "kind": 32768, "flags": {}, @@ -12720,7 +13995,7 @@ ], "parameters": [ { - "id": 149, + "id": 150, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -12731,7 +14006,7 @@ } }, { - "id": 150, + "id": 151, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -12739,14 +14014,14 @@ "type": { "type": "reflection", "declaration": { - "id": 151, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 153, "name": "event", "kind": 1024, "kindString": "Property", @@ -12768,14 +14043,14 @@ { "title": "Properties", "kind": 1024, - "children": [152] + "children": [153] } ] } } }, { - "id": 153, + "id": 154, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -12783,32 +14058,32 @@ "type": { "type": "reflection", "declaration": { - "id": 154, + "id": 155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 155, + "id": 156, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 156, + "id": 157, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 558, + "id": 584, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 149, "name": "T" } ], @@ -12833,14 +14108,14 @@ } }, { - "id": 157, + "id": 158, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 161, + "id": 162, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -12848,20 +14123,20 @@ "type": { "type": "reflection", "declaration": { - "id": 158, + "id": 159, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 159, + "id": 160, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 160, + "id": 161, "name": "key", "kind": 32768, "flags": {}, @@ -12882,7 +14157,7 @@ ], "parameters": [ { - "id": 162, + "id": 163, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -12893,7 +14168,7 @@ } }, { - "id": 163, + "id": 164, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -12901,14 +14176,14 @@ "type": { "type": "reflection", "declaration": { - "id": 164, + "id": 165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 165, + "id": 166, "name": "event", "kind": 1024, "kindString": "Property", @@ -12930,14 +14205,14 @@ { "title": "Properties", "kind": 1024, - "children": [165] + "children": [166] } ] } } }, { - "id": 166, + "id": 167, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -12945,32 +14220,32 @@ "type": { "type": "reflection", "declaration": { - "id": 167, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 168, + "id": 169, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 169, + "id": 170, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 568, + "id": 594, "typeArguments": [ { "type": "reference", - "id": 161, + "id": 162, "name": "T" } ], @@ -12995,14 +14270,14 @@ } }, { - "id": 170, + "id": 171, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 174, + "id": 175, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -13010,20 +14285,20 @@ "type": { "type": "reflection", "declaration": { - "id": 171, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 172, + "id": 173, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 173, + "id": 174, "name": "key", "kind": 32768, "flags": {}, @@ -13044,7 +14319,7 @@ ], "parameters": [ { - "id": 175, + "id": 176, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -13055,14 +14330,14 @@ } }, { - "id": 176, + "id": 177, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -13071,7 +14346,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -13079,13 +14354,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -13097,7 +14372,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -13109,14 +14384,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -13127,19 +14402,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -13152,7 +14427,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -13162,7 +14437,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -13173,7 +14448,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -13183,7 +14458,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -13196,7 +14471,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -13210,13 +14485,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -13226,7 +14501,7 @@ } }, { - "id": 177, + "id": 178, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -13234,32 +14509,32 @@ "type": { "type": "reflection", "declaration": { - "id": 178, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 179, + "id": 180, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 180, + "id": 181, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 524, + "id": 550, "typeArguments": [ { "type": "reference", - "id": 174, + "id": 175, "name": "T" } ], @@ -13284,14 +14559,14 @@ } }, { - "id": 181, + "id": 182, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 185, + "id": 186, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -13299,20 +14574,20 @@ "type": { "type": "reflection", "declaration": { - "id": 182, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 183, + "id": 184, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 184, + "id": 185, "name": "key", "kind": 32768, "flags": {}, @@ -13333,7 +14608,7 @@ ], "parameters": [ { - "id": 186, + "id": 187, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -13344,14 +14619,14 @@ } }, { - "id": 187, + "id": 188, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -13360,7 +14635,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -13368,13 +14643,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -13386,7 +14661,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -13398,14 +14673,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -13416,19 +14691,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -13441,7 +14716,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -13451,7 +14726,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -13462,7 +14737,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -13472,7 +14747,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -13485,7 +14760,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -13499,13 +14774,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -13515,7 +14790,7 @@ } }, { - "id": 188, + "id": 189, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -13523,32 +14798,32 @@ "type": { "type": "reflection", "declaration": { - "id": 189, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 190, + "id": 191, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 191, + "id": 192, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 529, + "id": 555, "typeArguments": [ { "type": "reference", - "id": 185, + "id": 186, "name": "T" } ], @@ -13573,14 +14848,14 @@ } }, { - "id": 192, + "id": 193, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 196, + "id": 197, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -13588,20 +14863,20 @@ "type": { "type": "reflection", "declaration": { - "id": 193, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 194, + "id": 195, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 196, "name": "key", "kind": 32768, "flags": {}, @@ -13622,7 +14897,7 @@ ], "parameters": [ { - "id": 197, + "id": 198, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -13633,14 +14908,14 @@ } }, { - "id": 198, + "id": 199, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -13649,7 +14924,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -13657,13 +14932,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -13675,7 +14950,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -13687,14 +14962,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -13705,19 +14980,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -13730,7 +15005,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -13740,7 +15015,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -13751,7 +15026,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -13761,7 +15036,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -13774,7 +15049,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -13788,13 +15063,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -13804,7 +15079,7 @@ } }, { - "id": 199, + "id": 200, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -13812,32 +15087,32 @@ "type": { "type": "reflection", "declaration": { - "id": 200, + "id": 201, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 201, + "id": 202, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 202, + "id": 203, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 539, + "id": 565, "typeArguments": [ { "type": "reference", - "id": 196, + "id": 197, "name": "T" } ], @@ -13862,14 +15137,14 @@ } }, { - "id": 203, + "id": 204, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 207, + "id": 208, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -13877,20 +15152,20 @@ "type": { "type": "reflection", "declaration": { - "id": 204, + "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 205, + "id": 206, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 206, + "id": 207, "name": "key", "kind": 32768, "flags": {}, @@ -13911,7 +15186,7 @@ ], "parameters": [ { - "id": 208, + "id": 209, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -13922,14 +15197,14 @@ } }, { - "id": 209, + "id": 210, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -13938,7 +15213,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -13946,13 +15221,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -13964,7 +15239,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -13976,14 +15251,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -13994,19 +15269,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -14019,7 +15294,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -14029,7 +15304,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -14040,7 +15315,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -14050,7 +15325,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -14063,7 +15338,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -14077,13 +15352,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -14093,7 +15368,7 @@ } }, { - "id": 210, + "id": 211, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -14101,32 +15376,32 @@ "type": { "type": "reflection", "declaration": { - "id": 211, + "id": 212, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 212, + "id": 213, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 213, + "id": 214, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 548, + "id": 574, "typeArguments": [ { "type": "reference", - "id": 207, + "id": 208, "name": "T" } ], @@ -14151,7 +15426,7 @@ } }, { - "id": 214, + "id": 215, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -14161,7 +15436,7 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -14175,7 +15450,7 @@ } }, { - "id": 216, + "id": 217, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -14186,14 +15461,14 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 218, + "id": 219, "name": "event", "kind": 1024, "kindString": "Property", @@ -14215,14 +15490,14 @@ { "title": "Properties", "kind": 1024, - "children": [218] + "children": [219] } ] } } }, { - "id": 219, + "id": 220, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -14233,21 +15508,21 @@ "type": { "type": "reflection", "declaration": { - "id": 220, + "id": 221, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 221, + "id": 222, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 222, + "id": 223, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -14255,14 +15530,14 @@ "type": { "type": "reflection", "declaration": { - "id": 223, + "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 226, "name": "event", "kind": 1024, "kindString": "Property", @@ -14280,7 +15555,7 @@ } }, { - "id": 224, + "id": 225, "name": "type", "kind": 1024, "kindString": "Property", @@ -14302,18 +15577,18 @@ { "title": "Properties", "kind": 1024, - "children": [225, 224] + "children": [226, 225] } ], "indexSignature": { - "id": 226, + "id": 227, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 227, + "id": 228, "name": "key", "kind": 32768, "flags": {}, @@ -14349,14 +15624,14 @@ } }, { - "id": 228, + "id": 229, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 232, + "id": 233, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -14364,20 +15639,20 @@ "type": { "type": "reflection", "declaration": { - "id": 229, + "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 230, + "id": 231, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 231, + "id": 232, "name": "key", "kind": 32768, "flags": {}, @@ -14398,7 +15673,7 @@ ], "parameters": [ { - "id": 233, + "id": 234, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -14409,7 +15684,7 @@ } }, { - "id": 234, + "id": 235, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -14417,14 +15692,14 @@ "type": { "type": "reflection", "declaration": { - "id": 235, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 236, + "id": 237, "name": "event", "kind": 1024, "kindString": "Property", @@ -14446,14 +15721,14 @@ { "title": "Properties", "kind": 1024, - "children": [236] + "children": [237] } ] } } }, { - "id": 237, + "id": 238, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -14461,21 +15736,21 @@ "type": { "type": "reflection", "declaration": { - "id": 238, + "id": 239, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 239, + "id": 240, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 240, + "id": 241, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -14483,14 +15758,14 @@ "type": { "type": "reflection", "declaration": { - "id": 241, + "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 243, + "id": 244, "name": "event", "kind": 1024, "kindString": "Property", @@ -14508,7 +15783,7 @@ } }, { - "id": 244, + "id": 245, "name": "payload", "kind": 1024, "kindString": "Property", @@ -14522,12 +15797,12 @@ ], "type": { "type": "reference", - "id": 232, + "id": 233, "name": "T" } }, { - "id": 242, + "id": 243, "name": "type", "kind": 1024, "kindString": "Property", @@ -14549,7 +15824,7 @@ { "title": "Properties", "kind": 1024, - "children": [243, 244, 242] + "children": [244, 245, 243] } ] } @@ -14571,11 +15846,138 @@ "id": 64, "name": "default" } + }, + { + "id": 246, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 250, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 247, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 248, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 249, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 251, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "system" + } + }, + { + "id": 252, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 253, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 254, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 255, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 256, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 257, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } } ] }, { - "id": 112, + "id": 113, "name": "presenceState", "kind": 2048, "kindString": "Method", @@ -14589,14 +15991,14 @@ ], "signatures": [ { - "id": 113, + "id": 114, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 118, + "id": 119, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -14604,20 +16006,20 @@ "type": { "type": "reflection", "declaration": { - "id": 114, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 115, + "id": 116, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 116, + "id": 117, "name": "key", "kind": 32768, "flags": {}, @@ -14637,7 +16039,7 @@ "default": { "type": "reflection", "declaration": { - "id": 117, + "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -14648,11 +16050,11 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reference", - "id": 118, + "id": 119, "name": "T" } ], @@ -14662,7 +16064,7 @@ ] }, { - "id": 245, + "id": 258, "name": "send", "kind": 2048, "kindString": "Method", @@ -14670,13 +16072,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 425, + "line": 430, "character": 8 } ], "signatures": [ { - "id": 246, + "id": 259, "name": "send", "kind": 4096, "kindString": "Call signature", @@ -14686,7 +16088,7 @@ }, "parameters": [ { - "id": 247, + "id": 260, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -14697,14 +16099,14 @@ "type": { "type": "reflection", "declaration": { - "id": 248, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 263, "name": "event", "kind": 1024, "kindString": "Property", @@ -14715,7 +16117,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 428, + "line": 433, "character": 6 } ], @@ -14725,7 +16127,7 @@ } }, { - "id": 251, + "id": 264, "name": "payload", "kind": 1024, "kindString": "Property", @@ -14738,7 +16140,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 429, + "line": 434, "character": 6 } ], @@ -14748,7 +16150,7 @@ } }, { - "id": 249, + "id": 262, "name": "type", "kind": 1024, "kindString": "Property", @@ -14759,7 +16161,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 427, + "line": 432, "character": 6 } ], @@ -14786,18 +16188,18 @@ { "title": "Properties", "kind": 1024, - "children": [250, 251, 249] + "children": [263, 264, 262] } ], "indexSignature": { - "id": 252, + "id": 265, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 253, + "id": 266, "name": "key", "kind": 32768, "flags": {}, @@ -14816,7 +16218,7 @@ } }, { - "id": 254, + "id": 267, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -14827,20 +16229,20 @@ "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 256, + "id": 269, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 257, + "id": 270, "name": "key", "kind": 32768, "flags": {}, @@ -14865,7 +16267,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -14877,7 +16279,7 @@ ] }, { - "id": 104, + "id": 105, "name": "subscribe", "kind": 2048, "kindString": "Method", @@ -14885,13 +16287,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 198, + "line": 213, "character": 2 } ], "signatures": [ { - "id": 105, + "id": 106, "name": "subscribe", "kind": 4096, "kindString": "Call signature", @@ -14901,7 +16303,7 @@ }, "parameters": [ { - "id": 106, + "id": 107, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -14911,49 +16313,33 @@ "type": { "type": "reflection", "declaration": { - "id": 107, + "id": 108, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 108, + "id": 109, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 109, + "id": 110, "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" - } - ] + "type": "reference", + "id": 628, + "name": "REALTIME_SUBSCRIBE_STATES" } }, { - "id": 110, + "id": 111, "name": "err", "kind": 32768, "kindString": "Parameter", @@ -14978,7 +16364,7 @@ } }, { - "id": 111, + "id": 112, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -14999,7 +16385,7 @@ ] }, { - "id": 119, + "id": 120, "name": "track", "kind": 2048, "kindString": "Method", @@ -15013,14 +16399,14 @@ ], "signatures": [ { - "id": 120, + "id": 121, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 121, + "id": 122, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -15028,20 +16414,20 @@ "type": { "type": "reflection", "declaration": { - "id": 122, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 123, + "id": 124, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 124, + "id": 125, "name": "key", "kind": 32768, "flags": {}, @@ -15060,7 +16446,7 @@ } }, { - "id": 125, + "id": 126, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -15068,20 +16454,20 @@ "type": { "type": "reflection", "declaration": { - "id": 126, + "id": 127, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 127, + "id": 128, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 128, + "id": 129, "name": "key", "kind": 32768, "flags": {}, @@ -15106,7 +16492,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -15118,7 +16504,7 @@ ] }, { - "id": 264, + "id": 277, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -15126,13 +16512,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 495, + "line": 507, "character": 2 } ], "signatures": [ { - "id": 265, + "id": 278, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -15143,7 +16529,7 @@ }, "parameters": [ { - "id": 266, + "id": 279, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -15184,7 +16570,7 @@ ] }, { - "id": 129, + "id": 130, "name": "untrack", "kind": 2048, "kindString": "Method", @@ -15198,14 +16584,14 @@ ], "signatures": [ { - "id": 130, + "id": 131, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 131, + "id": 132, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -15213,20 +16599,20 @@ "type": { "type": "reflection", "declaration": { - "id": 132, + "id": 133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 133, + "id": 134, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 134, + "id": 135, "name": "key", "kind": 32768, "flags": {}, @@ -15251,7 +16637,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -15263,7 +16649,7 @@ ] }, { - "id": 258, + "id": 271, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", @@ -15271,20 +16657,20 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 482, + "line": 494, "character": 2 } ], "signatures": [ { - "id": 259, + "id": 272, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 260, + "id": 273, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -15292,20 +16678,20 @@ "type": { "type": "reflection", "declaration": { - "id": 261, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 262, + "id": 275, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 263, + "id": 276, "name": "key", "kind": 32768, "flags": {}, @@ -15341,18 +16727,18 @@ { "title": "Properties", "kind": 1024, - "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] + "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -15365,7 +16751,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -15377,7 +16763,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -15385,29 +16809,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -15421,12 +16846,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -15436,26 +16870,26 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, 386, 382, 381, - 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, 385, 393, 399, + 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, - "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] + "children": [510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, 454] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -15523,7 +16957,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 134, + "line": 147, "character": 2 } ], @@ -15554,10 +16988,10 @@ "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -15565,21 +16999,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -15587,21 +17021,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -15614,21 +17048,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -15638,7 +17072,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -15648,7 +17082,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -15658,7 +17092,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -15672,13 +17106,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -15686,7 +17120,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -15699,21 +17133,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -15723,7 +17157,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -15737,31 +17171,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -15773,13 +17230,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -15797,17 +17254,17 @@ "flags": {}, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -15815,13 +17272,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -15831,7 +17288,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -15845,7 +17302,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -15854,10 +17311,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -15865,21 +17322,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -15889,7 +17346,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -15901,7 +17358,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -15911,7 +17368,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -15923,7 +17380,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -15933,7 +17390,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -15943,7 +17400,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -15953,14 +17410,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -15968,19 +17425,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -15999,7 +17456,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -16009,7 +17466,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -16019,7 +17476,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -16029,7 +17486,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -16056,7 +17513,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -16066,7 +17523,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -16078,7 +17535,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -16088,14 +17545,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -16103,19 +17560,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -16134,7 +17591,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -16144,7 +17601,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -16156,7 +17613,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -16166,7 +17623,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -16176,7 +17633,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -16186,7 +17643,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -16194,6 +17651,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -16201,15 +17744,20 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, 496, - 504, 499, 494, 493 + 520, 519, 531, 522, 517, 530, 518, + 526, 521, 516, 515, 532, 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -16221,14 +17769,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -16236,7 +17784,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -16256,7 +17868,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -16264,7 +17876,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -16284,7 +17896,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -16292,7 +17904,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -16307,7 +17919,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -16315,7 +17927,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -16335,7 +17947,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -16343,7 +17955,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -16355,7 +17967,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -16363,7 +17975,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -16375,7 +17987,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -16383,7 +17995,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -16394,7 +18006,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -16402,28 +18014,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -16447,7 +18059,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -16478,14 +18090,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -16513,7 +18125,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -16548,7 +18160,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -16558,27 +18170,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -16598,7 +18210,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -16606,7 +18218,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -16617,7 +18229,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -16625,7 +18237,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -16647,7 +18259,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -16655,7 +18286,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -16668,7 +18299,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -16678,27 +18309,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -16718,7 +18349,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -16726,7 +18357,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -16746,7 +18377,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -16754,7 +18385,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -16766,7 +18397,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -16774,7 +18405,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -16784,7 +18415,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -16792,7 +18423,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -16803,7 +18434,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -16811,7 +18442,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -16827,7 +18458,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -16835,7 +18466,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -16846,7 +18477,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -16854,21 +18485,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -16876,7 +18507,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -16891,7 +18522,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -16899,7 +18530,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -16914,7 +18545,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -16922,7 +18553,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -16937,7 +18568,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -16945,7 +18576,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -16964,7 +18595,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -16972,7 +18603,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -16980,7 +18611,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -16991,7 +18622,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -16999,7 +18630,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -17018,7 +18649,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -17026,20 +18770,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -17050,17 +18794,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -17068,21 +18812,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -17090,21 +18834,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -17117,21 +18861,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -17141,7 +18885,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -17151,7 +18895,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -17161,7 +18905,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -17175,13 +18919,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -17189,7 +18933,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -17202,21 +18946,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -17226,7 +18970,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -17240,31 +18984,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -17276,13 +19043,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -17302,7 +19069,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -17310,13 +19077,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -17332,7 +19099,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -17340,13 +19107,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -17362,7 +19129,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -17370,13 +19137,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -17386,7 +19153,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -17402,7 +19169,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -17426,7 +19193,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -17434,13 +19262,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -17460,7 +19288,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -17468,13 +19296,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -17490,7 +19318,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -17498,13 +19326,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -17515,7 +19343,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -17526,7 +19354,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -17537,7 +19365,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -17558,7 +19386,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -17566,13 +19394,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -17583,17 +19411,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -17601,21 +19429,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -17623,7 +19451,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -17633,7 +19461,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -17643,7 +19471,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -17653,7 +19481,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -17661,7 +19489,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -17671,7 +19499,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -17679,7 +19507,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -17689,7 +19517,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -17697,7 +19525,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -17711,13 +19539,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -17735,7 +19563,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -17743,13 +19571,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -17764,7 +19592,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -17777,7 +19605,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -17785,13 +19613,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -17801,7 +19629,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -17822,7 +19650,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -17834,7 +19662,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -17842,29 +19708,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -17878,12 +19745,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -17893,28 +19769,30 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, - 383, 372, 380, 386, 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, + 392, 380, 396, 385, 393, 399, 395, 394, 401, 402, 403, + 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, "children": [ - 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, + 436, 433, 457, 454 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -17939,7 +19817,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 116, + "line": 128, "character": 2 } ], @@ -17989,7 +19867,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 120, + "line": 132, "character": 6 } ], @@ -18009,7 +19887,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 6 } ], @@ -18024,7 +19902,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 14 } ], @@ -18065,7 +19943,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 121, + "line": 133, "character": 6 } ], @@ -18083,7 +19961,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 118, + "line": 130, "character": 6 } ], @@ -18103,7 +19981,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 117, + "line": 129, "character": 19 } ] @@ -18124,7 +20002,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 143, "character": 2 } ], @@ -18142,7 +20020,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 127, + "line": 139, "character": 2 } ], @@ -18160,7 +20038,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 126, + "line": 138, "character": 2 } ], @@ -18171,7 +20049,7 @@ "defaultValue": "false" }, { - "id": 102, + "id": 103, "name": "params", "kind": 1024, "kindString": "Property", @@ -18180,10 +20058,10 @@ }, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -18191,21 +20069,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -18213,21 +20091,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -18240,21 +20118,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -18264,7 +20142,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -18274,7 +20152,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -18284,7 +20162,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -18298,13 +20176,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -18312,7 +20190,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -18325,21 +20203,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -18349,7 +20227,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -18363,31 +20241,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -18399,13 +20300,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -18424,7 +20325,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 130, + "line": 142, "character": 2 } ], @@ -18461,6 +20362,24 @@ } } }, + { + "id": 101, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 97, "name": "pushBuffer", @@ -18470,7 +20389,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 141, "character": 2 } ], @@ -18492,7 +20411,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 140, "character": 2 } ], @@ -18502,7 +20421,7 @@ } }, { - "id": 103, + "id": 104, "name": "socket", "kind": 1024, "kindString": "Property", @@ -18511,17 +20430,17 @@ }, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -18529,13 +20448,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -18545,7 +20464,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -18559,7 +20478,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -18568,10 +20487,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -18579,21 +20498,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -18603,7 +20522,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -18615,7 +20534,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -18625,7 +20544,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -18637,7 +20556,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -18647,7 +20566,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -18657,7 +20576,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -18667,14 +20586,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -18682,19 +20601,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -18713,7 +20632,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -18723,7 +20642,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -18733,7 +20652,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -18743,7 +20662,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -18770,7 +20689,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -18780,7 +20699,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -18792,7 +20711,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -18802,14 +20721,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -18817,19 +20736,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -18848,7 +20767,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -18858,7 +20777,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -18870,7 +20789,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -18880,7 +20799,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -18890,7 +20809,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -18900,7 +20819,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -18908,6 +20827,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -18915,15 +20920,20 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, 496, 504, 499, - 494, 493 + 520, 519, 531, 522, 517, 530, 518, 526, 521, + 516, 515, 532, 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -18935,14 +20945,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -18950,7 +20960,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -18970,7 +21044,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -18978,7 +21052,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -18998,7 +21072,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -19006,7 +21080,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -19021,7 +21095,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -19029,7 +21103,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -19049,7 +21123,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -19057,7 +21131,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -19069,7 +21143,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -19077,7 +21151,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -19089,7 +21163,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -19097,7 +21171,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -19108,7 +21182,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -19116,28 +21190,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -19161,7 +21235,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -19192,14 +21266,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -19227,7 +21301,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -19262,7 +21336,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -19272,27 +21346,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -19312,7 +21386,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -19320,7 +21394,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -19331,7 +21405,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -19339,7 +21413,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -19361,7 +21435,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -19369,7 +21462,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -19382,7 +21475,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -19392,27 +21485,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -19432,7 +21525,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -19440,7 +21533,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -19460,7 +21553,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -19468,7 +21561,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -19480,7 +21573,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -19488,7 +21581,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -19498,7 +21591,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -19506,7 +21599,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -19517,7 +21610,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -19525,7 +21618,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -19541,7 +21634,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -19549,7 +21642,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -19560,7 +21653,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -19568,21 +21661,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -19590,7 +21683,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -19605,7 +21698,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -19613,7 +21706,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -19628,7 +21721,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -19636,7 +21729,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -19651,7 +21744,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -19659,7 +21752,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -19678,7 +21771,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -19686,7 +21779,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -19694,7 +21787,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -19705,7 +21798,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -19713,7 +21806,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -19732,7 +21825,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -19740,20 +21946,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -19764,17 +21970,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -19782,21 +21988,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -19804,21 +22010,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -19831,21 +22037,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -19855,7 +22061,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -19865,7 +22071,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -19875,7 +22081,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -19889,13 +22095,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -19903,7 +22109,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -19916,21 +22122,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -19940,7 +22146,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -19954,31 +22160,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -19990,13 +22219,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -20016,7 +22245,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -20024,13 +22253,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -20046,7 +22275,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -20054,13 +22283,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -20076,7 +22305,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -20084,13 +22313,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -20100,7 +22329,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -20116,7 +22345,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -20140,7 +22369,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -20148,13 +22438,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -20174,7 +22464,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -20182,13 +22472,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -20204,7 +22494,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -20212,13 +22502,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -20229,7 +22519,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -20240,7 +22530,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -20251,7 +22541,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -20272,7 +22562,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -20280,13 +22570,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -20297,17 +22587,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -20315,21 +22605,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -20337,7 +22627,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -20347,7 +22637,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -20357,7 +22647,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -20367,7 +22657,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -20375,7 +22665,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -20385,7 +22675,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -20393,7 +22683,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -20403,7 +22693,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -20411,7 +22701,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -20425,13 +22715,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -20449,7 +22739,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -20457,13 +22747,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -20478,7 +22768,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -20491,7 +22781,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -20499,13 +22789,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -20515,7 +22805,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -20536,7 +22826,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -20548,7 +22838,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -20556,29 +22884,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -20592,12 +22921,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -20607,28 +22945,30 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, - 380, 386, 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, + 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, + 421 ] }, { "title": "Methods", "kind": 2048, "children": [ - 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, + 457, 454 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -20644,7 +22984,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 125, + "line": 137, "character": 2 } ], @@ -20663,7 +23003,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 132, + "line": 144, "character": 2 } ], @@ -20681,7 +23021,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 124, + "line": 136, "character": 2 } ], @@ -20691,7 +23031,7 @@ } }, { - "id": 101, + "id": 102, "name": "topic", "kind": 1024, "kindString": "Property", @@ -20704,108 +23044,7 @@ } }, { - "id": 269, - "name": "_fetchWithTimeout", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 538, - "character": 8 - } - ], - "signatures": [ - { - "id": 270, - "name": "_fetchWithTimeout", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 271, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 272, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 273, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 274, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 275, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 276, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 135, + "id": 136, "name": "on", "kind": 2048, "kindString": "Method", @@ -20819,7 +23058,7 @@ ], "signatures": [ { - "id": 136, + "id": 137, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -20829,7 +23068,7 @@ }, "parameters": [ { - "id": 137, + "id": 138, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -20840,7 +23079,7 @@ } }, { - "id": 138, + "id": 139, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -20848,14 +23087,14 @@ "type": { "type": "reflection", "declaration": { - "id": 139, + "id": 140, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 140, + "id": 141, "name": "event", "kind": 1024, "kindString": "Property", @@ -20877,14 +23116,14 @@ { "title": "Properties", "kind": 1024, - "children": [140] + "children": [141] } ] } } }, { - "id": 141, + "id": 142, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -20892,14 +23131,14 @@ "type": { "type": "reflection", "declaration": { - "id": 142, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 143, + "id": 144, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -20921,14 +23160,14 @@ } }, { - "id": 144, + "id": 145, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 148, + "id": 149, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -20936,20 +23175,20 @@ "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 146, + "id": 147, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 147, + "id": 148, "name": "key", "kind": 32768, "flags": {}, @@ -20970,7 +23209,7 @@ ], "parameters": [ { - "id": 149, + "id": 150, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -20981,7 +23220,7 @@ } }, { - "id": 150, + "id": 151, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -20989,14 +23228,14 @@ "type": { "type": "reflection", "declaration": { - "id": 151, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 153, "name": "event", "kind": 1024, "kindString": "Property", @@ -21018,14 +23257,14 @@ { "title": "Properties", "kind": 1024, - "children": [152] + "children": [153] } ] } } }, { - "id": 153, + "id": 154, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -21033,32 +23272,32 @@ "type": { "type": "reflection", "declaration": { - "id": 154, + "id": 155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 155, + "id": 156, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 156, + "id": 157, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 558, + "id": 584, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 149, "name": "T" } ], @@ -21083,14 +23322,14 @@ } }, { - "id": 157, + "id": 158, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 161, + "id": 162, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -21098,20 +23337,20 @@ "type": { "type": "reflection", "declaration": { - "id": 158, + "id": 159, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 159, + "id": 160, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 160, + "id": 161, "name": "key", "kind": 32768, "flags": {}, @@ -21132,7 +23371,7 @@ ], "parameters": [ { - "id": 162, + "id": 163, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -21143,7 +23382,7 @@ } }, { - "id": 163, + "id": 164, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -21151,14 +23390,14 @@ "type": { "type": "reflection", "declaration": { - "id": 164, + "id": 165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 165, + "id": 166, "name": "event", "kind": 1024, "kindString": "Property", @@ -21180,14 +23419,14 @@ { "title": "Properties", "kind": 1024, - "children": [165] + "children": [166] } ] } } }, { - "id": 166, + "id": 167, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -21195,32 +23434,32 @@ "type": { "type": "reflection", "declaration": { - "id": 167, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 168, + "id": 169, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 169, + "id": 170, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 568, + "id": 594, "typeArguments": [ { "type": "reference", - "id": 161, + "id": 162, "name": "T" } ], @@ -21245,14 +23484,14 @@ } }, { - "id": 170, + "id": 171, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 174, + "id": 175, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -21260,20 +23499,20 @@ "type": { "type": "reflection", "declaration": { - "id": 171, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 172, + "id": 173, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 173, + "id": 174, "name": "key", "kind": 32768, "flags": {}, @@ -21294,7 +23533,7 @@ ], "parameters": [ { - "id": 175, + "id": 176, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -21305,14 +23544,14 @@ } }, { - "id": 176, + "id": 177, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -21321,7 +23560,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -21329,13 +23568,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -21347,7 +23586,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -21359,14 +23598,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -21377,19 +23616,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -21402,7 +23641,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -21412,7 +23651,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -21423,7 +23662,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -21433,7 +23672,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -21446,7 +23685,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -21460,13 +23699,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -21476,7 +23715,7 @@ } }, { - "id": 177, + "id": 178, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -21484,32 +23723,32 @@ "type": { "type": "reflection", "declaration": { - "id": 178, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 179, + "id": 180, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 180, + "id": 181, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 524, + "id": 550, "typeArguments": [ { "type": "reference", - "id": 174, + "id": 175, "name": "T" } ], @@ -21534,14 +23773,14 @@ } }, { - "id": 181, + "id": 182, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 185, + "id": 186, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -21549,20 +23788,20 @@ "type": { "type": "reflection", "declaration": { - "id": 182, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 183, + "id": 184, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 184, + "id": 185, "name": "key", "kind": 32768, "flags": {}, @@ -21583,7 +23822,7 @@ ], "parameters": [ { - "id": 186, + "id": 187, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -21594,14 +23833,14 @@ } }, { - "id": 187, + "id": 188, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -21610,7 +23849,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -21618,13 +23857,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -21636,7 +23875,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -21648,14 +23887,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -21666,19 +23905,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -21691,7 +23930,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -21701,7 +23940,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -21712,7 +23951,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -21722,7 +23961,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -21735,7 +23974,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -21749,13 +23988,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -21765,7 +24004,7 @@ } }, { - "id": 188, + "id": 189, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -21773,32 +24012,32 @@ "type": { "type": "reflection", "declaration": { - "id": 189, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 190, + "id": 191, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 191, + "id": 192, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 529, + "id": 555, "typeArguments": [ { "type": "reference", - "id": 185, + "id": 186, "name": "T" } ], @@ -21823,14 +24062,14 @@ } }, { - "id": 192, + "id": 193, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 196, + "id": 197, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -21838,20 +24077,20 @@ "type": { "type": "reflection", "declaration": { - "id": 193, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 194, + "id": 195, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 196, "name": "key", "kind": 32768, "flags": {}, @@ -21872,7 +24111,7 @@ ], "parameters": [ { - "id": 197, + "id": 198, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -21883,14 +24122,14 @@ } }, { - "id": 198, + "id": 199, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -21899,7 +24138,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -21907,13 +24146,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -21925,7 +24164,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -21937,14 +24176,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -21955,19 +24194,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -21980,7 +24219,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -21990,7 +24229,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -22001,7 +24240,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -22011,7 +24250,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -22024,7 +24263,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -22038,13 +24277,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -22054,7 +24293,7 @@ } }, { - "id": 199, + "id": 200, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -22062,32 +24301,32 @@ "type": { "type": "reflection", "declaration": { - "id": 200, + "id": 201, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 201, + "id": 202, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 202, + "id": 203, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 539, + "id": 565, "typeArguments": [ { "type": "reference", - "id": 196, + "id": 197, "name": "T" } ], @@ -22112,14 +24351,14 @@ } }, { - "id": 203, + "id": 204, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 207, + "id": 208, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -22127,20 +24366,20 @@ "type": { "type": "reflection", "declaration": { - "id": 204, + "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 205, + "id": 206, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 206, + "id": 207, "name": "key", "kind": 32768, "flags": {}, @@ -22161,7 +24400,7 @@ ], "parameters": [ { - "id": 208, + "id": 209, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -22172,14 +24411,14 @@ } }, { - "id": 209, + "id": 210, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -22188,7 +24427,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -22196,13 +24435,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -22214,7 +24453,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -22226,14 +24465,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -22244,19 +24483,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -22269,7 +24508,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -22279,7 +24518,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -22290,7 +24529,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -22300,7 +24539,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -22313,7 +24552,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -22327,13 +24566,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -22343,7 +24582,7 @@ } }, { - "id": 210, + "id": 211, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -22351,32 +24590,32 @@ "type": { "type": "reflection", "declaration": { - "id": 211, + "id": 212, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 212, + "id": 213, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 213, + "id": 214, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 548, + "id": 574, "typeArguments": [ { "type": "reference", - "id": 207, + "id": 208, "name": "T" } ], @@ -22401,7 +24640,7 @@ } }, { - "id": 214, + "id": 215, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -22411,7 +24650,7 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -22425,7 +24664,7 @@ } }, { - "id": 216, + "id": 217, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -22436,14 +24675,14 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 218, + "id": 219, "name": "event", "kind": 1024, "kindString": "Property", @@ -22465,14 +24704,14 @@ { "title": "Properties", "kind": 1024, - "children": [218] + "children": [219] } ] } } }, { - "id": 219, + "id": 220, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -22483,21 +24722,21 @@ "type": { "type": "reflection", "declaration": { - "id": 220, + "id": 221, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 221, + "id": 222, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 222, + "id": 223, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -22505,14 +24744,14 @@ "type": { "type": "reflection", "declaration": { - "id": 223, + "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 226, "name": "event", "kind": 1024, "kindString": "Property", @@ -22530,7 +24769,7 @@ } }, { - "id": 224, + "id": 225, "name": "type", "kind": 1024, "kindString": "Property", @@ -22552,18 +24791,18 @@ { "title": "Properties", "kind": 1024, - "children": [225, 224] + "children": [226, 225] } ], "indexSignature": { - "id": 226, + "id": 227, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 227, + "id": 228, "name": "key", "kind": 32768, "flags": {}, @@ -22599,14 +24838,14 @@ } }, { - "id": 228, + "id": 229, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 232, + "id": 233, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -22614,20 +24853,20 @@ "type": { "type": "reflection", "declaration": { - "id": 229, + "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 230, + "id": 231, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 231, + "id": 232, "name": "key", "kind": 32768, "flags": {}, @@ -22648,7 +24887,7 @@ ], "parameters": [ { - "id": 233, + "id": 234, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -22659,7 +24898,7 @@ } }, { - "id": 234, + "id": 235, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -22667,14 +24906,14 @@ "type": { "type": "reflection", "declaration": { - "id": 235, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 236, + "id": 237, "name": "event", "kind": 1024, "kindString": "Property", @@ -22696,14 +24935,14 @@ { "title": "Properties", "kind": 1024, - "children": [236] + "children": [237] } ] } } }, { - "id": 237, + "id": 238, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -22711,21 +24950,21 @@ "type": { "type": "reflection", "declaration": { - "id": 238, + "id": 239, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 239, + "id": 240, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 240, + "id": 241, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -22733,14 +24972,14 @@ "type": { "type": "reflection", "declaration": { - "id": 241, + "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 243, + "id": 244, "name": "event", "kind": 1024, "kindString": "Property", @@ -22758,7 +24997,7 @@ } }, { - "id": 244, + "id": 245, "name": "payload", "kind": 1024, "kindString": "Property", @@ -22772,12 +25011,12 @@ ], "type": { "type": "reference", - "id": 232, + "id": 233, "name": "T" } }, { - "id": 242, + "id": 243, "name": "type", "kind": 1024, "kindString": "Property", @@ -22799,7 +25038,7 @@ { "title": "Properties", "kind": 1024, - "children": [243, 244, 242] + "children": [244, 245, 243] } ] } @@ -22821,11 +25060,138 @@ "id": 64, "name": "default" } + }, + { + "id": 246, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 250, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 247, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 248, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 249, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 251, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "system" + } + }, + { + "id": 252, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 253, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 254, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 255, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 256, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 257, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } } ] }, { - "id": 112, + "id": 113, "name": "presenceState", "kind": 2048, "kindString": "Method", @@ -22839,14 +25205,14 @@ ], "signatures": [ { - "id": 113, + "id": 114, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 118, + "id": 119, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -22854,20 +25220,20 @@ "type": { "type": "reflection", "declaration": { - "id": 114, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 115, + "id": 116, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 116, + "id": 117, "name": "key", "kind": 32768, "flags": {}, @@ -22887,7 +25253,7 @@ "default": { "type": "reflection", "declaration": { - "id": 117, + "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -22898,11 +25264,11 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reference", - "id": 118, + "id": 119, "name": "T" } ], @@ -22912,7 +25278,7 @@ ] }, { - "id": 245, + "id": 258, "name": "send", "kind": 2048, "kindString": "Method", @@ -22920,13 +25286,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 425, + "line": 430, "character": 8 } ], "signatures": [ { - "id": 246, + "id": 259, "name": "send", "kind": 4096, "kindString": "Call signature", @@ -22936,7 +25302,7 @@ }, "parameters": [ { - "id": 247, + "id": 260, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -22947,14 +25313,14 @@ "type": { "type": "reflection", "declaration": { - "id": 248, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 263, "name": "event", "kind": 1024, "kindString": "Property", @@ -22965,7 +25331,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 428, + "line": 433, "character": 6 } ], @@ -22975,7 +25341,7 @@ } }, { - "id": 251, + "id": 264, "name": "payload", "kind": 1024, "kindString": "Property", @@ -22988,7 +25354,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 429, + "line": 434, "character": 6 } ], @@ -22998,7 +25364,7 @@ } }, { - "id": 249, + "id": 262, "name": "type", "kind": 1024, "kindString": "Property", @@ -23009,7 +25375,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 427, + "line": 432, "character": 6 } ], @@ -23036,18 +25402,18 @@ { "title": "Properties", "kind": 1024, - "children": [250, 251, 249] + "children": [263, 264, 262] } ], "indexSignature": { - "id": 252, + "id": 265, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 253, + "id": 266, "name": "key", "kind": 32768, "flags": {}, @@ -23066,7 +25432,7 @@ } }, { - "id": 254, + "id": 267, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -23077,20 +25443,20 @@ "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 256, + "id": 269, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 257, + "id": 270, "name": "key", "kind": 32768, "flags": {}, @@ -23115,7 +25481,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -23127,7 +25493,7 @@ ] }, { - "id": 104, + "id": 105, "name": "subscribe", "kind": 2048, "kindString": "Method", @@ -23135,13 +25501,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 198, + "line": 213, "character": 2 } ], "signatures": [ { - "id": 105, + "id": 106, "name": "subscribe", "kind": 4096, "kindString": "Call signature", @@ -23151,7 +25517,7 @@ }, "parameters": [ { - "id": 106, + "id": 107, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -23161,49 +25527,33 @@ "type": { "type": "reflection", "declaration": { - "id": 107, + "id": 108, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 108, + "id": 109, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 109, + "id": 110, "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" - } - ] + "type": "reference", + "id": 628, + "name": "REALTIME_SUBSCRIBE_STATES" } }, { - "id": 110, + "id": 111, "name": "err", "kind": 32768, "kindString": "Parameter", @@ -23228,7 +25578,7 @@ } }, { - "id": 111, + "id": 112, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -23249,7 +25599,7 @@ ] }, { - "id": 119, + "id": 120, "name": "track", "kind": 2048, "kindString": "Method", @@ -23263,14 +25613,14 @@ ], "signatures": [ { - "id": 120, + "id": 121, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 121, + "id": 122, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -23278,20 +25628,20 @@ "type": { "type": "reflection", "declaration": { - "id": 122, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 123, + "id": 124, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 124, + "id": 125, "name": "key", "kind": 32768, "flags": {}, @@ -23310,7 +25660,7 @@ } }, { - "id": 125, + "id": 126, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -23318,20 +25668,20 @@ "type": { "type": "reflection", "declaration": { - "id": 126, + "id": 127, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 127, + "id": 128, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 128, + "id": 129, "name": "key", "kind": 32768, "flags": {}, @@ -23356,7 +25706,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -23368,7 +25718,7 @@ ] }, { - "id": 264, + "id": 277, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -23376,13 +25726,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 495, + "line": 507, "character": 2 } ], "signatures": [ { - "id": 265, + "id": 278, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -23393,7 +25743,7 @@ }, "parameters": [ { - "id": 266, + "id": 279, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -23434,7 +25784,7 @@ ] }, { - "id": 129, + "id": 130, "name": "untrack", "kind": 2048, "kindString": "Method", @@ -23448,14 +25798,14 @@ ], "signatures": [ { - "id": 130, + "id": 131, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 131, + "id": 132, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -23463,20 +25813,20 @@ "type": { "type": "reflection", "declaration": { - "id": 132, + "id": 133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 133, + "id": 134, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 134, + "id": 135, "name": "key", "kind": 32768, "flags": {}, @@ -23501,7 +25851,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -23513,7 +25863,7 @@ ] }, { - "id": 258, + "id": 271, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", @@ -23521,20 +25871,20 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 482, + "line": 494, "character": 2 } ], "signatures": [ { - "id": 259, + "id": 272, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 260, + "id": 273, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -23542,20 +25892,20 @@ "type": { "type": "reflection", "declaration": { - "id": 261, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 262, + "id": 275, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 263, + "id": 276, "name": "key", "kind": 32768, "flags": {}, @@ -23591,18 +25941,18 @@ { "title": "Properties", "kind": 1024, - "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] + "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -23773,7 +26123,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 134, + "line": 147, "character": 2 } ], @@ -23804,10 +26154,10 @@ "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -23815,21 +26165,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -23837,21 +26187,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -23864,21 +26214,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -23888,7 +26238,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -23898,7 +26248,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -23908,7 +26258,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -23922,13 +26272,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -23936,7 +26286,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -23949,21 +26299,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -23973,7 +26323,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -23987,31 +26337,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -24023,13 +26396,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -24047,17 +26420,17 @@ "flags": {}, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -24065,13 +26438,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -24081,7 +26454,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -24095,7 +26468,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -24104,10 +26477,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -24115,21 +26488,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -24139,7 +26512,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -24151,7 +26524,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -24161,7 +26534,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -24173,7 +26546,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -24183,7 +26556,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -24193,7 +26566,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -24203,14 +26576,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -24218,19 +26591,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -24249,7 +26622,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -24259,7 +26632,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -24269,7 +26642,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -24279,7 +26652,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -24306,7 +26679,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -24316,7 +26689,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -24328,7 +26701,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -24338,14 +26711,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -24353,19 +26726,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -24384,7 +26757,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -24394,7 +26767,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -24406,7 +26779,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -24416,7 +26789,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -24426,7 +26799,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -24436,7 +26809,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -24444,6 +26817,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -24451,15 +26910,20 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, 496, 504, 499, - 494, 493 + 520, 519, 531, 522, 517, 530, 518, 526, 521, + 516, 515, 532, 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -24471,14 +26935,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -24486,7 +26950,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -24506,7 +27034,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -24514,7 +27042,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -24534,7 +27062,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -24542,7 +27070,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -24557,7 +27085,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -24565,7 +27093,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -24585,7 +27113,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -24593,7 +27121,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -24605,7 +27133,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -24613,7 +27141,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -24625,7 +27153,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -24633,7 +27161,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -24644,7 +27172,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -24652,28 +27180,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -24697,7 +27225,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -24728,14 +27256,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -24763,7 +27291,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -24798,7 +27326,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -24808,27 +27336,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -24848,7 +27376,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -24856,7 +27384,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -24867,7 +27395,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -24875,7 +27403,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -24897,7 +27425,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -24905,7 +27452,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -24918,7 +27465,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -24928,27 +27475,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -24968,7 +27515,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -24976,7 +27523,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -24996,7 +27543,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -25004,7 +27551,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -25016,7 +27563,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -25024,7 +27571,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -25034,7 +27581,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -25042,7 +27589,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -25053,7 +27600,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -25061,7 +27608,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -25077,7 +27624,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -25085,7 +27632,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -25096,7 +27643,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -25104,21 +27651,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -25126,7 +27673,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -25141,7 +27688,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -25149,7 +27696,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -25164,7 +27711,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -25172,7 +27719,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -25187,7 +27734,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -25195,7 +27742,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -25214,7 +27761,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -25222,7 +27769,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -25230,7 +27777,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -25241,7 +27788,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -25249,7 +27796,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -25268,7 +27815,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -25276,20 +27936,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -25300,17 +27960,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -25318,21 +27978,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -25340,21 +28000,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -25367,21 +28027,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -25391,7 +28051,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -25401,7 +28061,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -25411,7 +28071,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -25425,13 +28085,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -25439,7 +28099,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -25452,21 +28112,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -25476,7 +28136,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -25490,31 +28150,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -25526,13 +28209,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -25552,7 +28235,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -25560,13 +28243,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -25582,7 +28265,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -25590,13 +28273,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -25612,7 +28295,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -25620,13 +28303,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -25636,7 +28319,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -25652,7 +28335,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -25676,7 +28359,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -25684,13 +28428,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -25710,7 +28454,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -25718,13 +28462,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -25740,7 +28484,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -25748,13 +28492,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -25765,7 +28509,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -25776,7 +28520,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -25787,7 +28531,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -25808,7 +28552,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -25816,13 +28560,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -25833,17 +28577,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -25851,21 +28595,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -25873,7 +28617,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -25883,7 +28627,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -25893,7 +28637,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -25903,7 +28647,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -25911,7 +28655,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -25921,7 +28665,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -25929,7 +28673,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -25939,7 +28683,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -25947,7 +28691,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -25961,13 +28705,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -25985,7 +28729,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -25993,13 +28737,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -26014,7 +28758,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -26027,7 +28771,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -26035,13 +28779,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -26051,7 +28795,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -26072,7 +28816,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -26084,7 +28828,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -26092,29 +28874,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -26128,12 +28911,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -26143,28 +28935,30 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, - 380, 386, 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, + 396, 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, + 421 ] }, { "title": "Methods", "kind": 2048, "children": [ - 426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433 + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, + 457, 454 ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -26189,7 +28983,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 116, + "line": 128, "character": 2 } ], @@ -26239,7 +29033,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 120, + "line": 132, "character": 6 } ], @@ -26259,7 +29053,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 6 } ], @@ -26274,7 +29068,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 119, + "line": 131, "character": 14 } ], @@ -26315,7 +29109,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 121, + "line": 133, "character": 6 } ], @@ -26333,7 +29127,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 118, + "line": 130, "character": 6 } ], @@ -26353,7 +29147,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 117, + "line": 129, "character": 19 } ] @@ -26374,7 +29168,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 131, + "line": 143, "character": 2 } ], @@ -26392,7 +29186,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 127, + "line": 139, "character": 2 } ], @@ -26410,7 +29204,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 126, + "line": 138, "character": 2 } ], @@ -26421,7 +29215,7 @@ "defaultValue": "false" }, { - "id": 102, + "id": 103, "name": "params", "kind": 1024, "kindString": "Property", @@ -26430,10 +29224,10 @@ }, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -26441,21 +29235,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -26463,21 +29257,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -26490,21 +29284,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -26514,7 +29308,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -26524,7 +29318,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -26534,7 +29328,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -26548,13 +29342,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -26562,7 +29356,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -26575,21 +29369,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -26599,7 +29393,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -26613,31 +29407,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -26649,13 +29466,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -26674,7 +29491,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 130, + "line": 142, "character": 2 } ], @@ -26711,6 +29528,24 @@ } } }, + { + "id": 101, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 145, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, { "id": 97, "name": "pushBuffer", @@ -26720,7 +29555,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 129, + "line": 141, "character": 2 } ], @@ -26742,7 +29577,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 128, + "line": 140, "character": 2 } ], @@ -26752,7 +29587,7 @@ } }, { - "id": 103, + "id": 104, "name": "socket", "kind": 1024, "kindString": "Property", @@ -26761,17 +29596,17 @@ }, "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default", "dereferenced": { - "id": 359, + "id": 371, "name": "RealtimeClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 360, + "id": 372, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -26779,13 +29614,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 112, + "line": 137, "character": 2 } ], "signatures": [ { - "id": 361, + "id": 373, "name": "new RealtimeClient", "kind": 16384, "kindString": "Constructor signature", @@ -26795,7 +29630,7 @@ }, "parameters": [ { - "id": 362, + "id": 374, "name": "endPoint", "kind": 32768, "kindString": "Parameter", @@ -26809,7 +29644,7 @@ } }, { - "id": 363, + "id": 375, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -26818,10 +29653,10 @@ }, "type": { "type": "reference", - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "dereferenced": { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -26829,21 +29664,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -26853,7 +29688,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -26865,7 +29700,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -26875,7 +29710,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -26887,7 +29722,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -26897,7 +29732,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -26907,7 +29742,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -26917,14 +29752,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -26932,19 +29767,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -26963,7 +29798,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -26973,7 +29808,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -26983,7 +29818,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -26993,7 +29828,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -27020,7 +29855,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -27030,7 +29865,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -27042,7 +29877,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -27052,14 +29887,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -27067,19 +29902,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -27098,7 +29933,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -27108,7 +29943,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -27120,7 +29955,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -27130,7 +29965,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -27140,7 +29975,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -27150,7 +29985,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -27158,6 +29993,92 @@ "type": "reference", "name": "WebSocketLikeConstructor" } + }, + { + "id": 532, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -27165,15 +30086,20 @@ "title": "Properties", "kind": 1024, "children": [ - 498, 497, 509, 500, 495, 508, 496, 504, 499, 494, - 493 + 520, 519, 531, 522, 517, 530, 518, 526, 521, 516, + 515, 532, 533 ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 36 } ] @@ -27185,14 +30111,14 @@ ], "type": { "type": "reference", - "id": 359, + "id": 371, "name": "default" } } ] }, { - "id": 364, + "id": 417, "name": "accessToken", "kind": 1024, "kindString": "Property", @@ -27200,7 +30126,71 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 65, + "line": 115, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 418, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 419, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 376, + "name": "accessTokenValue", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 82, "character": 2 } ], @@ -27220,7 +30210,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 377, "name": "apiKey", "kind": 1024, "kindString": "Property", @@ -27228,7 +30218,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 66, + "line": 83, "character": 2 } ], @@ -27248,7 +30238,7 @@ "defaultValue": "null" }, { - "id": 366, + "id": 378, "name": "channels", "kind": 1024, "kindString": "Property", @@ -27256,7 +30246,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 67, + "line": 84, "character": 2 } ], @@ -27271,7 +30261,7 @@ "defaultValue": "[]" }, { - "id": 387, + "id": 400, "name": "conn", "kind": 1024, "kindString": "Property", @@ -27279,7 +30269,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 82, + "line": 100, "character": 2 } ], @@ -27299,7 +30289,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 398, "name": "decode", "kind": 1024, "kindString": "Property", @@ -27307,7 +30297,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 80, + "line": 98, "character": 2 } ], @@ -27319,7 +30309,7 @@ } }, { - "id": 384, + "id": 397, "name": "encode", "kind": 1024, "kindString": "Property", @@ -27327,7 +30317,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 79, + "line": 97, "character": 2 } ], @@ -27339,7 +30329,7 @@ } }, { - "id": 367, + "id": 379, "name": "endPoint", "kind": 1024, "kindString": "Property", @@ -27347,7 +30337,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 68, + "line": 85, "character": 2 } ], @@ -27358,7 +30348,7 @@ "defaultValue": "''" }, { - "id": 396, + "id": 409, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -27366,28 +30356,28 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 96, + "line": 114, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 397, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 398, + "id": 411, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 399, + "id": 412, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -27411,7 +30401,7 @@ } }, { - "id": 400, + "id": 413, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -27442,14 +30432,14 @@ } }, { - "id": 401, + "id": 414, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 402, + "id": 415, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -27477,7 +30467,7 @@ } }, { - "id": 403, + "id": 416, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -27512,7 +30502,7 @@ } }, { - "id": 368, + "id": 381, "name": "headers", "kind": 1024, "kindString": "Property", @@ -27522,27 +30512,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 69, + "line": 87, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 369, + "id": 382, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 370, + "id": 383, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 371, + "id": 384, "name": "key", "kind": 32768, "flags": {}, @@ -27562,7 +30552,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 378, + "id": 391, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -27570,7 +30560,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 73, + "line": 91, "character": 2 } ], @@ -27581,7 +30571,7 @@ "defaultValue": "30000" }, { - "id": 379, + "id": 392, "name": "heartbeatTimer", "kind": 1024, "kindString": "Property", @@ -27589,7 +30579,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 74, + "line": 92, "character": 2 } ], @@ -27611,7 +30601,26 @@ "defaultValue": "undefined" }, { - "id": 383, + "id": 380, + "name": "httpEndpoint", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 86, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "''" + }, + { + "id": 396, "name": "logger", "kind": 1024, "kindString": "Property", @@ -27619,7 +30628,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 78, + "line": 96, "character": 2 } ], @@ -27632,7 +30641,7 @@ "defaultValue": "noop" }, { - "id": 372, + "id": 385, "name": "params", "kind": 1024, "kindString": "Property", @@ -27642,27 +30651,27 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 70, + "line": 88, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 373, + "id": 386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 374, + "id": 387, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 375, + "id": 388, "name": "key", "kind": 32768, "flags": {}, @@ -27682,7 +30691,7 @@ "defaultValue": "{}" }, { - "id": 380, + "id": 393, "name": "pendingHeartbeatRef", "kind": 1024, "kindString": "Property", @@ -27690,7 +30699,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 75, + "line": 93, "character": 2 } ], @@ -27710,7 +30719,7 @@ "defaultValue": "null" }, { - "id": 386, + "id": 399, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -27718,7 +30727,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 81, + "line": 99, "character": 2 } ], @@ -27730,7 +30739,7 @@ } }, { - "id": 382, + "id": 395, "name": "reconnectTimer", "kind": 1024, "kindString": "Property", @@ -27738,7 +30747,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 77, + "line": 95, "character": 2 } ], @@ -27748,7 +30757,7 @@ } }, { - "id": 381, + "id": 394, "name": "ref", "kind": 1024, "kindString": "Property", @@ -27756,7 +30765,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 76, + "line": 94, "character": 2 } ], @@ -27767,7 +30776,7 @@ "defaultValue": "0" }, { - "id": 388, + "id": 401, "name": "sendBuffer", "kind": 1024, "kindString": "Property", @@ -27775,7 +30784,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 83, + "line": 101, "character": 2 } ], @@ -27791,7 +30800,7 @@ "defaultValue": "[]" }, { - "id": 389, + "id": 402, "name": "serializer", "kind": 1024, "kindString": "Property", @@ -27799,7 +30808,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 84, + "line": 102, "character": 2 } ], @@ -27810,7 +30819,7 @@ "defaultValue": "..." }, { - "id": 390, + "id": 403, "name": "stateChangeCallbacks", "kind": 1024, "kindString": "Property", @@ -27818,21 +30827,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 85, + "line": 103, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 391, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 393, + "id": 406, "name": "close", "kind": 1024, "kindString": "Property", @@ -27840,7 +30849,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 87, + "line": 105, "character": 4 } ], @@ -27855,7 +30864,7 @@ } }, { - "id": 394, + "id": 407, "name": "error", "kind": 1024, "kindString": "Property", @@ -27863,7 +30872,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 88, + "line": 106, "character": 4 } ], @@ -27878,7 +30887,7 @@ } }, { - "id": 395, + "id": 408, "name": "message", "kind": 1024, "kindString": "Property", @@ -27886,7 +30895,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 89, + "line": 107, "character": 4 } ], @@ -27901,7 +30910,7 @@ } }, { - "id": 392, + "id": 405, "name": "open", "kind": 1024, "kindString": "Property", @@ -27909,7 +30918,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 86, + "line": 104, "character": 4 } ], @@ -27928,7 +30937,7 @@ { "title": "Properties", "kind": 1024, - "children": [393, 394, 395, 392] + "children": [406, 407, 408, 405] } ] } @@ -27936,7 +30945,7 @@ "defaultValue": "..." }, { - "id": 376, + "id": 389, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -27944,7 +30953,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 71, + "line": 89, "character": 2 } ], @@ -27955,7 +30964,7 @@ "defaultValue": "DEFAULT_TIMEOUT" }, { - "id": 377, + "id": 390, "name": "transport", "kind": 1024, "kindString": "Property", @@ -27963,7 +30972,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 72, + "line": 90, "character": 2 } ], @@ -27982,7 +30991,120 @@ } }, { - "id": 426, + "id": 420, + "name": "worker", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 422, + "name": "workerRef", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 118, + "character": 2 + } + ], + "type": { + "type": "reference", + "qualifiedName": "Worker", + "package": "typescript", + "name": "Worker" + } + }, + { + "id": 421, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 117, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 510, + "name": "_workerObjectUrl", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 611, + "character": 10 + } + ], + "signatures": [ + { + "id": 511, + "name": "_workerObjectUrl", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 512, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 447, "name": "channel", "kind": 2048, "kindString": "Method", @@ -27990,20 +31112,20 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 274, + "line": 319, "character": 2 } ], "signatures": [ { - "id": 427, + "id": 448, "name": "channel", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 428, + "id": 449, "name": "topic", "kind": 32768, "kindString": "Parameter", @@ -28014,17 +31136,17 @@ } }, { - "id": 429, + "id": 450, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "dereferenced": { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -28032,21 +31154,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -28054,21 +31176,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -28081,21 +31203,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -28105,7 +31227,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -28115,7 +31237,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -28125,7 +31247,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -28139,13 +31261,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -28153,7 +31275,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -28166,21 +31288,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -28190,7 +31312,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -28204,31 +31326,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -28240,13 +31385,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -28266,7 +31411,7 @@ ] }, { - "id": 404, + "id": 423, "name": "connect", "kind": 2048, "kindString": "Method", @@ -28274,13 +31419,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 157, + "line": 190, "character": 2 } ], "signatures": [ { - "id": 405, + "id": 424, "name": "connect", "kind": 4096, "kindString": "Call signature", @@ -28296,7 +31441,7 @@ ] }, { - "id": 422, + "id": 443, "name": "connectionState", "kind": 2048, "kindString": "Method", @@ -28304,13 +31449,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 254, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 423, + "id": 444, "name": "connectionState", "kind": 4096, "kindString": "Call signature", @@ -28326,7 +31471,7 @@ ] }, { - "id": 406, + "id": 427, "name": "disconnect", "kind": 2048, "kindString": "Method", @@ -28334,13 +31479,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 195, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 407, + "id": 428, "name": "disconnect", "kind": 4096, "kindString": "Call signature", @@ -28350,7 +31495,7 @@ }, "parameters": [ { - "id": 408, + "id": 429, "name": "code", "kind": 32768, "kindString": "Parameter", @@ -28366,7 +31511,7 @@ } }, { - "id": 409, + "id": 430, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -28390,7 +31535,68 @@ ] }, { - "id": 410, + "id": 425, + "name": "endpointURL", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 227, + "character": 2 + } + ], + "signatures": [ + { + "id": 426, + "name": "endpointURL", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Returns the URL of the websocket.", + "returns": "string The URL of the websocket.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 459, + "name": "flushSendBuffer", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 423, + "character": 2 + } + ], + "signatures": [ + { + "id": 460, + "name": "flushSendBuffer", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Flushes send buffer" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 431, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -28398,13 +31604,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 213, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 411, + "id": 432, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -28424,7 +31630,7 @@ ] }, { - "id": 424, + "id": 445, "name": "isConnected", "kind": 2048, "kindString": "Method", @@ -28432,13 +31638,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 270, + "line": 315, "character": 2 } ], "signatures": [ { - "id": 425, + "id": 446, "name": "isConnected", "kind": 4096, "kindString": "Call signature", @@ -28454,7 +31660,7 @@ ] }, { - "id": 417, + "id": 438, "name": "log", "kind": 2048, "kindString": "Method", @@ -28462,13 +31668,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 247, + "line": 292, "character": 2 } ], "signatures": [ { - "id": 418, + "id": 439, "name": "log", "kind": 4096, "kindString": "Call signature", @@ -28479,7 +31685,7 @@ }, "parameters": [ { - "id": 419, + "id": 440, "name": "kind", "kind": 32768, "kindString": "Parameter", @@ -28490,7 +31696,7 @@ } }, { - "id": 420, + "id": 441, "name": "msg", "kind": 32768, "kindString": "Parameter", @@ -28501,7 +31707,7 @@ } }, { - "id": 421, + "id": 442, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -28522,7 +31728,7 @@ ] }, { - "id": 430, + "id": 451, "name": "push", "kind": 2048, "kindString": "Method", @@ -28530,13 +31736,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 288, + "line": 333, "character": 2 } ], "signatures": [ { - "id": 431, + "id": 452, "name": "push", "kind": 4096, "kindString": "Call signature", @@ -28547,17 +31753,17 @@ }, "parameters": [ { - "id": 432, + "id": 453, "name": "data", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 510, + "id": 536, "name": "RealtimeMessage", "dereferenced": { - "id": 510, + "id": 536, "name": "RealtimeMessage", "kind": 4194304, "kindString": "Type alias", @@ -28565,21 +31771,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 511, + "id": 537, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 513, + "id": 539, "name": "event", "kind": 1024, "kindString": "Property", @@ -28587,7 +31793,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 48, "character": 2 } ], @@ -28597,7 +31803,7 @@ } }, { - "id": 516, + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -28607,7 +31813,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -28617,7 +31823,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -28625,7 +31831,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -28635,7 +31841,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -28643,7 +31849,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -28653,7 +31859,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -28661,7 +31867,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -28675,13 +31881,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -28699,7 +31905,7 @@ ] }, { - "id": 415, + "id": 436, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -28707,13 +31913,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 234, + "line": 279, "character": 8 } ], "signatures": [ { - "id": 416, + "id": 437, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -28728,7 +31934,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } } @@ -28741,7 +31947,7 @@ ] }, { - "id": 412, + "id": 433, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -28749,13 +31955,13 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 221, + "line": 266, "character": 8 } ], "signatures": [ { - "id": 413, + "id": 434, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -28765,7 +31971,7 @@ }, "parameters": [ { - "id": 414, + "id": 435, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -28786,7 +31992,7 @@ "typeArguments": [ { "type": "reference", - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse" } ], @@ -28798,7 +32004,45 @@ ] }, { - "id": 433, + "id": 457, + "name": "sendHeartbeat", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 397, + "character": 8 + } + ], + "signatures": [ + { + "id": 458, + "name": "sendHeartbeat", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Sends a heartbeat message if the socket is connected." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 454, "name": "setAuth", "kind": 2048, "kindString": "Method", @@ -28806,29 +32050,30 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 308, - "character": 2 + "line": 357, + "character": 8 } ], "signatures": [ { - "id": 434, + "id": 455, "name": "setAuth", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." + "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS.", + "text": "If param is null it will use the `accessToken` callback function or the token set on the client.\n\nOn callback used, it will set the value of the token internal to the client.\n" }, "parameters": [ { - "id": 435, + "id": 456, "name": "token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A JWT string.\n" + "shortText": "A JWT string to override the token set on the client.\n" }, "type": { "type": "union", @@ -28842,12 +32087,21 @@ "name": "string" } ] - } + }, + "defaultValue": "null" } ], "type": { - "type": "intrinsic", - "name": "void" + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" } } ] @@ -28857,26 +32111,29 @@ { "title": "Constructors", "kind": 512, - "children": [360] + "children": [372] }, { "title": "Properties", "kind": 1024, "children": [ - 364, 365, 366, 387, 385, 384, 367, 396, 368, 378, 379, 383, 372, 380, - 386, 382, 381, 388, 389, 390, 376, 377 + 417, 376, 377, 378, 400, 398, 397, 379, 409, 381, 391, 392, 380, 396, + 385, 393, 399, 395, 394, 401, 402, 403, 389, 390, 420, 422, 421 ] }, { "title": "Methods", "kind": 2048, - "children": [426, 404, 422, 406, 410, 424, 417, 430, 415, 412, 433] + "children": [ + 510, 447, 423, 443, 427, 425, 459, 431, 445, 438, 451, 436, 433, 457, + 454 + ] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 64, + "line": 81, "character": 21 } ] @@ -28892,7 +32149,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 125, + "line": 137, "character": 2 } ], @@ -28911,7 +32168,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 132, + "line": 144, "character": 2 } ], @@ -28929,7 +32186,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 124, + "line": 136, "character": 2 } ], @@ -28939,7 +32196,7 @@ } }, { - "id": 101, + "id": 102, "name": "topic", "kind": 1024, "kindString": "Property", @@ -28952,108 +32209,7 @@ } }, { - "id": 269, - "name": "_fetchWithTimeout", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 538, - "character": 8 - } - ], - "signatures": [ - { - "id": 270, - "name": "_fetchWithTimeout", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 271, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 272, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 273, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 274, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 275, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 276, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 135, + "id": 136, "name": "on", "kind": 2048, "kindString": "Method", @@ -29067,7 +32223,7 @@ ], "signatures": [ { - "id": 136, + "id": 137, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -29077,7 +32233,7 @@ }, "parameters": [ { - "id": 137, + "id": 138, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -29088,7 +32244,7 @@ } }, { - "id": 138, + "id": 139, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -29096,14 +32252,14 @@ "type": { "type": "reflection", "declaration": { - "id": 139, + "id": 140, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 140, + "id": 141, "name": "event", "kind": 1024, "kindString": "Property", @@ -29125,14 +32281,14 @@ { "title": "Properties", "kind": 1024, - "children": [140] + "children": [141] } ] } } }, { - "id": 141, + "id": 142, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -29140,14 +32296,14 @@ "type": { "type": "reflection", "declaration": { - "id": 142, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 143, + "id": 144, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -29169,14 +32325,14 @@ } }, { - "id": 144, + "id": 145, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 148, + "id": 149, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -29184,20 +32340,20 @@ "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 146, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 146, + "id": 147, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 147, + "id": 148, "name": "key", "kind": 32768, "flags": {}, @@ -29218,7 +32374,7 @@ ], "parameters": [ { - "id": 149, + "id": 150, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -29229,7 +32385,7 @@ } }, { - "id": 150, + "id": 151, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -29237,14 +32393,14 @@ "type": { "type": "reflection", "declaration": { - "id": 151, + "id": 152, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 152, + "id": 153, "name": "event", "kind": 1024, "kindString": "Property", @@ -29266,14 +32422,14 @@ { "title": "Properties", "kind": 1024, - "children": [152] + "children": [153] } ] } } }, { - "id": 153, + "id": 154, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -29281,32 +32437,32 @@ "type": { "type": "reflection", "declaration": { - "id": 154, + "id": 155, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 155, + "id": 156, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 156, + "id": 157, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 558, + "id": 584, "typeArguments": [ { "type": "reference", - "id": 148, + "id": 149, "name": "T" } ], @@ -29331,14 +32487,14 @@ } }, { - "id": 157, + "id": 158, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 161, + "id": 162, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -29346,20 +32502,20 @@ "type": { "type": "reflection", "declaration": { - "id": 158, + "id": 159, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 159, + "id": 160, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 160, + "id": 161, "name": "key", "kind": 32768, "flags": {}, @@ -29380,7 +32536,7 @@ ], "parameters": [ { - "id": 162, + "id": 163, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -29391,7 +32547,7 @@ } }, { - "id": 163, + "id": 164, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -29399,14 +32555,14 @@ "type": { "type": "reflection", "declaration": { - "id": 164, + "id": 165, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 165, + "id": 166, "name": "event", "kind": 1024, "kindString": "Property", @@ -29428,14 +32584,14 @@ { "title": "Properties", "kind": 1024, - "children": [165] + "children": [166] } ] } } }, { - "id": 166, + "id": 167, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -29443,32 +32599,32 @@ "type": { "type": "reflection", "declaration": { - "id": 167, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 168, + "id": 169, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 169, + "id": 170, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 568, + "id": 594, "typeArguments": [ { "type": "reference", - "id": 161, + "id": 162, "name": "T" } ], @@ -29493,14 +32649,14 @@ } }, { - "id": 170, + "id": 171, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 174, + "id": 175, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -29508,20 +32664,20 @@ "type": { "type": "reflection", "declaration": { - "id": 171, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 172, + "id": 173, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 173, + "id": 174, "name": "key", "kind": 32768, "flags": {}, @@ -29542,7 +32698,7 @@ ], "parameters": [ { - "id": 175, + "id": 176, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -29553,14 +32709,14 @@ } }, { - "id": 176, + "id": 177, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -29569,7 +32725,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -29577,13 +32733,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -29595,7 +32751,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -29607,14 +32763,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -29625,19 +32781,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -29650,7 +32806,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -29660,7 +32816,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -29671,7 +32827,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -29681,7 +32837,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -29694,7 +32850,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -29708,13 +32864,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -29724,7 +32880,7 @@ } }, { - "id": 177, + "id": 178, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -29732,32 +32888,32 @@ "type": { "type": "reflection", "declaration": { - "id": 178, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 179, + "id": 180, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 180, + "id": 181, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 524, + "id": 550, "typeArguments": [ { "type": "reference", - "id": 174, + "id": 175, "name": "T" } ], @@ -29782,14 +32938,14 @@ } }, { - "id": 181, + "id": 182, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 185, + "id": 186, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -29797,20 +32953,20 @@ "type": { "type": "reflection", "declaration": { - "id": 182, + "id": 183, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 183, + "id": 184, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 184, + "id": 185, "name": "key", "kind": 32768, "flags": {}, @@ -29831,7 +32987,7 @@ ], "parameters": [ { - "id": 186, + "id": 187, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -29842,14 +32998,14 @@ } }, { - "id": 187, + "id": 188, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -29858,7 +33014,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -29866,13 +33022,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -29884,7 +33040,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -29896,14 +33052,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -29914,19 +33070,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -29939,7 +33095,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -29949,7 +33105,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -29960,7 +33116,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -29970,7 +33126,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -29983,7 +33139,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -29997,13 +33153,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -30013,7 +33169,7 @@ } }, { - "id": 188, + "id": 189, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -30021,32 +33177,32 @@ "type": { "type": "reflection", "declaration": { - "id": 189, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 190, + "id": 191, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 191, + "id": 192, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 529, + "id": 555, "typeArguments": [ { "type": "reference", - "id": 185, + "id": 186, "name": "T" } ], @@ -30071,14 +33227,14 @@ } }, { - "id": 192, + "id": 193, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 196, + "id": 197, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -30086,20 +33242,20 @@ "type": { "type": "reflection", "declaration": { - "id": 193, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 194, + "id": 195, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 196, "name": "key", "kind": 32768, "flags": {}, @@ -30120,7 +33276,7 @@ ], "parameters": [ { - "id": 197, + "id": 198, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -30131,14 +33287,14 @@ } }, { - "id": 198, + "id": 199, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -30147,7 +33303,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -30155,13 +33311,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -30173,7 +33329,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -30185,14 +33341,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -30203,19 +33359,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -30228,7 +33384,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -30238,7 +33394,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -30249,7 +33405,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -30259,7 +33415,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -30272,7 +33428,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -30286,13 +33442,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -30302,7 +33458,7 @@ } }, { - "id": 199, + "id": 200, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -30310,32 +33466,32 @@ "type": { "type": "reflection", "declaration": { - "id": 200, + "id": 201, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 201, + "id": 202, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 202, + "id": 203, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 539, + "id": 565, "typeArguments": [ { "type": "reference", - "id": 196, + "id": 197, "name": "T" } ], @@ -30360,14 +33516,14 @@ } }, { - "id": 203, + "id": 204, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 207, + "id": 208, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -30375,20 +33531,20 @@ "type": { "type": "reflection", "declaration": { - "id": 204, + "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 205, + "id": 206, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 206, + "id": 207, "name": "key", "kind": 32768, "flags": {}, @@ -30409,7 +33565,7 @@ ], "parameters": [ { - "id": 208, + "id": 209, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -30420,14 +33576,14 @@ } }, { - "id": 209, + "id": 210, "name": "filter", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 517, + "id": 543, "typeArguments": [ { "type": "literal", @@ -30436,7 +33592,7 @@ ], "name": "RealtimePostgresChangesFilter", "dereferenced": { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -30444,13 +33600,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -30462,7 +33618,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -30474,14 +33630,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -30492,19 +33648,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -30517,7 +33673,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -30527,7 +33683,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -30538,7 +33694,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -30548,7 +33704,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -30561,7 +33717,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -30575,13 +33731,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -30591,7 +33747,7 @@ } }, { - "id": 210, + "id": 211, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -30599,32 +33755,32 @@ "type": { "type": "reflection", "declaration": { - "id": 211, + "id": 212, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 212, + "id": 213, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 213, + "id": 214, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 548, + "id": 574, "typeArguments": [ { "type": "reference", - "id": 207, + "id": 208, "name": "T" } ], @@ -30649,7 +33805,7 @@ } }, { - "id": 214, + "id": 215, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -30659,7 +33815,7 @@ }, "parameters": [ { - "id": 215, + "id": 216, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -30673,7 +33829,7 @@ } }, { - "id": 216, + "id": 217, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -30684,14 +33840,14 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 218, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 218, + "id": 219, "name": "event", "kind": 1024, "kindString": "Property", @@ -30713,14 +33869,14 @@ { "title": "Properties", "kind": 1024, - "children": [218] + "children": [219] } ] } } }, { - "id": 219, + "id": 220, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -30731,21 +33887,21 @@ "type": { "type": "reflection", "declaration": { - "id": 220, + "id": 221, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 221, + "id": 222, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 222, + "id": 223, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -30753,14 +33909,14 @@ "type": { "type": "reflection", "declaration": { - "id": 223, + "id": 224, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 226, "name": "event", "kind": 1024, "kindString": "Property", @@ -30778,7 +33934,7 @@ } }, { - "id": 224, + "id": 225, "name": "type", "kind": 1024, "kindString": "Property", @@ -30800,18 +33956,18 @@ { "title": "Properties", "kind": 1024, - "children": [225, 224] + "children": [226, 225] } ], "indexSignature": { - "id": 226, + "id": 227, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 227, + "id": 228, "name": "key", "kind": 32768, "flags": {}, @@ -30847,14 +34003,14 @@ } }, { - "id": 228, + "id": 229, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 232, + "id": 233, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -30862,20 +34018,20 @@ "type": { "type": "reflection", "declaration": { - "id": 229, + "id": 230, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 230, + "id": 231, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 231, + "id": 232, "name": "key", "kind": 32768, "flags": {}, @@ -30896,7 +34052,7 @@ ], "parameters": [ { - "id": 233, + "id": 234, "name": "type", "kind": 32768, "kindString": "Parameter", @@ -30907,7 +34063,7 @@ } }, { - "id": 234, + "id": 235, "name": "filter", "kind": 32768, "kindString": "Parameter", @@ -30915,14 +34071,14 @@ "type": { "type": "reflection", "declaration": { - "id": 235, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 236, + "id": 237, "name": "event", "kind": 1024, "kindString": "Property", @@ -30944,14 +34100,14 @@ { "title": "Properties", "kind": 1024, - "children": [236] + "children": [237] } ] } } }, { - "id": 237, + "id": 238, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -30959,21 +34115,21 @@ "type": { "type": "reflection", "declaration": { - "id": 238, + "id": 239, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 239, + "id": 240, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 240, + "id": 241, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -30981,14 +34137,14 @@ "type": { "type": "reflection", "declaration": { - "id": 241, + "id": 242, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 243, + "id": 244, "name": "event", "kind": 1024, "kindString": "Property", @@ -31006,7 +34162,7 @@ } }, { - "id": 244, + "id": 245, "name": "payload", "kind": 1024, "kindString": "Property", @@ -31020,12 +34176,12 @@ ], "type": { "type": "reference", - "id": 232, + "id": 233, "name": "T" } }, { - "id": 242, + "id": 243, "name": "type", "kind": 1024, "kindString": "Property", @@ -31047,7 +34203,7 @@ { "title": "Properties", "kind": 1024, - "children": [243, 244, 242] + "children": [244, 245, 243] } ] } @@ -31069,11 +34225,138 @@ "id": 64, "name": "default" } + }, + { + "id": 246, + "name": "on", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "typeParameter": [ + { + "id": 250, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 247, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 248, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 249, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "parameters": [ + { + "id": 251, + "name": "type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "literal", + "value": "system" + } + }, + { + "id": 252, + "name": "filter", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 253, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 254, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 255, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 256, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 257, + "name": "payload", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "id": 64, + "name": "default" + } } ] }, { - "id": 112, + "id": 113, "name": "presenceState", "kind": 2048, "kindString": "Method", @@ -31087,14 +34370,14 @@ ], "signatures": [ { - "id": 113, + "id": 114, "name": "presenceState", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 118, + "id": 119, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -31102,20 +34385,20 @@ "type": { "type": "reflection", "declaration": { - "id": 114, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 115, + "id": 116, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 116, + "id": 117, "name": "key", "kind": 32768, "flags": {}, @@ -31135,7 +34418,7 @@ "default": { "type": "reflection", "declaration": { - "id": 117, + "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -31146,11 +34429,11 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reference", - "id": 118, + "id": 119, "name": "T" } ], @@ -31160,7 +34443,7 @@ ] }, { - "id": 245, + "id": 258, "name": "send", "kind": 2048, "kindString": "Method", @@ -31168,13 +34451,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 425, + "line": 430, "character": 8 } ], "signatures": [ { - "id": 246, + "id": 259, "name": "send", "kind": 4096, "kindString": "Call signature", @@ -31184,7 +34467,7 @@ }, "parameters": [ { - "id": 247, + "id": 260, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -31195,14 +34478,14 @@ "type": { "type": "reflection", "declaration": { - "id": 248, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 263, "name": "event", "kind": 1024, "kindString": "Property", @@ -31213,7 +34496,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 428, + "line": 433, "character": 6 } ], @@ -31223,7 +34506,7 @@ } }, { - "id": 251, + "id": 264, "name": "payload", "kind": 1024, "kindString": "Property", @@ -31236,7 +34519,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 429, + "line": 434, "character": 6 } ], @@ -31246,7 +34529,7 @@ } }, { - "id": 249, + "id": 262, "name": "type", "kind": 1024, "kindString": "Property", @@ -31257,7 +34540,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 427, + "line": 432, "character": 6 } ], @@ -31284,18 +34567,18 @@ { "title": "Properties", "kind": 1024, - "children": [250, 251, 249] + "children": [263, 264, 262] } ], "indexSignature": { - "id": 252, + "id": 265, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 253, + "id": 266, "name": "key", "kind": 32768, "flags": {}, @@ -31314,7 +34597,7 @@ } }, { - "id": 254, + "id": 267, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -31325,20 +34608,20 @@ "type": { "type": "reflection", "declaration": { - "id": 255, + "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 256, + "id": 269, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 257, + "id": 270, "name": "key", "kind": 32768, "flags": {}, @@ -31363,7 +34646,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -31375,7 +34658,7 @@ ] }, { - "id": 104, + "id": 105, "name": "subscribe", "kind": 2048, "kindString": "Method", @@ -31383,13 +34666,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 198, + "line": 213, "character": 2 } ], "signatures": [ { - "id": 105, + "id": 106, "name": "subscribe", "kind": 4096, "kindString": "Call signature", @@ -31399,7 +34682,7 @@ }, "parameters": [ { - "id": 106, + "id": 107, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -31409,49 +34692,33 @@ "type": { "type": "reflection", "declaration": { - "id": 107, + "id": 108, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 108, + "id": 109, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 109, + "id": 110, "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" - } - ] + "type": "reference", + "id": 628, + "name": "REALTIME_SUBSCRIBE_STATES" } }, { - "id": 110, + "id": 111, "name": "err", "kind": 32768, "kindString": "Parameter", @@ -31476,7 +34743,7 @@ } }, { - "id": 111, + "id": 112, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -31497,7 +34764,7 @@ ] }, { - "id": 119, + "id": 120, "name": "track", "kind": 2048, "kindString": "Method", @@ -31511,14 +34778,14 @@ ], "signatures": [ { - "id": 120, + "id": 121, "name": "track", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 121, + "id": 122, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -31526,20 +34793,20 @@ "type": { "type": "reflection", "declaration": { - "id": 122, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 123, + "id": 124, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 124, + "id": 125, "name": "key", "kind": 32768, "flags": {}, @@ -31558,7 +34825,7 @@ } }, { - "id": 125, + "id": 126, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -31566,20 +34833,20 @@ "type": { "type": "reflection", "declaration": { - "id": 126, + "id": 127, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 127, + "id": 128, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 128, + "id": 129, "name": "key", "kind": 32768, "flags": {}, @@ -31604,7 +34871,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -31616,7 +34883,7 @@ ] }, { - "id": 264, + "id": 277, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -31624,13 +34891,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 495, + "line": 507, "character": 2 } ], "signatures": [ { - "id": 265, + "id": 278, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -31641,7 +34908,7 @@ }, "parameters": [ { - "id": 266, + "id": 279, "name": "timeout", "kind": 32768, "kindString": "Parameter", @@ -31682,7 +34949,7 @@ ] }, { - "id": 129, + "id": 130, "name": "untrack", "kind": 2048, "kindString": "Method", @@ -31696,14 +34963,14 @@ ], "signatures": [ { - "id": 130, + "id": 131, "name": "untrack", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 131, + "id": 132, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -31711,20 +34978,20 @@ "type": { "type": "reflection", "declaration": { - "id": 132, + "id": 133, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 133, + "id": 134, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 134, + "id": 135, "name": "key", "kind": 32768, "flags": {}, @@ -31749,7 +35016,7 @@ "typeArguments": [ { "type": "reference", - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse" } ], @@ -31761,7 +35028,7 @@ ] }, { - "id": 258, + "id": 271, "name": "updateJoinPayload", "kind": 2048, "kindString": "Method", @@ -31769,20 +35036,20 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 482, + "line": 494, "character": 2 } ], "signatures": [ { - "id": 259, + "id": 272, "name": "updateJoinPayload", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 260, + "id": 273, "name": "payload", "kind": 32768, "kindString": "Parameter", @@ -31790,20 +35057,20 @@ "type": { "type": "reflection", "declaration": { - "id": 261, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 262, + "id": 275, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 263, + "id": 276, "name": "key", "kind": 32768, "flags": {}, @@ -31839,18 +35106,18 @@ { "title": "Properties", "kind": 1024, - "children": [80, 99, 95, 94, 102, 98, 97, 96, 103, 93, 100, 92, 101] + "children": [80, 99, 95, 94, 103, 98, 101, 97, 96, 104, 93, 100, 92, 102] }, { "title": "Methods", "kind": 2048, - "children": [269, 135, 112, 245, 104, 119, 264, 129, 258] + "children": [136, 113, 258, 105, 120, 277, 130, 271] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 115, + "line": 127, "character": 21 } ] @@ -31922,7 +35189,7 @@ ], "type": { "type": "reference", - "id": 578, + "id": 604, "typeArguments": [ { "type": "reflection", @@ -31937,7 +35204,7 @@ ], "name": "RealtimePresenceState", "dereferenced": { - "id": 578, + "id": 604, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", @@ -31951,7 +35218,7 @@ ], "typeParameter": [ { - "id": 586, + "id": 612, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -31959,7 +35226,7 @@ "type": { "type": "reflection", "declaration": { - "id": 582, + "id": 608, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -31972,14 +35239,14 @@ } ], "indexSignature": { - "id": 583, + "id": 609, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 584, + "id": 610, "name": "key", "kind": 32768, "flags": {}, @@ -31999,7 +35266,7 @@ "default": { "type": "reflection", "declaration": { - "id": 585, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -32018,7 +35285,7 @@ "type": { "type": "reflection", "declaration": { - "id": 579, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -32031,14 +35298,14 @@ } ], "indexSignature": { - "id": 580, + "id": 606, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 581, + "id": 607, "name": "key", "kind": 32768, "flags": {}, @@ -32055,7 +35322,7 @@ "typeArguments": [ { "type": "reference", - "id": 586, + "id": 612, "name": "T" } ], @@ -32091,7 +35358,7 @@ ] }, { - "id": 347, + "id": 358, "name": "RealtimeChannelOptions", "kind": 4194304, "kindString": "Type alias", @@ -32099,21 +35366,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 359, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 360, "name": "config", "kind": 1024, "kindString": "Property", @@ -32121,21 +35388,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 350, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 351, + "id": 362, "name": "broadcast", "kind": 1024, "kindString": "Property", @@ -32148,21 +35415,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 352, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 365, "name": "ack", "kind": 1024, "kindString": "Property", @@ -32172,7 +35439,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 34 } ], @@ -32182,7 +35449,7 @@ } }, { - "id": 353, + "id": 364, "name": "self", "kind": 1024, "kindString": "Property", @@ -32192,7 +35459,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 18 } ], @@ -32206,13 +35473,13 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353] + "children": [365, 364] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 21, + "line": 22, "character": 16 } ] @@ -32220,7 +35487,7 @@ } }, { - "id": 355, + "id": 366, "name": "presence", "kind": 1024, "kindString": "Property", @@ -32233,21 +35500,21 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 356, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "id": 368, "name": "key", "kind": 1024, "kindString": "Property", @@ -32257,7 +35524,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 17 } ], @@ -32271,31 +35538,54 @@ { "title": "Properties", "kind": 1024, - "children": [357] + "children": [368] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 25, + "line": 26, "character": 15 } ] } } + }, + { + "id": 369, + "name": "private", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" + }, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 30, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [351, 355] + "children": [362, 366, 369] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 16, + "line": 17, "character": 10 } ] @@ -32307,13 +35597,13 @@ { "title": "Properties", "kind": 1024, - "children": [349] + "children": [360] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 15, + "line": 16, "character": 37 } ] @@ -32321,7 +35611,7 @@ } }, { - "id": 358, + "id": 370, "name": "RealtimeChannelSendResponse", "kind": 4194304, "kindString": "Type alias", @@ -32329,7 +35619,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 83, + "line": 88, "character": 12 } ], @@ -32352,7 +35642,7 @@ } }, { - "id": 491, + "id": 513, "name": "RealtimeClientOptions", "kind": 4194304, "kindString": "Type alias", @@ -32360,21 +35650,21 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 20, + "line": 29, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 492, + "id": 514, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 498, + "id": 520, "name": "decode", "kind": 1024, "kindString": "Property", @@ -32384,7 +35674,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 26, + "line": 35, "character": 2 } ], @@ -32396,7 +35686,7 @@ } }, { - "id": 497, + "id": 519, "name": "encode", "kind": 1024, "kindString": "Property", @@ -32406,7 +35696,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 25, + "line": 34, "character": 2 } ], @@ -32418,7 +35708,7 @@ } }, { - "id": 509, + "id": 531, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -32428,7 +35718,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 31, + "line": 40, "character": 2 } ], @@ -32438,7 +35728,7 @@ } }, { - "id": 500, + "id": 522, "name": "headers", "kind": 1024, "kindString": "Property", @@ -32448,14 +35738,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 501, + "id": 523, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -32463,19 +35753,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 28, + "line": 37, "character": 12 } ], "indexSignature": { - "id": 502, + "id": 524, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 503, + "id": 525, "name": "key", "kind": 32768, "flags": {}, @@ -32494,7 +35784,7 @@ } }, { - "id": 495, + "id": 517, "name": "heartbeatIntervalMs", "kind": 1024, "kindString": "Property", @@ -32504,7 +35794,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 23, + "line": 32, "character": 2 } ], @@ -32514,7 +35804,7 @@ } }, { - "id": 508, + "id": 530, "name": "log_level", "kind": 1024, "kindString": "Property", @@ -32524,7 +35814,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 30, + "line": 39, "character": 2 } ], @@ -32551,7 +35841,7 @@ } }, { - "id": 496, + "id": 518, "name": "logger", "kind": 1024, "kindString": "Property", @@ -32561,7 +35851,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 24, + "line": 33, "character": 2 } ], @@ -32573,7 +35863,7 @@ } }, { - "id": 504, + "id": 526, "name": "params", "kind": 1024, "kindString": "Property", @@ -32583,14 +35873,14 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 505, + "id": 527, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -32598,19 +35888,19 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 29, + "line": 38, "character": 11 } ], "indexSignature": { - "id": 506, + "id": 528, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 507, + "id": 529, "name": "key", "kind": 32768, "flags": {}, @@ -32629,7 +35919,7 @@ } }, { - "id": 499, + "id": 521, "name": "reconnectAfterMs", "kind": 1024, "kindString": "Property", @@ -32639,7 +35929,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 27, + "line": 36, "character": 2 } ], @@ -32651,7 +35941,7 @@ } }, { - "id": 494, + "id": 516, "name": "timeout", "kind": 1024, "kindString": "Property", @@ -32661,7 +35951,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 22, + "line": 31, "character": 2 } ], @@ -32671,7 +35961,7 @@ } }, { - "id": 493, + "id": 515, "name": "transport", "kind": 1024, "kindString": "Property", @@ -32681,7 +35971,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 21, + "line": 30, "character": 2 } ], @@ -32689,57 +35979,39 @@ "type": "reference", "name": "WebSocketLikeConstructor" } - } - ], - "groups": [ + }, { - "title": "Properties", - "kind": 1024, - "children": [498, 497, 509, 500, 495, 508, 496, 504, 499, 494, 493] - } - ], - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 20, - "character": 36 - } - ] - } - } - }, - { - "id": 510, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeClient.ts", - "line": 34, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 511, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 513, - "name": "event", + "id": 532, + "name": "worker", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 36, + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 533, + "name": "workerUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 42, "character": 2 } ], @@ -32749,7 +36021,116 @@ } }, { - "id": 516, + "id": 534, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 43, + "character": 2 + } + ], + "signatures": [ + { + "id": 535, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [520, 519, 531, 522, 517, 530, 518, 526, 521, 516, 515, 532, 533] + }, + { + "title": "Methods", + "kind": 2048, + "children": [534] + } + ], + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 29, + "character": 36 + } + ] + } + } + }, + { + "id": 536, + "name": "RealtimeMessage", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 46, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 537, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 539, + "name": "event", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeClient.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 542, "name": "join_ref", "kind": 1024, "kindString": "Property", @@ -32759,7 +36140,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 39, + "line": 51, "character": 2 } ], @@ -32769,7 +36150,7 @@ } }, { - "id": 514, + "id": 540, "name": "payload", "kind": 1024, "kindString": "Property", @@ -32777,7 +36158,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 37, + "line": 49, "character": 2 } ], @@ -32787,7 +36168,7 @@ } }, { - "id": 515, + "id": 541, "name": "ref", "kind": 1024, "kindString": "Property", @@ -32795,7 +36176,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 38, + "line": 50, "character": 2 } ], @@ -32805,7 +36186,7 @@ } }, { - "id": 512, + "id": 538, "name": "topic", "kind": 1024, "kindString": "Property", @@ -32813,7 +36194,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 35, + "line": 47, "character": 2 } ], @@ -32827,13 +36208,13 @@ { "title": "Properties", "kind": 1024, - "children": [513, 516, 514, 515, 512] + "children": [539, 542, 540, 541, 538] } ], "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 34, + "line": 46, "character": 30 } ] @@ -32841,7 +36222,7 @@ } }, { - "id": 517, + "id": 543, "name": "RealtimePostgresChangesFilter", "kind": 4194304, "kindString": "Type alias", @@ -32849,13 +36230,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 62, + "line": 67, "character": 12 } ], "typeParameter": [ { - "id": 523, + "id": 549, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -32867,7 +36248,7 @@ [ { "type": "reference", - "id": 592, + "id": 619, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" }, "" @@ -32879,14 +36260,14 @@ "type": { "type": "reflection", "declaration": { - "id": 518, + "id": 544, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 519, + "id": 545, "name": "event", "kind": 1024, "kindString": "Property", @@ -32897,19 +36278,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 68, + "line": 73, "character": 2 } ], "type": { "type": "reference", - "id": 523, + "id": 549, "name": "T", "dereferenced": {} } }, { - "id": 522, + "id": 548, "name": "filter", "kind": 1024, "kindString": "Property", @@ -32922,7 +36303,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 80, + "line": 85, "character": 2 } ], @@ -32932,7 +36313,7 @@ } }, { - "id": 520, + "id": 546, "name": "schema", "kind": 1024, "kindString": "Property", @@ -32943,7 +36324,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 72, + "line": 77, "character": 2 } ], @@ -32953,7 +36334,7 @@ } }, { - "id": 521, + "id": 547, "name": "table", "kind": 1024, "kindString": "Property", @@ -32966,7 +36347,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 76, + "line": 81, "character": 2 } ], @@ -32980,13 +36361,13 @@ { "title": "Properties", "kind": 1024, - "children": [519, 522, 520, 521] + "children": [545, 548, 546, 547] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 64, + "line": 69, "character": 4 } ] @@ -32994,7 +36375,7 @@ } }, { - "id": 524, + "id": 550, "name": "RealtimePostgresChangesPayload", "kind": 4194304, "kindString": "Type alias", @@ -33002,13 +36383,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 57, + "line": 62, "character": 12 } ], "typeParameter": [ { - "id": 528, + "id": 554, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -33016,7 +36397,7 @@ "type": { "type": "reflection", "declaration": { - "id": 525, + "id": 551, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -33024,19 +36405,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 57, + "line": 62, "character": 53 } ], "indexSignature": { - "id": 526, + "id": 552, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 527, + "id": 553, "name": "key", "kind": 32768, "flags": {}, @@ -33059,7 +36440,7 @@ "type": "union", "types": [ { - "id": 529, + "id": 555, "name": "RealtimePostgresInsertPayload", "kind": 4194304, "kindString": "Type alias", @@ -33067,13 +36448,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 36, + "line": 41, "character": 12 } ], "typeParameter": [ { - "id": 538, + "id": 564, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -33081,7 +36462,7 @@ "type": { "type": "reflection", "declaration": { - "id": 535, + "id": 561, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -33089,19 +36470,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 36, + "line": 41, "character": 52 } ], "indexSignature": { - "id": 536, + "id": 562, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 537, + "id": 563, "name": "key", "kind": 32768, "flags": {}, @@ -33130,14 +36511,14 @@ { "type": "reflection", "declaration": { - "id": 530, + "id": 556, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 531, + "id": 557, "name": "eventType", "kind": 1024, "kindString": "Property", @@ -33145,7 +36526,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 38, + "line": 43, "character": 4 } ], @@ -33156,7 +36537,7 @@ [ { "type": "reference", - "id": 594, + "id": 621, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" }, "" @@ -33165,7 +36546,7 @@ } }, { - "id": 532, + "id": 558, "name": "new", "kind": 1024, "kindString": "Property", @@ -33173,151 +36554,22 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 39, + "line": 44, "character": 4 } ], "type": { "type": "reference", - "id": 538, + "id": 564, "name": "T" } }, { - "id": 533, + "id": 559, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 40, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 534, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 40, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [531, 532, 533] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 37, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 539, - "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 43, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 547, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 43, - "character": 52 - } - ], - "indexSignature": { - "id": 545, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 546, - "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": 540, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 541, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -33326,64 +36578,21 @@ } ], "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ + "type": "reflection", + "declaration": { + "id": 560, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ { - "type": "reference", - "id": 595, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "" + "fileName": "src/RealtimeChannel.ts", + "line": 45, + "character": 9 + } ] - ] - } - }, - { - "id": 542, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 46, - "character": 4 } - ], - "type": { - "type": "reference", - "id": 547, - "name": "T" - } - }, - { - "id": 543, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 547, - "name": "T" - } - ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" } } ], @@ -33391,13 +36600,13 @@ { "title": "Properties", "kind": 1024, - "children": [541, 542, 543] + "children": [557, 558, 559] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 44, + "line": 42, "character": 39 } ] @@ -33407,21 +36616,21 @@ } }, { - "id": 548, - "name": "RealtimePostgresDeletePayload", + "id": 565, + "name": "RealtimePostgresUpdatePayload", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 48, "character": 12 } ], "typeParameter": [ { - "id": 557, + "id": 573, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -33429,7 +36638,7 @@ "type": { "type": "reflection", "declaration": { - "id": 554, + "id": 570, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -33437,19 +36646,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 48, "character": 52 } ], "indexSignature": { - "id": 555, + "id": 571, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 556, + "id": 572, "name": "key", "kind": 32768, "flags": {}, @@ -33478,18 +36687,65 @@ { "type": "reflection", "declaration": { - "id": 549, + "id": 566, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 550, + "id": 567, "name": "eventType", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 50, + "character": 4 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 622, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" + }, + "" + ] + ] + } + }, + { + "id": 568, + "name": "new", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 51, + "character": 4 + } + ], + "type": { + "type": "reference", + "id": 573, + "name": "T" + } + }, + { + "id": 569, + "name": "old", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -33497,71 +36753,12 @@ "character": 4 } ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 596, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "" - ] - ] - } - }, - { - "id": 551, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 53, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 552, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 53, - "character": 9 - } - ] - } - } - }, - { - "id": 553, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 54, - "character": 4 - } - ], "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 557, + "id": 573, "name": "T" } ], @@ -33575,13 +36772,197 @@ { "title": "Properties", "kind": 1024, - "children": [550, 551, 553] + "children": [567, 568, 569] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 51, + "line": 49, + "character": 39 + } + ] + } + } + ] + } + }, + { + "id": 574, + "name": "RealtimePostgresDeletePayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 55, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 583, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 580, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 55, + "character": 52 + } + ], + "indexSignature": { + "id": 581, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 582, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "name": "RealtimePostgresChangesPayloadBase" + }, + { + "type": "reflection", + "declaration": { + "id": 575, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 576, + "name": "eventType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 57, + "character": 4 + } + ], + "type": { + "type": "template-literal", + "head": "", + "tail": [ + [ + { + "type": "reference", + "id": 623, + "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" + }, + "" + ] + ] + } + }, + { + "id": 577, + "name": "new", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 58, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 578, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 58, + "character": 9 + } + ] + } + } + }, + { + "id": 579, + "name": "old", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 59, + "character": 4 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 583, + "name": "T" + } + ], + "qualifiedName": "Partial", + "package": "typescript", + "name": "Partial" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [576, 577, 579] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 56, "character": 39 } ] @@ -33594,7 +36975,7 @@ } }, { - "id": 548, + "id": 574, "name": "RealtimePostgresDeletePayload", "kind": 4194304, "kindString": "Type alias", @@ -33602,13 +36983,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 55, "character": 12 } ], "typeParameter": [ { - "id": 557, + "id": 583, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -33616,7 +36997,7 @@ "type": { "type": "reflection", "declaration": { - "id": 554, + "id": 580, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -33624,19 +37005,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 50, + "line": 55, "character": 52 } ], "indexSignature": { - "id": 555, + "id": 581, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 556, + "id": 582, "name": "key", "kind": 32768, "flags": {}, @@ -33665,14 +37046,14 @@ { "type": "reflection", "declaration": { - "id": 549, + "id": 575, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 550, + "id": 576, "name": "eventType", "kind": 1024, "kindString": "Property", @@ -33680,7 +37061,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 52, + "line": 57, "character": 4 } ], @@ -33691,7 +37072,7 @@ [ { "type": "reference", - "id": 596, + "id": 623, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" }, "" @@ -33700,7 +37081,7 @@ } }, { - "id": 551, + "id": 577, "name": "new", "kind": 1024, "kindString": "Property", @@ -33708,14 +37089,14 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 53, + "line": 58, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 552, + "id": 578, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -33723,7 +37104,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 53, + "line": 58, "character": 9 } ] @@ -33731,7 +37112,7 @@ } }, { - "id": 553, + "id": 579, "name": "old", "kind": 1024, "kindString": "Property", @@ -33739,7 +37120,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 54, + "line": 59, "character": 4 } ], @@ -33748,7 +37129,7 @@ "typeArguments": [ { "type": "reference", - "id": 557, + "id": 583, "name": "T" } ], @@ -33762,13 +37143,13 @@ { "title": "Properties", "kind": 1024, - "children": [550, 551, 553] + "children": [576, 577, 579] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 51, + "line": 56, "character": 39 } ] @@ -33778,7 +37159,7 @@ } }, { - "id": 529, + "id": 555, "name": "RealtimePostgresInsertPayload", "kind": 4194304, "kindString": "Type alias", @@ -33786,13 +37167,13 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 36, + "line": 41, "character": 12 } ], "typeParameter": [ { - "id": 538, + "id": 564, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -33800,7 +37181,7 @@ "type": { "type": "reflection", "declaration": { - "id": 535, + "id": 561, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -33808,19 +37189,19 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 36, + "line": 41, "character": 52 } ], "indexSignature": { - "id": 536, + "id": 562, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 537, + "id": 563, "name": "key", "kind": 32768, "flags": {}, @@ -33849,14 +37230,14 @@ { "type": "reflection", "declaration": { - "id": 530, + "id": 556, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 531, + "id": 557, "name": "eventType", "kind": 1024, "kindString": "Property", @@ -33864,7 +37245,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 38, + "line": 43, "character": 4 } ], @@ -33875,7 +37256,7 @@ [ { "type": "reference", - "id": 594, + "id": 621, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" }, "" @@ -33884,7 +37265,7 @@ } }, { - "id": 532, + "id": 558, "name": "new", "kind": 1024, "kindString": "Property", @@ -33892,151 +37273,22 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 39, + "line": 44, "character": 4 } ], "type": { "type": "reference", - "id": 538, + "id": 564, "name": "T" } }, { - "id": 533, + "id": 559, "name": "old", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 40, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 534, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 40, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [531, 532, 533] - } - ], - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 37, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 539, - "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 43, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 547, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 544, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/RealtimeChannel.ts", - "line": 43, - "character": 52 - } - ], - "indexSignature": { - "id": 545, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 546, - "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": 540, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 541, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, "sources": [ { "fileName": "src/RealtimeChannel.ts", @@ -34044,6 +37296,135 @@ "character": 4 } ], + "type": { + "type": "reflection", + "declaration": { + "id": 560, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 45, + "character": 9 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [557, 558, 559] + } + ], + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 42, + "character": 39 + } + ] + } + } + ] + } + }, + { + "id": 565, + "name": "RealtimePostgresUpdatePayload", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 48, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 573, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 570, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 48, + "character": 52 + } + ], + "indexSignature": { + "id": 571, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 572, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "name": "RealtimePostgresChangesPayloadBase" + }, + { + "type": "reflection", + "declaration": { + "id": 566, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 567, + "name": "eventType", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/RealtimeChannel.ts", + "line": 50, + "character": 4 + } + ], "type": { "type": "template-literal", "head": "", @@ -34051,7 +37432,7 @@ [ { "type": "reference", - "id": 595, + "id": 622, "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" }, "" @@ -34060,7 +37441,7 @@ } }, { - "id": 542, + "id": 568, "name": "new", "kind": 1024, "kindString": "Property", @@ -34068,18 +37449,18 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 46, + "line": 51, "character": 4 } ], "type": { "type": "reference", - "id": 547, + "id": 573, "name": "T" } }, { - "id": 543, + "id": 569, "name": "old", "kind": 1024, "kindString": "Property", @@ -34087,7 +37468,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 47, + "line": 52, "character": 4 } ], @@ -34096,7 +37477,7 @@ "typeArguments": [ { "type": "reference", - "id": 547, + "id": 573, "name": "T" } ], @@ -34110,13 +37491,13 @@ { "title": "Properties", "kind": 1024, - "children": [541, 542, 543] + "children": [567, 568, 569] } ], "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 44, + "line": 49, "character": 39 } ] @@ -34126,7 +37507,7 @@ } }, { - "id": 558, + "id": 584, "name": "RealtimePresenceJoinPayload", "kind": 4194304, "kindString": "Type alias", @@ -34140,7 +37521,7 @@ ], "typeParameter": [ { - "id": 567, + "id": 593, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -34148,7 +37529,7 @@ "type": { "type": "reflection", "declaration": { - "id": 564, + "id": 590, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -34161,14 +37542,14 @@ } ], "indexSignature": { - "id": 565, + "id": 591, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 566, + "id": 592, "name": "key", "kind": 32768, "flags": {}, @@ -34190,14 +37571,14 @@ "type": { "type": "reflection", "declaration": { - "id": 559, + "id": 585, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 562, + "id": 588, "name": "currentPresences", "kind": 1024, "kindString": "Property", @@ -34216,7 +37597,7 @@ "typeArguments": [ { "type": "reference", - "id": 567, + "id": 593, "name": "T" } ], @@ -34225,7 +37606,7 @@ } }, { - "id": 560, + "id": 586, "name": "event", "kind": 1024, "kindString": "Property", @@ -34244,7 +37625,7 @@ [ { "type": "reference", - "id": 599, + "id": 626, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" }, "" @@ -34253,7 +37634,7 @@ } }, { - "id": 561, + "id": 587, "name": "key", "kind": 1024, "kindString": "Property", @@ -34271,7 +37652,7 @@ } }, { - "id": 563, + "id": 589, "name": "newPresences", "kind": 1024, "kindString": "Property", @@ -34290,7 +37671,7 @@ "typeArguments": [ { "type": "reference", - "id": 567, + "id": 593, "name": "T" } ], @@ -34303,7 +37684,7 @@ { "title": "Properties", "kind": 1024, - "children": [562, 560, 561, 563] + "children": [588, 586, 587, 589] } ], "sources": [ @@ -34317,7 +37698,7 @@ } }, { - "id": 568, + "id": 594, "name": "RealtimePresenceLeavePayload", "kind": 4194304, "kindString": "Type alias", @@ -34331,7 +37712,7 @@ ], "typeParameter": [ { - "id": 577, + "id": 603, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -34339,7 +37720,7 @@ "type": { "type": "reflection", "declaration": { - "id": 574, + "id": 600, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -34352,14 +37733,14 @@ } ], "indexSignature": { - "id": 575, + "id": 601, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 576, + "id": 602, "name": "key", "kind": 32768, "flags": {}, @@ -34381,14 +37762,14 @@ "type": { "type": "reflection", "declaration": { - "id": 569, + "id": 595, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 572, + "id": 598, "name": "currentPresences", "kind": 1024, "kindString": "Property", @@ -34407,7 +37788,7 @@ "typeArguments": [ { "type": "reference", - "id": 577, + "id": 603, "name": "T" } ], @@ -34416,7 +37797,7 @@ } }, { - "id": 570, + "id": 596, "name": "event", "kind": 1024, "kindString": "Property", @@ -34435,7 +37816,7 @@ [ { "type": "reference", - "id": 600, + "id": 627, "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" }, "" @@ -34444,7 +37825,7 @@ } }, { - "id": 571, + "id": 597, "name": "key", "kind": 1024, "kindString": "Property", @@ -34462,7 +37843,7 @@ } }, { - "id": 573, + "id": 599, "name": "leftPresences", "kind": 1024, "kindString": "Property", @@ -34481,7 +37862,7 @@ "typeArguments": [ { "type": "reference", - "id": 577, + "id": 603, "name": "T" } ], @@ -34494,7 +37875,7 @@ { "title": "Properties", "kind": 1024, - "children": [572, 570, 571, 573] + "children": [598, 596, 597, 599] } ], "sources": [ @@ -34508,7 +37889,7 @@ } }, { - "id": 578, + "id": 604, "name": "RealtimePresenceState", "kind": 4194304, "kindString": "Type alias", @@ -34522,7 +37903,7 @@ ], "typeParameter": [ { - "id": 586, + "id": 612, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -34530,7 +37911,7 @@ "type": { "type": "reflection", "declaration": { - "id": 582, + "id": 608, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -34543,14 +37924,14 @@ } ], "indexSignature": { - "id": 583, + "id": 609, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 584, + "id": 610, "name": "key", "kind": 32768, "flags": {}, @@ -34570,7 +37951,7 @@ "default": { "type": "reflection", "declaration": { - "id": 585, + "id": 611, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -34589,7 +37970,7 @@ "type": { "type": "reflection", "declaration": { - "id": 579, + "id": 605, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -34602,14 +37983,14 @@ } ], "indexSignature": { - "id": 580, + "id": 606, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 581, + "id": 607, "name": "key", "kind": 32768, "flags": {}, @@ -34626,7 +38007,7 @@ "typeArguments": [ { "type": "reference", - "id": 586, + "id": 612, "name": "T" } ], @@ -34638,7 +38019,7 @@ } }, { - "id": 587, + "id": 613, "name": "RealtimeRemoveChannelResponse", "kind": 4194304, "kindString": "Type alias", @@ -34646,7 +38027,7 @@ "sources": [ { "fileName": "src/RealtimeClient.ts", - "line": 42, + "line": 54, "character": 12 } ], @@ -34669,7 +38050,7 @@ } }, { - "id": 606, + "id": 633, "name": "REALTIME_CHANNEL_STATES", "kind": 32, "kindString": "Variable", @@ -34679,7 +38060,7 @@ "sources": [ { "fileName": "src/RealtimeChannel.ts", - "line": 108, + "line": 111, "character": 13 } ], @@ -34697,22 +38078,22 @@ { "title": "Enumerations", "kind": 8, - "children": [588, 592, 597, 601] + "children": [614, 619, 624, 628] }, { "title": "Classes", "kind": 128, - "children": [64, 359, 1] + "children": [64, 371, 1] }, { "title": "Type Aliases", "kind": 4194304, - "children": [347, 358, 491, 510, 517, 524, 548, 529, 539, 558, 568, 578, 587] + "children": [358, 370, 513, 536, 543, 550, 574, 555, 565, 584, 594, 604, 613] }, { "title": "Variables", "kind": 32, - "children": [606] + "children": [633] } ], "sources": [ diff --git a/apps/docs/spec/enrichments/tsdoc_v2/storage.json b/apps/docs/spec/enrichments/tsdoc_v2/storage.json index ae28edd288f..88fdb1b72c9 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/storage.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/storage.json @@ -13,14 +13,14 @@ "flags": {}, "children": [ { - "id": 449, + "id": 498, "name": "StorageApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 450, + "id": 499, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -34,14 +34,14 @@ ], "signatures": [ { - "id": 451, + "id": 500, "name": "new StorageApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 452, + "id": 501, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -52,7 +52,7 @@ } }, { - "id": 453, + "id": 502, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -65,24 +65,24 @@ ], "type": { "type": "reference", - "id": 449, + "id": 498, "name": "StorageApiError" }, "overwrites": { "type": "reference", - "id": 446, + "id": 495, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 445, + "id": 494, "name": "StorageError.constructor" } }, { - "id": 454, + "id": 503, "name": "status", "kind": 1024, "kindString": "Property", @@ -100,7 +100,7 @@ } }, { - "id": 455, + "id": 504, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -114,7 +114,7 @@ ], "signatures": [ { - "id": 456, + "id": 505, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -122,14 +122,14 @@ "type": { "type": "reflection", "declaration": { - "id": 457, + "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 459, + "id": 508, "name": "message", "kind": 1024, "kindString": "Property", @@ -148,7 +148,7 @@ "defaultValue": "..." }, { - "id": 458, + "id": 507, "name": "name", "kind": 1024, "kindString": "Property", @@ -167,7 +167,7 @@ "defaultValue": "..." }, { - "id": 460, + "id": 509, "name": "status", "kind": 1024, "kindString": "Property", @@ -190,7 +190,7 @@ { "title": "Properties", "kind": 1024, - "children": [459, 458, 460] + "children": [508, 507, 509] } ] } @@ -203,17 +203,17 @@ { "title": "Constructors", "kind": 512, - "children": [450] + "children": [499] }, { "title": "Properties", "kind": 1024, - "children": [454] + "children": [503] }, { "title": "Methods", "kind": 2048, - "children": [455] + "children": [504] } ], "sources": [ @@ -226,20 +226,20 @@ "extendedTypes": [ { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } ] }, { - "id": 304, + "id": 333, "name": "StorageClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 305, + "id": 334, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -253,14 +253,14 @@ ], "signatures": [ { - "id": 306, + "id": 335, "name": "new StorageClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 307, + "id": 336, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -271,7 +271,7 @@ } }, { - "id": 308, + "id": 337, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -279,20 +279,20 @@ "type": { "type": "reflection", "declaration": { - "id": 309, + "id": 338, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 310, + "id": 339, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 311, + "id": 340, "name": "key", "kind": 32768, "flags": {}, @@ -312,7 +312,7 @@ "defaultValue": "{}" }, { - "id": 312, + "id": 341, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -322,21 +322,21 @@ "type": { "type": "reflection", "declaration": { - "id": 313, + "id": 342, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 314, + "id": 343, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 315, + "id": 344, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -349,7 +349,7 @@ } }, { - "id": 316, + "id": 345, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -386,7 +386,7 @@ ], "type": { "type": "reference", - "id": 304, + "id": 333, "name": "StorageClient" }, "overwrites": { @@ -403,7 +403,7 @@ } }, { - "id": 347, + "id": 376, "name": "createBucket", "kind": 2048, "kindString": "Method", @@ -417,7 +417,7 @@ ], "signatures": [ { - "id": 348, + "id": 377, "name": "createBucket", "kind": 4096, "kindString": "Call signature", @@ -428,7 +428,7 @@ }, "parameters": [ { - "id": 349, + "id": 378, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -442,7 +442,7 @@ } }, { - "id": 350, + "id": 379, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -450,14 +450,14 @@ "type": { "type": "reflection", "declaration": { - "id": 351, + "id": 380, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 383, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -492,7 +492,7 @@ } }, { - "id": 353, + "id": 382, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -528,7 +528,7 @@ } }, { - "id": 352, + "id": 381, "name": "public", "kind": 1024, "kindString": "Property", @@ -553,7 +553,7 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353, 352] + "children": [383, 382, 381] } ] } @@ -570,14 +570,14 @@ { "type": "reflection", "declaration": { - "id": 355, + "id": 384, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 356, + "id": 385, "name": "data", "kind": 1024, "kindString": "Property", @@ -594,7 +594,7 @@ "typeArguments": [ { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" }, { @@ -608,7 +608,7 @@ } }, { - "id": 357, + "id": 386, "name": "error", "kind": 1024, "kindString": "Property", @@ -630,7 +630,7 @@ { "title": "Properties", "kind": 1024, - "children": [356, 357] + "children": [385, 386] } ] } @@ -638,14 +638,14 @@ { "type": "reflection", "declaration": { - "id": 358, + "id": 387, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 359, + "id": 388, "name": "data", "kind": 1024, "kindString": "Property", @@ -663,7 +663,7 @@ } }, { - "id": 360, + "id": 389, "name": "error", "kind": 1024, "kindString": "Property", @@ -677,7 +677,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -686,7 +686,7 @@ { "title": "Properties", "kind": 1024, - "children": [359, 360] + "children": [388, 389] } ] } @@ -712,7 +712,7 @@ } }, { - "id": 388, + "id": 417, "name": "deleteBucket", "kind": 2048, "kindString": "Method", @@ -726,7 +726,7 @@ ], "signatures": [ { - "id": 389, + "id": 418, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", @@ -736,7 +736,7 @@ }, "parameters": [ { - "id": 390, + "id": 419, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -759,14 +759,14 @@ { "type": "reflection", "declaration": { - "id": 391, + "id": 420, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 392, + "id": 421, "name": "data", "kind": 1024, "kindString": "Property", @@ -781,14 +781,14 @@ "type": { "type": "reflection", "declaration": { - "id": 393, + "id": 422, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 394, + "id": 423, "name": "message", "kind": 1024, "kindString": "Property", @@ -810,14 +810,14 @@ { "title": "Properties", "kind": 1024, - "children": [394] + "children": [423] } ] } } }, { - "id": 395, + "id": 424, "name": "error", "kind": 1024, "kindString": "Property", @@ -839,7 +839,7 @@ { "title": "Properties", "kind": 1024, - "children": [392, 395] + "children": [421, 424] } ] } @@ -847,14 +847,14 @@ { "type": "reflection", "declaration": { - "id": 396, + "id": 425, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 397, + "id": 426, "name": "data", "kind": 1024, "kindString": "Property", @@ -872,7 +872,7 @@ } }, { - "id": 398, + "id": 427, "name": "error", "kind": 1024, "kindString": "Property", @@ -886,7 +886,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -895,7 +895,7 @@ { "title": "Properties", "kind": 1024, - "children": [397, 398] + "children": [426, 427] } ] } @@ -921,7 +921,7 @@ } }, { - "id": 377, + "id": 406, "name": "emptyBucket", "kind": 2048, "kindString": "Method", @@ -935,7 +935,7 @@ ], "signatures": [ { - "id": 378, + "id": 407, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", @@ -945,7 +945,7 @@ }, "parameters": [ { - "id": 379, + "id": 408, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -968,14 +968,14 @@ { "type": "reflection", "declaration": { - "id": 380, + "id": 409, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 381, + "id": 410, "name": "data", "kind": 1024, "kindString": "Property", @@ -990,14 +990,14 @@ "type": { "type": "reflection", "declaration": { - "id": 382, + "id": 411, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 383, + "id": 412, "name": "message", "kind": 1024, "kindString": "Property", @@ -1019,14 +1019,14 @@ { "title": "Properties", "kind": 1024, - "children": [383] + "children": [412] } ] } } }, { - "id": 384, + "id": 413, "name": "error", "kind": 1024, "kindString": "Property", @@ -1048,7 +1048,7 @@ { "title": "Properties", "kind": 1024, - "children": [381, 384] + "children": [410, 413] } ] } @@ -1056,14 +1056,14 @@ { "type": "reflection", "declaration": { - "id": 385, + "id": 414, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 386, + "id": 415, "name": "data", "kind": 1024, "kindString": "Property", @@ -1081,7 +1081,7 @@ } }, { - "id": 387, + "id": 416, "name": "error", "kind": 1024, "kindString": "Property", @@ -1095,7 +1095,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -1104,7 +1104,7 @@ { "title": "Properties", "kind": 1024, - "children": [386, 387] + "children": [415, 416] } ] } @@ -1130,7 +1130,7 @@ } }, { - "id": 317, + "id": 346, "name": "from", "kind": 2048, "kindString": "Method", @@ -1144,7 +1144,7 @@ ], "signatures": [ { - "id": 318, + "id": 347, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1154,7 +1154,7 @@ }, "parameters": [ { - "id": 319, + "id": 348, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -1177,7 +1177,7 @@ ] }, { - "id": 338, + "id": 367, "name": "getBucket", "kind": 2048, "kindString": "Method", @@ -1191,7 +1191,7 @@ ], "signatures": [ { - "id": 339, + "id": 368, "name": "getBucket", "kind": 4096, "kindString": "Call signature", @@ -1201,7 +1201,7 @@ }, "parameters": [ { - "id": 340, + "id": 369, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -1224,14 +1224,14 @@ { "type": "reflection", "declaration": { - "id": 341, + "id": 370, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 371, "name": "data", "kind": 1024, "kindString": "Property", @@ -1245,12 +1245,12 @@ ], "type": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } }, { - "id": 343, + "id": 372, "name": "error", "kind": 1024, "kindString": "Property", @@ -1272,7 +1272,7 @@ { "title": "Properties", "kind": 1024, - "children": [342, 343] + "children": [371, 372] } ] } @@ -1280,14 +1280,14 @@ { "type": "reflection", "declaration": { - "id": 344, + "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 345, + "id": 374, "name": "data", "kind": 1024, "kindString": "Property", @@ -1305,7 +1305,7 @@ } }, { - "id": 346, + "id": 375, "name": "error", "kind": 1024, "kindString": "Property", @@ -1319,7 +1319,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -1328,7 +1328,7 @@ { "title": "Properties", "kind": 1024, - "children": [345, 346] + "children": [374, 375] } ] } @@ -1354,7 +1354,7 @@ } }, { - "id": 330, + "id": 359, "name": "listBuckets", "kind": 2048, "kindString": "Method", @@ -1368,7 +1368,7 @@ ], "signatures": [ { - "id": 331, + "id": 360, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", @@ -1385,14 +1385,14 @@ { "type": "reflection", "declaration": { - "id": 332, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 333, + "id": 362, "name": "data", "kind": 1024, "kindString": "Property", @@ -1408,13 +1408,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } } }, { - "id": 334, + "id": 363, "name": "error", "kind": 1024, "kindString": "Property", @@ -1436,7 +1436,7 @@ { "title": "Properties", "kind": 1024, - "children": [333, 334] + "children": [362, 363] } ] } @@ -1444,14 +1444,14 @@ { "type": "reflection", "declaration": { - "id": 335, + "id": 364, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 336, + "id": 365, "name": "data", "kind": 1024, "kindString": "Property", @@ -1469,7 +1469,7 @@ } }, { - "id": 337, + "id": 366, "name": "error", "kind": 1024, "kindString": "Property", @@ -1483,7 +1483,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -1492,7 +1492,7 @@ { "title": "Properties", "kind": 1024, - "children": [336, 337] + "children": [365, 366] } ] } @@ -1518,7 +1518,7 @@ } }, { - "id": 361, + "id": 390, "name": "updateBucket", "kind": 2048, "kindString": "Method", @@ -1532,7 +1532,7 @@ ], "signatures": [ { - "id": 362, + "id": 391, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", @@ -1542,7 +1542,7 @@ }, "parameters": [ { - "id": 363, + "id": 392, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -1556,7 +1556,7 @@ } }, { - "id": 364, + "id": 393, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -1564,14 +1564,14 @@ "type": { "type": "reflection", "declaration": { - "id": 365, + "id": 394, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 368, + "id": 397, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -1606,7 +1606,7 @@ } }, { - "id": 367, + "id": 396, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -1642,7 +1642,7 @@ } }, { - "id": 366, + "id": 395, "name": "public", "kind": 1024, "kindString": "Property", @@ -1667,7 +1667,7 @@ { "title": "Properties", "kind": 1024, - "children": [368, 367, 366] + "children": [397, 396, 395] } ] } @@ -1683,14 +1683,14 @@ { "type": "reflection", "declaration": { - "id": 369, + "id": 398, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 370, + "id": 399, "name": "data", "kind": 1024, "kindString": "Property", @@ -1705,14 +1705,14 @@ "type": { "type": "reflection", "declaration": { - "id": 371, + "id": 400, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 372, + "id": 401, "name": "message", "kind": 1024, "kindString": "Property", @@ -1734,14 +1734,14 @@ { "title": "Properties", "kind": 1024, - "children": [372] + "children": [401] } ] } } }, { - "id": 373, + "id": 402, "name": "error", "kind": 1024, "kindString": "Property", @@ -1763,7 +1763,7 @@ { "title": "Properties", "kind": 1024, - "children": [370, 373] + "children": [399, 402] } ] } @@ -1771,14 +1771,14 @@ { "type": "reflection", "declaration": { - "id": 374, + "id": 403, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 375, + "id": 404, "name": "data", "kind": 1024, "kindString": "Property", @@ -1796,7 +1796,7 @@ } }, { - "id": 376, + "id": 405, "name": "error", "kind": 1024, "kindString": "Property", @@ -1810,7 +1810,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -1819,7 +1819,7 @@ { "title": "Properties", "kind": 1024, - "children": [375, 376] + "children": [404, 405] } ] } @@ -1849,12 +1849,12 @@ { "title": "Constructors", "kind": 512, - "children": [305] + "children": [334] }, { "title": "Methods", "kind": 2048, - "children": [347, 388, 377, 317, 338, 330, 361] + "children": [376, 417, 406, 346, 367, 359, 390] } ], "sources": [ @@ -1873,14 +1873,14 @@ ] }, { - "id": 444, + "id": 493, "name": "StorageError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 445, + "id": 494, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1894,14 +1894,14 @@ ], "signatures": [ { - "id": 446, + "id": 495, "name": "new StorageError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 447, + "id": 496, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1914,7 +1914,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" }, "overwrites": { @@ -1933,7 +1933,7 @@ { "title": "Constructors", "kind": 512, - "children": [445] + "children": [494] } ], "sources": [ @@ -1954,25 +1954,25 @@ "extendedBy": [ { "type": "reference", - "id": 449, + "id": 498, "name": "StorageApiError" }, { "type": "reference", - "id": 462, + "id": 511, "name": "StorageUnknownError" } ] }, { - "id": 462, + "id": 511, "name": "StorageUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 463, + "id": 512, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1986,14 +1986,14 @@ ], "signatures": [ { - "id": 464, + "id": 513, "name": "new StorageUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 465, + "id": 514, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2004,7 +2004,7 @@ } }, { - "id": 466, + "id": 515, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -2017,24 +2017,24 @@ ], "type": { "type": "reference", - "id": 462, + "id": 511, "name": "StorageUnknownError" }, "overwrites": { "type": "reference", - "id": 446, + "id": 495, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 445, + "id": 494, "name": "StorageError.constructor" } }, { - "id": 467, + "id": 516, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -2056,12 +2056,12 @@ { "title": "Constructors", "kind": 512, - "children": [463] + "children": [512] }, { "title": "Properties", "kind": 1024, - "children": [467] + "children": [516] } ], "sources": [ @@ -2074,20 +2074,20 @@ "extendedTypes": [ { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } ] }, { - "id": 399, + "id": 428, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 404, + "id": 433, "name": "allowed_mime_types", "kind": 1024, "kindString": "Property", @@ -2110,7 +2110,7 @@ } }, { - "id": 405, + "id": 434, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2128,7 +2128,7 @@ } }, { - "id": 403, + "id": 432, "name": "file_size_limit", "kind": 1024, "kindString": "Property", @@ -2148,7 +2148,7 @@ } }, { - "id": 400, + "id": 429, "name": "id", "kind": 1024, "kindString": "Property", @@ -2166,7 +2166,7 @@ } }, { - "id": 401, + "id": 430, "name": "name", "kind": 1024, "kindString": "Property", @@ -2184,7 +2184,7 @@ } }, { - "id": 402, + "id": 431, "name": "owner", "kind": 1024, "kindString": "Property", @@ -2202,7 +2202,7 @@ } }, { - "id": 407, + "id": 436, "name": "public", "kind": 1024, "kindString": "Property", @@ -2220,7 +2220,7 @@ } }, { - "id": 406, + "id": 435, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2242,7 +2242,7 @@ { "title": "Properties", "kind": 1024, - "children": [404, 405, 403, 400, 401, 402, 407, 406] + "children": [433, 434, 432, 429, 430, 431, 436, 435] } ], "sources": [ @@ -2254,14 +2254,57 @@ ] }, { - "id": 431, + "id": 471, + "name": "DestinationOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 472, + "name": "destinationBucket", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [472] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 74, + "character": 17 + } + ] + }, + { + "id": 478, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 432, + "id": 479, "name": "signal", "kind": 1024, "kindString": "Property", @@ -2274,7 +2317,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 104, "character": 2 } ], @@ -2290,26 +2333,26 @@ { "title": "Properties", "kind": 1024, - "children": [432] + "children": [479] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 100, "character": 17 } ] }, { - "id": 408, + "id": 437, "name": "FileObject", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 410, + "id": 439, "name": "bucket_id", "kind": 1024, "kindString": "Property", @@ -2327,7 +2370,7 @@ } }, { - "id": 417, + "id": 446, "name": "buckets", "kind": 1024, "kindString": "Property", @@ -2341,12 +2384,12 @@ ], "type": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } }, { - "id": 414, + "id": 443, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2364,7 +2407,7 @@ } }, { - "id": 412, + "id": 441, "name": "id", "kind": 1024, "kindString": "Property", @@ -2382,7 +2425,7 @@ } }, { - "id": 415, + "id": 444, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", @@ -2400,7 +2443,7 @@ } }, { - "id": 416, + "id": 445, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -2430,7 +2473,7 @@ } }, { - "id": 409, + "id": 438, "name": "name", "kind": 1024, "kindString": "Property", @@ -2448,7 +2491,7 @@ } }, { - "id": 411, + "id": 440, "name": "owner", "kind": 1024, "kindString": "Property", @@ -2466,7 +2509,7 @@ } }, { - "id": 413, + "id": 442, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2488,7 +2531,7 @@ { "title": "Properties", "kind": 1024, - "children": [410, 417, 414, 412, 415, 416, 409, 411, 413] + "children": [439, 446, 443, 441, 444, 445, 438, 440, 442] } ], "sources": [ @@ -2500,23 +2543,38 @@ ] }, { - "id": 421, - "name": "FileOptions", + "id": 447, + "name": "FileObjectV2", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 422, - "name": "cacheControl", + "id": 451, + "name": "bucket_id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 28, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 456, + "name": "cache_control", "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", @@ -2530,20 +2588,17 @@ } }, { - "id": 423, - "name": "contentType", + "id": 457, + "name": "content_type", "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": 37, + "line": 34, "character": 2 } ], @@ -2553,176 +2608,15 @@ } }, { - "id": 425, - "name": "duplex", - "kind": 1024, - "kindString": "Property", - "flags": { - "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." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 45, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 424, - "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": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [422, 423, 425, 424] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 29, - "character": 17 - } - ] - }, - { - "id": 433, - "name": "Metadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 434, - "name": "name", + "id": 453, + "name": "created_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 79, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [434] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 78, - "character": 17 - } - ] - }, - { - "id": 426, - "name": "SearchOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 427, - "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": 52, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 428, - "name": "offset", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The starting position." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "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": 67, + "line": 30, "character": 2 } ], @@ -2732,60 +2626,31 @@ } }, { - "id": 429, - "name": "sortBy", + "id": 458, + "name": "etag", "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": 62, + "line": 35, "character": 2 } ], "type": { - "type": "reference", - "id": 418, - "name": "SortBy" + "type": "intrinsic", + "name": "string" } - } - ], - "groups": [ + }, { - "title": "Properties", - "kind": 1024, - "children": [427, 428, 430, 429] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 48, - "character": 17 - } - ] - }, - { - "id": 418, - "name": "SortBy", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 419, - "name": "column", + "id": 448, + "name": "id", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -2799,13 +2664,137 @@ } }, { - "id": 420, - "name": "order", + "id": 454, + "name": "last_accessed_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 31, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 459, + "name": "last_modified", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 36, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 460, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 450, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 27, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 455, + "name": "size", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 32, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 452, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 29, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 449, + "name": "version", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -2823,7 +2812,7 @@ { "title": "Properties", "kind": 1024, - "children": [419, 420] + "children": [451, 456, 457, 453, 458, 448, 454, 459, 460, 450, 455, 452, 449] } ], "sources": [ @@ -2835,14 +2824,419 @@ ] }, { - "id": 435, + "id": 464, + "name": "FileOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 465, + "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": 49, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 466, + "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": 53, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 468, + "name": "duplex", + "kind": 1024, + "kindString": "Property", + "flags": { + "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." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 61, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 470, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optionally add extra headers" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 469, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "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." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 467, + "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": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [465, 466, 468, 470, 469, 467] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 17 + } + ] + }, + { + "id": 480, + "name": "Metadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 481, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 109, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [481] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 17 + } + ] + }, + { + "id": 473, + "name": "SearchOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 474, + "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": 82, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 475, + "name": "offset", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The starting position." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 87, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 477, + "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": 97, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 476, + "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": 92, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 461, + "name": "SortBy" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [474, 475, 477, 476] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 78, + "character": 17 + } + ] + }, + { + "id": 461, + "name": "SortBy", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 462, + "name": "column", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 463, + "name": "order", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [462, 463] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 40, + "character": 17 + } + ] + }, + { + "id": 482, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 440, + "id": 487, "name": "format", "kind": 1024, "kindString": "Property", @@ -2856,7 +3250,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 110, + "line": 140, "character": 2 } ], @@ -2866,7 +3260,7 @@ } }, { - "id": 437, + "id": 484, "name": "height", "kind": 1024, "kindString": "Property", @@ -2879,7 +3273,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 90, + "line": 120, "character": 2 } ], @@ -2889,7 +3283,7 @@ } }, { - "id": 439, + "id": 486, "name": "quality", "kind": 1024, "kindString": "Property", @@ -2902,7 +3296,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 103, + "line": 133, "character": 2 } ], @@ -2912,7 +3306,7 @@ } }, { - "id": 438, + "id": 485, "name": "resize", "kind": 1024, "kindString": "Property", @@ -2925,7 +3319,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 127, "character": 2 } ], @@ -2948,7 +3342,7 @@ } }, { - "id": 436, + "id": 483, "name": "width", "kind": 1024, "kindString": "Property", @@ -2961,7 +3355,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 116, "character": 2 } ], @@ -2975,19 +3369,89 @@ { "title": "Properties", "kind": 1024, - "children": [440, 437, 439, 438, 436] + "children": [487, 484, 486, 485, 483] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 112, "character": 17 } ] }, { - "id": 441, + "id": 488, + "name": "Camelize", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 147, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 489, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "mapped", + "parameter": "K", + "parameterType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 489, + "name": "T" + } + }, + "templateType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "name": "K" + }, + "objectType": { + "type": "reference", + "id": 489, + "name": "T" + } + }, + "nameType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "K" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Extract", + "package": "typescript", + "name": "Extract" + } + ], + "name": "CamelCase" + } + } + }, + { + "id": 490, "name": "isStorageError", "kind": 64, "kindString": "Function", @@ -3001,14 +3465,14 @@ ], "signatures": [ { - "id": 442, + "id": 491, "name": "isStorageError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 443, + "id": 492, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -3025,7 +3489,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -3037,17 +3501,22 @@ { "title": "Classes", "kind": 128, - "children": [449, 304, 444, 462] + "children": [498, 333, 493, 511] }, { "title": "Interfaces", "kind": 256, - "children": [399, 431, 408, 421, 433, 426, 418, 435] + "children": [428, 471, 478, 437, 447, 464, 480, 473, 461, 482] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [488] }, { "title": "Functions", "kind": 64, - "children": [441] + "children": [490] } ], "sources": [ @@ -3418,7 +3887,7 @@ "typeArguments": [ { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" }, { @@ -3501,7 +3970,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -3700,7 +4169,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -3899,7 +4368,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -3992,7 +4461,7 @@ ], "type": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } }, @@ -4066,7 +4535,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -4145,7 +4614,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } } @@ -4220,7 +4689,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -4537,7 +5006,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -4584,7 +5053,7 @@ "extendedBy": [ { "type": "reference", - "id": 304, + "id": 333, "name": "StorageClient" } ] @@ -4628,7 +5097,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 45, + "line": 48, "character": 2 } ], @@ -4787,7 +5256,7 @@ ] }, { - "id": 207, + "id": 211, "name": "copy", "kind": 2048, "kindString": "Method", @@ -4795,13 +5264,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 338, + "line": 373, "character": 8 } ], "signatures": [ { - "id": 208, + "id": 212, "name": "copy", "kind": 4096, "kindString": "Call signature", @@ -4811,7 +5280,7 @@ }, "parameters": [ { - "id": 209, + "id": 213, "name": "fromPath", "kind": 32768, "kindString": "Parameter", @@ -4825,18 +5294,35 @@ } }, { - "id": 210, + "id": 214, "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" + "shortText": "The new file path, including the new file name. For example `folder/image-copy.png`." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 215, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The destination options.\n" + }, + "type": { + "type": "reference", + "id": 471, + "name": "DestinationOptions" + } } ], "type": { @@ -4845,94 +5331,6 @@ { "type": "union", "types": [ - { - "type": "reflection", - "declaration": { - "id": 211, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 212, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 343, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 213, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 214, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 343, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [214] - } - ] - } - } - }, - { - "id": 215, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 344, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [212, 215] - } - ] - } - }, { "type": "reflection", "declaration": { @@ -4951,7 +5349,95 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 347, + "line": 379, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 218, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 219, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 379, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [219] + } + ] + } + } + }, + { + "id": 220, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 380, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [217, 220] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 221, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 222, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 383, "character": 8 } ], @@ -4961,7 +5447,7 @@ } }, { - "id": 218, + "id": 223, "name": "error", "kind": 1024, "kindString": "Property", @@ -4969,13 +5455,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 348, + "line": 384, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -4984,7 +5470,7 @@ { "title": "Properties", "kind": 1024, - "children": [217, 218] + "children": [222, 223] } ] } @@ -5008,7 +5494,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 223, + "line": 243, "character": 8 } ], @@ -5030,12 +5516,61 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`.\n" + "shortText": "The file path, including the current file name. For example `folder/image.png`." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 170, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 171, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 172, + "name": "upsert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "If set to true, allows the file to be overwritten if it already exists.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 245, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [172] + } + ] + } + } } ], "type": { @@ -5047,14 +5582,14 @@ { "type": "reflection", "declaration": { - "id": 170, + "id": 173, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 171, + "id": 174, "name": "data", "kind": 1024, "kindString": "Property", @@ -5062,21 +5597,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, + "line": 248, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 172, + "id": 175, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 175, + "id": 178, "name": "path", "kind": 1024, "kindString": "Property", @@ -5084,7 +5619,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, + "line": 248, "character": 50 } ], @@ -5094,7 +5629,7 @@ } }, { - "id": 173, + "id": 176, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -5102,7 +5637,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, + "line": 248, "character": 16 } ], @@ -5112,7 +5647,7 @@ } }, { - "id": 174, + "id": 177, "name": "token", "kind": 1024, "kindString": "Property", @@ -5120,7 +5655,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, + "line": 248, "character": 35 } ], @@ -5134,67 +5669,12 @@ { "title": "Properties", "kind": 1024, - "children": [175, 173, 174] + "children": [178, 176, 177] } ] } } }, - { - "id": 176, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 228, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [171, 176] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 177, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 178, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 231, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, { "id": 179, "name": "error", @@ -5204,13 +5684,68 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 232, + "line": 249, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [174, 179] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 180, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 181, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 252, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 182, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 253, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -5219,7 +5754,7 @@ { "title": "Properties", "kind": 1024, - "children": [178, 179] + "children": [181, 182] } ] } @@ -5235,7 +5770,7 @@ ] }, { - "id": 219, + "id": 224, "name": "createSignedUrl", "kind": 2048, "kindString": "Method", @@ -5243,13 +5778,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 376, + "line": 417, "character": 8 } ], "signatures": [ { - "id": 220, + "id": 225, "name": "createSignedUrl", "kind": 4096, "kindString": "Call signature", @@ -5259,7 +5794,7 @@ }, "parameters": [ { - "id": 221, + "id": 226, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -5273,7 +5808,7 @@ } }, { - "id": 222, + "id": 227, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", @@ -5287,7 +5822,7 @@ } }, { - "id": 223, + "id": 228, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5297,14 +5832,14 @@ "type": { "type": "reflection", "declaration": { - "id": 224, + "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 230, "name": "download", "kind": 1024, "kindString": "Property", @@ -5317,7 +5852,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 379, + "line": 420, "character": 16 } ], @@ -5336,7 +5871,7 @@ } }, { - "id": 226, + "id": 231, "name": "transform", "kind": 1024, "kindString": "Property", @@ -5349,13 +5884,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 379, + "line": 420, "character": 45 } ], "type": { "type": "reference", - "id": 435, + "id": 482, "name": "TransformOptions" } } @@ -5364,7 +5899,7 @@ { "title": "Properties", "kind": 1024, - "children": [225, 226] + "children": [230, 231] } ] } @@ -5377,94 +5912,6 @@ { "type": "union", "types": [ - { - "type": "reflection", - "declaration": { - "id": 227, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 228, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 382, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 229, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 230, - "name": "signedUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 382, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [230] - } - ] - } - } - }, - { - "id": 231, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 383, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [228, 231] - } - ] - } - }, { "type": "reflection", "declaration": { @@ -5483,7 +5930,95 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 386, + "line": 423, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 234, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 235, + "name": "signedUrl", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 423, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [235] + } + ] + } + } + }, + { + "id": 236, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 424, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [233, 236] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 237, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 238, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 427, "character": 8 } ], @@ -5493,7 +6028,7 @@ } }, { - "id": 234, + "id": 239, "name": "error", "kind": 1024, "kindString": "Property", @@ -5501,13 +6036,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 387, + "line": 428, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -5516,7 +6051,7 @@ { "title": "Properties", "kind": 1024, - "children": [233, 234] + "children": [238, 239] } ] } @@ -5532,7 +6067,7 @@ ] }, { - "id": 235, + "id": 240, "name": "createSignedUrls", "kind": 2048, "kindString": "Method", @@ -5540,13 +6075,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 421, + "line": 462, "character": 8 } ], "signatures": [ { - "id": 236, + "id": 241, "name": "createSignedUrls", "kind": 4096, "kindString": "Call signature", @@ -5556,7 +6091,7 @@ }, "parameters": [ { - "id": 237, + "id": 242, "name": "paths", "kind": 32768, "kindString": "Parameter", @@ -5573,7 +6108,7 @@ } }, { - "id": 238, + "id": 243, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", @@ -5587,7 +6122,7 @@ } }, { - "id": 239, + "id": 244, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5597,14 +6132,14 @@ "type": { "type": "reflection", "declaration": { - "id": 240, + "id": 245, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 241, + "id": 246, "name": "download", "kind": 1024, "kindString": "Property", @@ -5615,7 +6150,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 424, + "line": 465, "character": 16 } ], @@ -5638,7 +6173,7 @@ { "title": "Properties", "kind": 1024, - "children": [241] + "children": [246] } ] } @@ -5654,14 +6189,14 @@ { "type": "reflection", "declaration": { - "id": 242, + "id": 247, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 243, + "id": 248, "name": "data", "kind": 1024, "kindString": "Property", @@ -5669,7 +6204,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 427, + "line": 468, "character": 8 } ], @@ -5678,14 +6213,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 244, + "id": 249, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 245, + "id": 250, "name": "error", "kind": 1024, "kindString": "Property", @@ -5693,7 +6228,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 427, + "line": 468, "character": 16 } ], @@ -5712,7 +6247,7 @@ } }, { - "id": 246, + "id": 251, "name": "path", "kind": 1024, "kindString": "Property", @@ -5720,7 +6255,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 427, + "line": 468, "character": 38 } ], @@ -5739,7 +6274,7 @@ } }, { - "id": 247, + "id": 252, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -5747,7 +6282,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 427, + "line": 468, "character": 59 } ], @@ -5761,7 +6296,7 @@ { "title": "Properties", "kind": 1024, - "children": [245, 246, 247] + "children": [250, 251, 252] } ] } @@ -5769,7 +6304,7 @@ } }, { - "id": 248, + "id": 253, "name": "error", "kind": 1024, "kindString": "Property", @@ -5777,7 +6312,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 428, + "line": 469, "character": 8 } ], @@ -5791,7 +6326,7 @@ { "title": "Properties", "kind": 1024, - "children": [243, 248] + "children": [248, 253] } ] } @@ -5799,14 +6334,14 @@ { "type": "reflection", "declaration": { - "id": 249, + "id": 254, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 255, "name": "data", "kind": 1024, "kindString": "Property", @@ -5814,7 +6349,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 431, + "line": 472, "character": 8 } ], @@ -5824,7 +6359,7 @@ } }, { - "id": 251, + "id": 256, "name": "error", "kind": 1024, "kindString": "Property", @@ -5832,13 +6367,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 432, + "line": 473, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -5847,7 +6382,7 @@ { "title": "Properties", "kind": 1024, - "children": [250, 251] + "children": [255, 256] } ] } @@ -5863,7 +6398,7 @@ ] }, { - "id": 252, + "id": 257, "name": "download", "kind": 2048, "kindString": "Method", @@ -5871,13 +6406,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 470, + "line": 511, "character": 8 } ], "signatures": [ { - "id": 253, + "id": 258, "name": "download", "kind": 4096, "kindString": "Call signature", @@ -5887,7 +6422,7 @@ }, "parameters": [ { - "id": 254, + "id": 259, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -5901,7 +6436,7 @@ } }, { - "id": 255, + "id": 260, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5911,14 +6446,14 @@ "type": { "type": "reflection", "declaration": { - "id": 256, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 257, + "id": 262, "name": "transform", "kind": 1024, "kindString": "Property", @@ -5931,13 +6466,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 472, + "line": 513, "character": 16 } ], "type": { "type": "reference", - "id": 435, + "id": 482, "name": "TransformOptions" } } @@ -5946,7 +6481,7 @@ { "title": "Properties", "kind": 1024, - "children": [257] + "children": [262] } ] } @@ -5962,14 +6497,14 @@ { "type": "reflection", "declaration": { - "id": 258, + "id": 263, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 259, + "id": 264, "name": "data", "kind": 1024, "kindString": "Property", @@ -5977,7 +6512,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 475, + "line": 516, "character": 8 } ], @@ -5989,7 +6524,7 @@ } }, { - "id": 260, + "id": 265, "name": "error", "kind": 1024, "kindString": "Property", @@ -5997,7 +6532,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 476, + "line": 517, "character": 8 } ], @@ -6011,7 +6546,7 @@ { "title": "Properties", "kind": 1024, - "children": [259, 260] + "children": [264, 265] } ] } @@ -6019,14 +6554,14 @@ { "type": "reflection", "declaration": { - "id": 261, + "id": 266, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 262, + "id": 267, "name": "data", "kind": 1024, "kindString": "Property", @@ -6034,7 +6569,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 479, + "line": 520, "character": 8 } ], @@ -6044,7 +6579,7 @@ } }, { - "id": 263, + "id": 268, "name": "error", "kind": 1024, "kindString": "Property", @@ -6052,13 +6587,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 480, + "line": 521, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -6067,7 +6602,7 @@ { "title": "Properties", "kind": 1024, - "children": [262, 263] + "children": [267, 268] } ] } @@ -6083,7 +6618,173 @@ ] }, { - "id": 264, + "id": 278, + "name": "exists", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 583, + "character": 8 + } + ], + "signatures": [ + { + "id": 279, + "name": "exists", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Checks the existence of a file." + }, + "parameters": [ + { + "id": 280, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 281, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 282, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 587, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 283, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 588, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [282, 283] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 284, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 285, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 591, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 286, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 592, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 493, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [285, 286] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 287, "name": "getPublicUrl", "kind": 2048, "kindString": "Method", @@ -6091,13 +6792,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 513, + "line": 624, "character": 2 } ], "signatures": [ { - "id": 265, + "id": 288, "name": "getPublicUrl", "kind": 4096, "kindString": "Call signature", @@ -6107,7 +6808,7 @@ }, "parameters": [ { - "id": 266, + "id": 289, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -6121,7 +6822,7 @@ } }, { - "id": 267, + "id": 290, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6131,14 +6832,14 @@ "type": { "type": "reflection", "declaration": { - "id": 268, + "id": 291, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 269, + "id": 292, "name": "download", "kind": 1024, "kindString": "Property", @@ -6151,7 +6852,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 515, + "line": 626, "character": 16 } ], @@ -6170,7 +6871,7 @@ } }, { - "id": 270, + "id": 293, "name": "transform", "kind": 1024, "kindString": "Property", @@ -6183,13 +6884,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 515, + "line": 626, "character": 45 } ], "type": { "type": "reference", - "id": 435, + "id": 482, "name": "TransformOptions" } } @@ -6198,7 +6899,7 @@ { "title": "Properties", "kind": 1024, - "children": [269, 270] + "children": [292, 293] } ] } @@ -6208,14 +6909,14 @@ "type": { "type": "reflection", "declaration": { - "id": 271, + "id": 294, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 272, + "id": 295, "name": "data", "kind": 1024, "kindString": "Property", @@ -6223,21 +6924,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 516, + "line": 627, "character": 7 } ], "type": { "type": "reflection", "declaration": { - "id": 273, + "id": 296, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 274, + "id": 297, "name": "publicUrl", "kind": 1024, "kindString": "Property", @@ -6245,7 +6946,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 516, + "line": 627, "character": 15 } ], @@ -6259,7 +6960,7 @@ { "title": "Properties", "kind": 1024, - "children": [274] + "children": [297] } ] } @@ -6270,7 +6971,7 @@ { "title": "Properties", "kind": 1024, - "children": [272] + "children": [295] } ] } @@ -6279,7 +6980,181 @@ ] }, { - "id": 284, + "id": 269, + "name": "info", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 550, + "character": 8 + } + ], + "signatures": [ + { + "id": 270, + "name": "info", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves the details of an existing file." + }, + "parameters": [ + { + "id": 271, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 272, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 273, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 554, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 488, + "typeArguments": [ + { + "type": "reference", + "id": 447, + "name": "FileObjectV2" + } + ], + "name": "Camelize" + } + }, + { + "id": 274, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 555, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [273, 274] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 275, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 276, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 558, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 277, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 559, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 493, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [276, 277] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 307, "name": "list", "kind": 2048, "kindString": "Method", @@ -6287,13 +7162,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 647, + "line": 758, "character": 8 } ], "signatures": [ { - "id": 285, + "id": 308, "name": "list", "kind": 4096, "kindString": "Call signature", @@ -6303,7 +7178,7 @@ }, "parameters": [ { - "id": 286, + "id": 309, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -6319,7 +7194,7 @@ } }, { - "id": 287, + "id": 310, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6328,12 +7203,12 @@ }, "type": { "type": "reference", - "id": 426, + "id": 473, "name": "SearchOptions" } }, { - "id": 288, + "id": 311, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -6342,7 +7217,7 @@ }, "type": { "type": "reference", - "id": 431, + "id": 478, "name": "FetchParameters" } } @@ -6356,14 +7231,14 @@ { "type": "reflection", "declaration": { - "id": 289, + "id": 312, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 290, + "id": 313, "name": "data", "kind": 1024, "kindString": "Property", @@ -6371,7 +7246,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 653, + "line": 764, "character": 8 } ], @@ -6379,13 +7254,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 408, + "id": 437, "name": "FileObject" } } }, { - "id": 291, + "id": 314, "name": "error", "kind": 1024, "kindString": "Property", @@ -6393,7 +7268,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 654, + "line": 765, "character": 8 } ], @@ -6407,7 +7282,7 @@ { "title": "Properties", "kind": 1024, - "children": [290, 291] + "children": [313, 314] } ] } @@ -6415,14 +7290,14 @@ { "type": "reflection", "declaration": { - "id": 292, + "id": 315, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 293, + "id": 316, "name": "data", "kind": 1024, "kindString": "Property", @@ -6430,7 +7305,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 657, + "line": 768, "character": 8 } ], @@ -6440,7 +7315,7 @@ } }, { - "id": 294, + "id": 317, "name": "error", "kind": 1024, "kindString": "Property", @@ -6448,13 +7323,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 658, + "line": 769, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -6463,7 +7338,7 @@ { "title": "Properties", "kind": 1024, - "children": [293, 294] + "children": [316, 317] } ] } @@ -6479,7 +7354,7 @@ ] }, { - "id": 195, + "id": 198, "name": "move", "kind": 2048, "kindString": "Method", @@ -6487,13 +7362,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 302, + "line": 330, "character": 8 } ], "signatures": [ { - "id": 196, + "id": 199, "name": "move", "kind": 4096, "kindString": "Call signature", @@ -6503,7 +7378,7 @@ }, "parameters": [ { - "id": 197, + "id": 200, "name": "fromPath", "kind": 32768, "kindString": "Parameter", @@ -6517,18 +7392,35 @@ } }, { - "id": 198, + "id": 201, "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" + "shortText": "The new file path, including the new file name. For example `folder/image-new.png`." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 202, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The destination options.\n" + }, + "type": { + "type": "reference", + "id": 471, + "name": "DestinationOptions" + } } ], "type": { @@ -6540,14 +7432,14 @@ { "type": "reflection", "declaration": { - "id": 199, + "id": 203, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 200, + "id": 204, "name": "data", "kind": 1024, "kindString": "Property", @@ -6555,21 +7447,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 307, + "line": 336, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 201, + "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 202, + "id": 206, "name": "message", "kind": 1024, "kindString": "Property", @@ -6577,7 +7469,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 307, + "line": 336, "character": 16 } ], @@ -6591,14 +7483,14 @@ { "title": "Properties", "kind": 1024, - "children": [202] + "children": [206] } ] } } }, { - "id": 203, + "id": 207, "name": "error", "kind": 1024, "kindString": "Property", @@ -6606,7 +7498,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 308, + "line": 337, "character": 8 } ], @@ -6620,7 +7512,7 @@ { "title": "Properties", "kind": 1024, - "children": [200, 203] + "children": [204, 207] } ] } @@ -6628,14 +7520,14 @@ { "type": "reflection", "declaration": { - "id": 204, + "id": 208, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 205, + "id": 209, "name": "data", "kind": 1024, "kindString": "Property", @@ -6643,7 +7535,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 311, + "line": 340, "character": 8 } ], @@ -6653,7 +7545,7 @@ } }, { - "id": 206, + "id": 210, "name": "error", "kind": 1024, "kindString": "Property", @@ -6661,13 +7553,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 312, + "line": 341, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -6676,7 +7568,7 @@ { "title": "Properties", "kind": 1024, - "children": [205, 206] + "children": [209, 210] } ] } @@ -6692,7 +7584,7 @@ ] }, { - "id": 275, + "id": 298, "name": "remove", "kind": 2048, "kindString": "Method", @@ -6700,13 +7592,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 551, + "line": 662, "character": 8 } ], "signatures": [ { - "id": 276, + "id": 299, "name": "remove", "kind": 4096, "kindString": "Call signature", @@ -6716,7 +7608,7 @@ }, "parameters": [ { - "id": 277, + "id": 300, "name": "paths", "kind": 32768, "kindString": "Parameter", @@ -6742,14 +7634,14 @@ { "type": "reflection", "declaration": { - "id": 278, + "id": 301, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 279, + "id": 302, "name": "data", "kind": 1024, "kindString": "Property", @@ -6757,7 +7649,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 555, + "line": 666, "character": 8 } ], @@ -6765,13 +7657,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 408, + "id": 437, "name": "FileObject" } } }, { - "id": 280, + "id": 303, "name": "error", "kind": 1024, "kindString": "Property", @@ -6779,7 +7671,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 556, + "line": 667, "character": 8 } ], @@ -6793,7 +7685,7 @@ { "title": "Properties", "kind": 1024, - "children": [279, 280] + "children": [302, 303] } ] } @@ -6801,14 +7693,14 @@ { "type": "reflection", "declaration": { - "id": 281, + "id": 304, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 282, + "id": 305, "name": "data", "kind": 1024, "kindString": "Property", @@ -6816,7 +7708,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 559, + "line": 670, "character": 8 } ], @@ -6826,7 +7718,7 @@ } }, { - "id": 283, + "id": 306, "name": "error", "kind": 1024, "kindString": "Property", @@ -6834,13 +7726,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 560, + "line": 671, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -6849,7 +7741,7 @@ { "title": "Properties", "kind": 1024, - "children": [282, 283] + "children": [305, 306] } ] } @@ -6865,7 +7757,47 @@ ] }, { - "id": 180, + "id": 321, + "name": "toBase64", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 795, + "character": 2 + } + ], + "signatures": [ + { + "id": 322, + "name": "toBase64", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 323, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 183, "name": "update", "kind": 2048, "kindString": "Method", @@ -6873,13 +7805,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 269, + "line": 296, "character": 8 } ], "signatures": [ { - "id": 181, + "id": 184, "name": "update", "kind": 4096, "kindString": "Call signature", @@ -6889,7 +7821,7 @@ }, "parameters": [ { - "id": 182, + "id": 185, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -6903,7 +7835,7 @@ } }, { - "id": 183, + "id": 186, "name": "fileBody", "kind": 32768, "kindString": "Parameter", @@ -6984,7 +7916,7 @@ } }, { - "id": 184, + "id": 187, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", @@ -6993,7 +7925,7 @@ }, "type": { "type": "reference", - "id": 421, + "id": 464, "name": "FileOptions" } } @@ -7007,14 +7939,14 @@ { "type": "reflection", "declaration": { - "id": 185, + "id": 188, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 186, + "id": 189, "name": "data", "kind": 1024, "kindString": "Property", @@ -7022,21 +7954,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 285, + "line": 312, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 187, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 190, + "id": 193, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -7044,7 +7976,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 285, + "line": 312, "character": 42 } ], @@ -7054,7 +7986,7 @@ } }, { - "id": 188, + "id": 191, "name": "id", "kind": 1024, "kindString": "Property", @@ -7062,7 +7994,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 285, + "line": 312, "character": 16 } ], @@ -7072,7 +8004,7 @@ } }, { - "id": 189, + "id": 192, "name": "path", "kind": 1024, "kindString": "Property", @@ -7080,7 +8012,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 285, + "line": 312, "character": 28 } ], @@ -7094,67 +8026,12 @@ { "title": "Properties", "kind": 1024, - "children": [190, 188, 189] + "children": [193, 191, 192] } ] } } }, - { - "id": 191, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 286, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [186, 191] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 192, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 193, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 289, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, { "id": 194, "name": "error", @@ -7164,13 +8041,68 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 290, + "line": 313, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [189, 194] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 195, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 196, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 316, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 197, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 317, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -7179,7 +8111,7 @@ { "title": "Properties", "kind": 1024, - "children": [193, 194] + "children": [196, 197] } ] } @@ -7203,7 +8135,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 135, + "line": 154, "character": 8 } ], @@ -7256,7 +8188,7 @@ }, "type": { "type": "reference", - "id": 421, + "id": 464, "name": "FileOptions" } } @@ -7285,7 +8217,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 160, "character": 8 } ], @@ -7307,7 +8239,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 160, "character": 42 } ], @@ -7325,7 +8257,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 160, "character": 16 } ], @@ -7343,7 +8275,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 160, "character": 28 } ], @@ -7372,7 +8304,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 142, + "line": 161, "character": 8 } ], @@ -7409,7 +8341,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 145, + "line": 164, "character": 8 } ], @@ -7427,13 +8359,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 146, + "line": 165, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -7466,7 +8398,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 158, + "line": 177, "character": 8 } ], @@ -7533,7 +8465,7 @@ }, "type": { "type": "reference", - "id": 421, + "id": 464, "name": "FileOptions" } } @@ -7562,7 +8494,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 201, + "line": 220, "character": 10 } ], @@ -7584,7 +8516,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 201, + "line": 220, "character": 35 } ], @@ -7603,7 +8535,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 201, + "line": 220, "character": 18 } ], @@ -7634,7 +8566,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 202, + "line": 221, "character": 10 } ], @@ -7672,7 +8604,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 206, + "line": 225, "character": 17 } ], @@ -7723,13 +8655,15 @@ { "title": "Methods", "kind": 2048, - "children": [207, 167, 219, 235, 252, 264, 284, 195, 275, 180, 137, 152] + "children": [ + 211, 167, 224, 240, 257, 278, 287, 269, 307, 198, 298, 321, 183, 137, 152 + ] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 39, + "line": 42, "character": 21 } ] diff --git a/apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json index 46e6630c22a..fa1b7fa7cda 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json @@ -13,14 +13,14 @@ "flags": {}, "children": [ { - "id": 449, + "id": 498, "name": "StorageApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 450, + "id": 499, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -34,14 +34,14 @@ ], "signatures": [ { - "id": 451, + "id": 500, "name": "new StorageApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 452, + "id": 501, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -52,7 +52,7 @@ } }, { - "id": 453, + "id": 502, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -65,24 +65,24 @@ ], "type": { "type": "reference", - "id": 449, + "id": 498, "name": "StorageApiError" }, "overwrites": { "type": "reference", - "id": 446, + "id": 495, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 445, + "id": 494, "name": "StorageError.constructor" } }, { - "id": 454, + "id": 503, "name": "status", "kind": 1024, "kindString": "Property", @@ -100,7 +100,7 @@ } }, { - "id": 455, + "id": 504, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -114,7 +114,7 @@ ], "signatures": [ { - "id": 456, + "id": 505, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -122,14 +122,14 @@ "type": { "type": "reflection", "declaration": { - "id": 457, + "id": 506, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 459, + "id": 508, "name": "message", "kind": 1024, "kindString": "Property", @@ -148,7 +148,7 @@ "defaultValue": "..." }, { - "id": 458, + "id": 507, "name": "name", "kind": 1024, "kindString": "Property", @@ -167,7 +167,7 @@ "defaultValue": "..." }, { - "id": 460, + "id": 509, "name": "status", "kind": 1024, "kindString": "Property", @@ -190,7 +190,7 @@ { "title": "Properties", "kind": 1024, - "children": [459, 458, 460] + "children": [508, 507, 509] } ] } @@ -203,17 +203,17 @@ { "title": "Constructors", "kind": 512, - "children": [450] + "children": [499] }, { "title": "Properties", "kind": 1024, - "children": [454] + "children": [503] }, { "title": "Methods", "kind": 2048, - "children": [455] + "children": [504] } ], "sources": [ @@ -226,20 +226,20 @@ "extendedTypes": [ { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } ] }, { - "id": 304, + "id": 333, "name": "StorageClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 305, + "id": 334, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -253,14 +253,14 @@ ], "signatures": [ { - "id": 306, + "id": 335, "name": "new StorageClient", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 307, + "id": 336, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -271,7 +271,7 @@ } }, { - "id": 308, + "id": 337, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -279,20 +279,20 @@ "type": { "type": "reflection", "declaration": { - "id": 309, + "id": 338, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 310, + "id": 339, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 311, + "id": 340, "name": "key", "kind": 32768, "flags": {}, @@ -312,7 +312,7 @@ "defaultValue": "{}" }, { - "id": 312, + "id": 341, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -322,21 +322,21 @@ "type": { "type": "reflection", "declaration": { - "id": 313, + "id": 342, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 314, + "id": 343, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 315, + "id": 344, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -349,7 +349,7 @@ } }, { - "id": 316, + "id": 345, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -386,7 +386,7 @@ ], "type": { "type": "reference", - "id": 304, + "id": 333, "name": "StorageClient" }, "overwrites": { @@ -403,7 +403,7 @@ } }, { - "id": 347, + "id": 376, "name": "createBucket", "kind": 2048, "kindString": "Method", @@ -417,7 +417,7 @@ ], "signatures": [ { - "id": 348, + "id": 377, "name": "createBucket", "kind": 4096, "kindString": "Call signature", @@ -428,7 +428,7 @@ }, "parameters": [ { - "id": 349, + "id": 378, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -442,7 +442,7 @@ } }, { - "id": 350, + "id": 379, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -450,14 +450,14 @@ "type": { "type": "reflection", "declaration": { - "id": 351, + "id": 380, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "id": 383, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -492,7 +492,7 @@ } }, { - "id": 353, + "id": 382, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -528,7 +528,7 @@ } }, { - "id": 352, + "id": 381, "name": "public", "kind": 1024, "kindString": "Property", @@ -553,7 +553,7 @@ { "title": "Properties", "kind": 1024, - "children": [354, 353, 352] + "children": [383, 382, 381] } ] } @@ -570,14 +570,14 @@ { "type": "reflection", "declaration": { - "id": 355, + "id": 384, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 356, + "id": 385, "name": "data", "kind": 1024, "kindString": "Property", @@ -594,7 +594,7 @@ "typeArguments": [ { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" }, { @@ -608,7 +608,7 @@ } }, { - "id": 357, + "id": 386, "name": "error", "kind": 1024, "kindString": "Property", @@ -630,7 +630,7 @@ { "title": "Properties", "kind": 1024, - "children": [356, 357] + "children": [385, 386] } ] } @@ -638,14 +638,14 @@ { "type": "reflection", "declaration": { - "id": 358, + "id": 387, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 359, + "id": 388, "name": "data", "kind": 1024, "kindString": "Property", @@ -663,7 +663,7 @@ } }, { - "id": 360, + "id": 389, "name": "error", "kind": 1024, "kindString": "Property", @@ -677,7 +677,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -686,7 +686,7 @@ { "title": "Properties", "kind": 1024, - "children": [359, 360] + "children": [388, 389] } ] } @@ -712,7 +712,7 @@ } }, { - "id": 388, + "id": 417, "name": "deleteBucket", "kind": 2048, "kindString": "Method", @@ -726,7 +726,7 @@ ], "signatures": [ { - "id": 389, + "id": 418, "name": "deleteBucket", "kind": 4096, "kindString": "Call signature", @@ -736,7 +736,7 @@ }, "parameters": [ { - "id": 390, + "id": 419, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -759,14 +759,14 @@ { "type": "reflection", "declaration": { - "id": 391, + "id": 420, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 392, + "id": 421, "name": "data", "kind": 1024, "kindString": "Property", @@ -781,14 +781,14 @@ "type": { "type": "reflection", "declaration": { - "id": 393, + "id": 422, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 394, + "id": 423, "name": "message", "kind": 1024, "kindString": "Property", @@ -810,14 +810,14 @@ { "title": "Properties", "kind": 1024, - "children": [394] + "children": [423] } ] } } }, { - "id": 395, + "id": 424, "name": "error", "kind": 1024, "kindString": "Property", @@ -839,7 +839,7 @@ { "title": "Properties", "kind": 1024, - "children": [392, 395] + "children": [421, 424] } ] } @@ -847,14 +847,14 @@ { "type": "reflection", "declaration": { - "id": 396, + "id": 425, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 397, + "id": 426, "name": "data", "kind": 1024, "kindString": "Property", @@ -872,7 +872,7 @@ } }, { - "id": 398, + "id": 427, "name": "error", "kind": 1024, "kindString": "Property", @@ -886,7 +886,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -895,7 +895,7 @@ { "title": "Properties", "kind": 1024, - "children": [397, 398] + "children": [426, 427] } ] } @@ -921,7 +921,7 @@ } }, { - "id": 377, + "id": 406, "name": "emptyBucket", "kind": 2048, "kindString": "Method", @@ -935,7 +935,7 @@ ], "signatures": [ { - "id": 378, + "id": 407, "name": "emptyBucket", "kind": 4096, "kindString": "Call signature", @@ -945,7 +945,7 @@ }, "parameters": [ { - "id": 379, + "id": 408, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -968,14 +968,14 @@ { "type": "reflection", "declaration": { - "id": 380, + "id": 409, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 381, + "id": 410, "name": "data", "kind": 1024, "kindString": "Property", @@ -990,14 +990,14 @@ "type": { "type": "reflection", "declaration": { - "id": 382, + "id": 411, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 383, + "id": 412, "name": "message", "kind": 1024, "kindString": "Property", @@ -1019,14 +1019,14 @@ { "title": "Properties", "kind": 1024, - "children": [383] + "children": [412] } ] } } }, { - "id": 384, + "id": 413, "name": "error", "kind": 1024, "kindString": "Property", @@ -1048,7 +1048,7 @@ { "title": "Properties", "kind": 1024, - "children": [381, 384] + "children": [410, 413] } ] } @@ -1056,14 +1056,14 @@ { "type": "reflection", "declaration": { - "id": 385, + "id": 414, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 386, + "id": 415, "name": "data", "kind": 1024, "kindString": "Property", @@ -1081,7 +1081,7 @@ } }, { - "id": 387, + "id": 416, "name": "error", "kind": 1024, "kindString": "Property", @@ -1095,7 +1095,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -1104,7 +1104,7 @@ { "title": "Properties", "kind": 1024, - "children": [386, 387] + "children": [415, 416] } ] } @@ -1130,7 +1130,7 @@ } }, { - "id": 317, + "id": 346, "name": "from", "kind": 2048, "kindString": "Method", @@ -1144,7 +1144,7 @@ ], "signatures": [ { - "id": 318, + "id": 347, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1154,7 +1154,7 @@ }, "parameters": [ { - "id": 319, + "id": 348, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -1177,7 +1177,7 @@ ] }, { - "id": 338, + "id": 367, "name": "getBucket", "kind": 2048, "kindString": "Method", @@ -1191,7 +1191,7 @@ ], "signatures": [ { - "id": 339, + "id": 368, "name": "getBucket", "kind": 4096, "kindString": "Call signature", @@ -1201,7 +1201,7 @@ }, "parameters": [ { - "id": 340, + "id": 369, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -1224,14 +1224,14 @@ { "type": "reflection", "declaration": { - "id": 341, + "id": 370, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 371, "name": "data", "kind": 1024, "kindString": "Property", @@ -1245,12 +1245,12 @@ ], "type": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } }, { - "id": 343, + "id": 372, "name": "error", "kind": 1024, "kindString": "Property", @@ -1272,7 +1272,7 @@ { "title": "Properties", "kind": 1024, - "children": [342, 343] + "children": [371, 372] } ] } @@ -1280,14 +1280,14 @@ { "type": "reflection", "declaration": { - "id": 344, + "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 345, + "id": 374, "name": "data", "kind": 1024, "kindString": "Property", @@ -1305,7 +1305,7 @@ } }, { - "id": 346, + "id": 375, "name": "error", "kind": 1024, "kindString": "Property", @@ -1319,7 +1319,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -1328,7 +1328,7 @@ { "title": "Properties", "kind": 1024, - "children": [345, 346] + "children": [374, 375] } ] } @@ -1354,7 +1354,7 @@ } }, { - "id": 330, + "id": 359, "name": "listBuckets", "kind": 2048, "kindString": "Method", @@ -1368,7 +1368,7 @@ ], "signatures": [ { - "id": 331, + "id": 360, "name": "listBuckets", "kind": 4096, "kindString": "Call signature", @@ -1385,14 +1385,14 @@ { "type": "reflection", "declaration": { - "id": 332, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 333, + "id": 362, "name": "data", "kind": 1024, "kindString": "Property", @@ -1408,13 +1408,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } } }, { - "id": 334, + "id": 363, "name": "error", "kind": 1024, "kindString": "Property", @@ -1436,7 +1436,7 @@ { "title": "Properties", "kind": 1024, - "children": [333, 334] + "children": [362, 363] } ] } @@ -1444,14 +1444,14 @@ { "type": "reflection", "declaration": { - "id": 335, + "id": 364, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 336, + "id": 365, "name": "data", "kind": 1024, "kindString": "Property", @@ -1469,7 +1469,7 @@ } }, { - "id": 337, + "id": 366, "name": "error", "kind": 1024, "kindString": "Property", @@ -1483,7 +1483,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -1492,7 +1492,7 @@ { "title": "Properties", "kind": 1024, - "children": [336, 337] + "children": [365, 366] } ] } @@ -1518,7 +1518,7 @@ } }, { - "id": 361, + "id": 390, "name": "updateBucket", "kind": 2048, "kindString": "Method", @@ -1532,7 +1532,7 @@ ], "signatures": [ { - "id": 362, + "id": 391, "name": "updateBucket", "kind": 4096, "kindString": "Call signature", @@ -1542,7 +1542,7 @@ }, "parameters": [ { - "id": 363, + "id": 392, "name": "id", "kind": 32768, "kindString": "Parameter", @@ -1556,7 +1556,7 @@ } }, { - "id": 364, + "id": 393, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -1564,14 +1564,14 @@ "type": { "type": "reflection", "declaration": { - "id": 365, + "id": 394, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 368, + "id": 397, "name": "allowedMimeTypes", "kind": 1024, "kindString": "Property", @@ -1606,7 +1606,7 @@ } }, { - "id": 367, + "id": 396, "name": "fileSizeLimit", "kind": 1024, "kindString": "Property", @@ -1642,7 +1642,7 @@ } }, { - "id": 366, + "id": 395, "name": "public", "kind": 1024, "kindString": "Property", @@ -1667,7 +1667,7 @@ { "title": "Properties", "kind": 1024, - "children": [368, 367, 366] + "children": [397, 396, 395] } ] } @@ -1683,14 +1683,14 @@ { "type": "reflection", "declaration": { - "id": 369, + "id": 398, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 370, + "id": 399, "name": "data", "kind": 1024, "kindString": "Property", @@ -1705,14 +1705,14 @@ "type": { "type": "reflection", "declaration": { - "id": 371, + "id": 400, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 372, + "id": 401, "name": "message", "kind": 1024, "kindString": "Property", @@ -1734,14 +1734,14 @@ { "title": "Properties", "kind": 1024, - "children": [372] + "children": [401] } ] } } }, { - "id": 373, + "id": 402, "name": "error", "kind": 1024, "kindString": "Property", @@ -1763,7 +1763,7 @@ { "title": "Properties", "kind": 1024, - "children": [370, 373] + "children": [399, 402] } ] } @@ -1771,14 +1771,14 @@ { "type": "reflection", "declaration": { - "id": 374, + "id": 403, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 375, + "id": 404, "name": "data", "kind": 1024, "kindString": "Property", @@ -1796,7 +1796,7 @@ } }, { - "id": 376, + "id": 405, "name": "error", "kind": 1024, "kindString": "Property", @@ -1810,7 +1810,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -1819,7 +1819,7 @@ { "title": "Properties", "kind": 1024, - "children": [375, 376] + "children": [404, 405] } ] } @@ -1849,12 +1849,12 @@ { "title": "Constructors", "kind": 512, - "children": [305] + "children": [334] }, { "title": "Methods", "kind": 2048, - "children": [347, 388, 377, 317, 338, 330, 361] + "children": [376, 417, 406, 346, 367, 359, 390] } ], "sources": [ @@ -1873,14 +1873,14 @@ ] }, { - "id": 444, + "id": 493, "name": "StorageError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 445, + "id": 494, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1894,14 +1894,14 @@ ], "signatures": [ { - "id": 446, + "id": 495, "name": "new StorageError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 447, + "id": 496, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1914,7 +1914,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" }, "overwrites": { @@ -1933,7 +1933,7 @@ { "title": "Constructors", "kind": 512, - "children": [445] + "children": [494] } ], "sources": [ @@ -1954,25 +1954,25 @@ "extendedBy": [ { "type": "reference", - "id": 449, + "id": 498, "name": "StorageApiError" }, { "type": "reference", - "id": 462, + "id": 511, "name": "StorageUnknownError" } ] }, { - "id": 462, + "id": 511, "name": "StorageUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 463, + "id": 512, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1986,14 +1986,14 @@ ], "signatures": [ { - "id": 464, + "id": 513, "name": "new StorageUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 465, + "id": 514, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -2004,7 +2004,7 @@ } }, { - "id": 466, + "id": 515, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -2017,24 +2017,24 @@ ], "type": { "type": "reference", - "id": 462, + "id": 511, "name": "StorageUnknownError" }, "overwrites": { "type": "reference", - "id": 446, + "id": 495, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", - "id": 445, + "id": 494, "name": "StorageError.constructor" } }, { - "id": 467, + "id": 516, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -2056,12 +2056,12 @@ { "title": "Constructors", "kind": 512, - "children": [463] + "children": [512] }, { "title": "Properties", "kind": 1024, - "children": [467] + "children": [516] } ], "sources": [ @@ -2074,20 +2074,20 @@ "extendedTypes": [ { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } ] }, { - "id": 399, + "id": 428, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 404, + "id": 433, "name": "allowed_mime_types", "kind": 1024, "kindString": "Property", @@ -2110,7 +2110,7 @@ } }, { - "id": 405, + "id": 434, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2128,7 +2128,7 @@ } }, { - "id": 403, + "id": 432, "name": "file_size_limit", "kind": 1024, "kindString": "Property", @@ -2148,7 +2148,7 @@ } }, { - "id": 400, + "id": 429, "name": "id", "kind": 1024, "kindString": "Property", @@ -2166,7 +2166,7 @@ } }, { - "id": 401, + "id": 430, "name": "name", "kind": 1024, "kindString": "Property", @@ -2184,7 +2184,7 @@ } }, { - "id": 402, + "id": 431, "name": "owner", "kind": 1024, "kindString": "Property", @@ -2202,7 +2202,7 @@ } }, { - "id": 407, + "id": 436, "name": "public", "kind": 1024, "kindString": "Property", @@ -2220,7 +2220,7 @@ } }, { - "id": 406, + "id": 435, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2242,7 +2242,7 @@ { "title": "Properties", "kind": 1024, - "children": [404, 405, 403, 400, 401, 402, 407, 406] + "children": [433, 434, 432, 429, 430, 431, 436, 435] } ], "sources": [ @@ -2254,14 +2254,57 @@ ] }, { - "id": 431, + "id": 471, + "name": "DestinationOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 472, + "name": "destinationBucket", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [472] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 74, + "character": 17 + } + ] + }, + { + "id": 478, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 432, + "id": 479, "name": "signal", "kind": 1024, "kindString": "Property", @@ -2274,7 +2317,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 104, "character": 2 } ], @@ -2290,26 +2333,26 @@ { "title": "Properties", "kind": 1024, - "children": [432] + "children": [479] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 100, "character": 17 } ] }, { - "id": 408, + "id": 437, "name": "FileObject", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 410, + "id": 439, "name": "bucket_id", "kind": 1024, "kindString": "Property", @@ -2327,7 +2370,7 @@ } }, { - "id": 417, + "id": 446, "name": "buckets", "kind": 1024, "kindString": "Property", @@ -2341,17 +2384,17 @@ ], "type": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket", "dereferenced": { - "id": 399, + "id": 428, "name": "Bucket", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 404, + "id": 433, "name": "allowed_mime_types", "kind": 1024, "kindString": "Property", @@ -2374,7 +2417,7 @@ } }, { - "id": 405, + "id": 434, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2392,7 +2435,7 @@ } }, { - "id": 403, + "id": 432, "name": "file_size_limit", "kind": 1024, "kindString": "Property", @@ -2412,7 +2455,7 @@ } }, { - "id": 400, + "id": 429, "name": "id", "kind": 1024, "kindString": "Property", @@ -2430,7 +2473,7 @@ } }, { - "id": 401, + "id": 430, "name": "name", "kind": 1024, "kindString": "Property", @@ -2448,7 +2491,7 @@ } }, { - "id": 402, + "id": 431, "name": "owner", "kind": 1024, "kindString": "Property", @@ -2466,7 +2509,7 @@ } }, { - "id": 407, + "id": 436, "name": "public", "kind": 1024, "kindString": "Property", @@ -2484,7 +2527,7 @@ } }, { - "id": 406, + "id": 435, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2506,7 +2549,7 @@ { "title": "Properties", "kind": 1024, - "children": [404, 405, 403, 400, 401, 402, 407, 406] + "children": [433, 434, 432, 429, 430, 431, 436, 435] } ], "sources": [ @@ -2520,7 +2563,7 @@ } }, { - "id": 414, + "id": 443, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -2538,7 +2581,7 @@ } }, { - "id": 412, + "id": 441, "name": "id", "kind": 1024, "kindString": "Property", @@ -2556,7 +2599,7 @@ } }, { - "id": 415, + "id": 444, "name": "last_accessed_at", "kind": 1024, "kindString": "Property", @@ -2574,7 +2617,7 @@ } }, { - "id": 416, + "id": 445, "name": "metadata", "kind": 1024, "kindString": "Property", @@ -2604,7 +2647,7 @@ } }, { - "id": 409, + "id": 438, "name": "name", "kind": 1024, "kindString": "Property", @@ -2622,7 +2665,7 @@ } }, { - "id": 411, + "id": 440, "name": "owner", "kind": 1024, "kindString": "Property", @@ -2640,7 +2683,7 @@ } }, { - "id": 413, + "id": 442, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -2662,7 +2705,7 @@ { "title": "Properties", "kind": 1024, - "children": [410, 417, 414, 412, 415, 416, 409, 411, 413] + "children": [439, 446, 443, 441, 444, 445, 438, 440, 442] } ], "sources": [ @@ -2674,23 +2717,38 @@ ] }, { - "id": 421, - "name": "FileOptions", + "id": 447, + "name": "FileObjectV2", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 422, - "name": "cacheControl", + "id": 451, + "name": "bucket_id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 28, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 456, + "name": "cache_control", "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", @@ -2704,20 +2762,17 @@ } }, { - "id": 423, - "name": "contentType", + "id": 457, + "name": "content_type", "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": 37, + "line": 34, "character": 2 } ], @@ -2727,176 +2782,15 @@ } }, { - "id": 425, - "name": "duplex", - "kind": 1024, - "kindString": "Property", - "flags": { - "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." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 45, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 424, - "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": 41, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [422, 423, 425, 424] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 29, - "character": 17 - } - ] - }, - { - "id": 433, - "name": "Metadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 434, - "name": "name", + "id": 453, + "name": "created_at", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 79, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [434] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 78, - "character": 17 - } - ] - }, - { - "id": 426, - "name": "SearchOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 427, - "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": 52, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 428, - "name": "offset", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The starting position." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 430, - "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": 67, + "line": 30, "character": 2 } ], @@ -2906,123 +2800,31 @@ } }, { - "id": 429, - "name": "sortBy", + "id": 458, + "name": "etag", "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": 62, + "line": 35, "character": 2 } ], "type": { - "type": "reference", - "id": 418, - "name": "SortBy", - "dereferenced": { - "id": 418, - "name": "SortBy", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 419, - "name": "column", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 420, - "name": "order", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 26, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [419, 420] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 24, - "character": 17 - } - ] - } + "type": "intrinsic", + "name": "string" } - } - ], - "groups": [ + }, { - "title": "Properties", - "kind": 1024, - "children": [427, 428, 430, 429] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 48, - "character": 17 - } - ] - }, - { - "id": 418, - "name": "SortBy", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 419, - "name": "column", + "id": 448, + "name": "id", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -3036,13 +2838,137 @@ } }, { - "id": 420, - "name": "order", + "id": 454, + "name": "last_accessed_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 31, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 459, + "name": "last_modified", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 36, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 460, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 450, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 27, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 455, + "name": "size", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 32, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 452, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 29, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 449, + "name": "version", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -3060,7 +2986,7 @@ { "title": "Properties", "kind": 1024, - "children": [419, 420] + "children": [451, 456, 457, 453, 458, 448, 454, 459, 460, 450, 455, 452, 449] } ], "sources": [ @@ -3072,14 +2998,482 @@ ] }, { - "id": 435, + "id": 464, + "name": "FileOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 465, + "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": 49, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 466, + "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": 53, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 468, + "name": "duplex", + "kind": 1024, + "kindString": "Property", + "flags": { + "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." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 61, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 470, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optionally add extra headers" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 469, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "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." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 467, + "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": 57, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [465, 466, 468, 470, 469, 467] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 17 + } + ] + }, + { + "id": 480, + "name": "Metadata", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 481, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 109, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [481] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 17 + } + ] + }, + { + "id": 473, + "name": "SearchOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 474, + "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": 82, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 475, + "name": "offset", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The starting position." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 87, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 477, + "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": 97, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 476, + "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": 92, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 461, + "name": "SortBy", + "dereferenced": { + "id": 461, + "name": "SortBy", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 462, + "name": "column", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 463, + "name": "order", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [462, 463] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 40, + "character": 17 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [474, 475, 477, 476] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 78, + "character": 17 + } + ] + }, + { + "id": 461, + "name": "SortBy", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 462, + "name": "column", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 463, + "name": "order", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [462, 463] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 40, + "character": 17 + } + ] + }, + { + "id": 482, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 440, + "id": 487, "name": "format", "kind": 1024, "kindString": "Property", @@ -3093,7 +3487,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 110, + "line": 140, "character": 2 } ], @@ -3103,7 +3497,7 @@ } }, { - "id": 437, + "id": 484, "name": "height", "kind": 1024, "kindString": "Property", @@ -3116,7 +3510,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 90, + "line": 120, "character": 2 } ], @@ -3126,7 +3520,7 @@ } }, { - "id": 439, + "id": 486, "name": "quality", "kind": 1024, "kindString": "Property", @@ -3139,7 +3533,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 103, + "line": 133, "character": 2 } ], @@ -3149,7 +3543,7 @@ } }, { - "id": 438, + "id": 485, "name": "resize", "kind": 1024, "kindString": "Property", @@ -3162,7 +3556,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 127, "character": 2 } ], @@ -3185,7 +3579,7 @@ } }, { - "id": 436, + "id": 483, "name": "width", "kind": 1024, "kindString": "Property", @@ -3198,7 +3592,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 116, "character": 2 } ], @@ -3212,19 +3606,89 @@ { "title": "Properties", "kind": 1024, - "children": [440, 437, 439, 438, 436] + "children": [487, 484, 486, 485, 483] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 112, "character": 17 } ] }, { - "id": 441, + "id": 488, + "name": "Camelize", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 147, + "character": 12 + } + ], + "typeParameter": [ + { + "id": 489, + "name": "T", + "kind": 131072, + "kindString": "Type parameter", + "flags": {} + } + ], + "type": { + "type": "mapped", + "parameter": "K", + "parameterType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "id": 489, + "name": "T" + } + }, + "templateType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "name": "K" + }, + "objectType": { + "type": "reference", + "id": 489, + "name": "T" + } + }, + "nameType": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "K" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Extract", + "package": "typescript", + "name": "Extract" + } + ], + "name": "CamelCase" + } + } + }, + { + "id": 490, "name": "isStorageError", "kind": 64, "kindString": "Function", @@ -3238,14 +3702,14 @@ ], "signatures": [ { - "id": 442, + "id": 491, "name": "isStorageError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 443, + "id": 492, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -3262,7 +3726,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -3274,17 +3738,22 @@ { "title": "Classes", "kind": 128, - "children": [449, 304, 444, 462] + "children": [498, 333, 493, 511] }, { "title": "Interfaces", "kind": 256, - "children": [399, 431, 408, 421, 433, 426, 418, 435] + "children": [428, 471, 478, 437, 447, 464, 480, 473, 461, 482] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [488] }, { "title": "Functions", "kind": 64, - "children": [441] + "children": [490] } ], "sources": [ @@ -3655,7 +4124,7 @@ "typeArguments": [ { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" }, { @@ -3738,7 +4207,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -3937,7 +4406,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -4136,7 +4605,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -4229,7 +4698,7 @@ ], "type": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } }, @@ -4303,7 +4772,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -4382,7 +4851,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 399, + "id": 428, "name": "Bucket" } } @@ -4457,7 +4926,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -4774,7 +5243,7 @@ ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -4821,7 +5290,7 @@ "extendedBy": [ { "type": "reference", - "id": 304, + "id": 333, "name": "StorageClient" } ] @@ -4865,7 +5334,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 45, + "line": 48, "character": 2 } ], @@ -5024,7 +5493,7 @@ ] }, { - "id": 207, + "id": 211, "name": "copy", "kind": 2048, "kindString": "Method", @@ -5032,13 +5501,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 338, + "line": 373, "character": 8 } ], "signatures": [ { - "id": 208, + "id": 212, "name": "copy", "kind": 4096, "kindString": "Call signature", @@ -5048,7 +5517,7 @@ }, "parameters": [ { - "id": 209, + "id": 213, "name": "fromPath", "kind": 32768, "kindString": "Parameter", @@ -5062,18 +5531,78 @@ } }, { - "id": 210, + "id": 214, "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" + "shortText": "The new file path, including the new file name. For example `folder/image-copy.png`." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 215, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The destination options.\n" + }, + "type": { + "type": "reference", + "id": 471, + "name": "DestinationOptions", + "dereferenced": { + "id": 471, + "name": "DestinationOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 472, + "name": "destinationBucket", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [472] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 74, + "character": 17 + } + ] + } + } } ], "type": { @@ -5082,94 +5611,6 @@ { "type": "union", "types": [ - { - "type": "reflection", - "declaration": { - "id": 211, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 212, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 343, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 213, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 214, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 343, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [214] - } - ] - } - } - }, - { - "id": 215, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 344, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [212, 215] - } - ] - } - }, { "type": "reflection", "declaration": { @@ -5188,7 +5629,95 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 347, + "line": 379, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 218, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 219, + "name": "path", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 379, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [219] + } + ] + } + } + }, + { + "id": 220, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 380, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [217, 220] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 221, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 222, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 383, "character": 8 } ], @@ -5198,7 +5727,7 @@ } }, { - "id": 218, + "id": 223, "name": "error", "kind": 1024, "kindString": "Property", @@ -5206,13 +5735,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 348, + "line": 384, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -5221,7 +5750,7 @@ { "title": "Properties", "kind": 1024, - "children": [217, 218] + "children": [222, 223] } ] } @@ -5245,7 +5774,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 223, + "line": 243, "character": 8 } ], @@ -5267,12 +5796,61 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`.\n" + "shortText": "The file path, including the current file name. For example `folder/image.png`." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 170, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 171, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 172, + "name": "upsert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "If set to true, allows the file to be overwritten if it already exists.\n" + }, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 245, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [172] + } + ] + } + } } ], "type": { @@ -5284,14 +5862,14 @@ { "type": "reflection", "declaration": { - "id": 170, + "id": 173, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 171, + "id": 174, "name": "data", "kind": 1024, "kindString": "Property", @@ -5299,21 +5877,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, + "line": 248, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 172, + "id": 175, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 175, + "id": 178, "name": "path", "kind": 1024, "kindString": "Property", @@ -5321,7 +5899,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, + "line": 248, "character": 50 } ], @@ -5331,7 +5909,7 @@ } }, { - "id": 173, + "id": 176, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -5339,7 +5917,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, + "line": 248, "character": 16 } ], @@ -5349,7 +5927,7 @@ } }, { - "id": 174, + "id": 177, "name": "token", "kind": 1024, "kindString": "Property", @@ -5357,7 +5935,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 227, + "line": 248, "character": 35 } ], @@ -5371,67 +5949,12 @@ { "title": "Properties", "kind": 1024, - "children": [175, 173, 174] + "children": [178, 176, 177] } ] } } }, - { - "id": 176, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 228, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [171, 176] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 177, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 178, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 231, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, { "id": 179, "name": "error", @@ -5441,13 +5964,68 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 232, + "line": 249, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [174, 179] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 180, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 181, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 252, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 182, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 253, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -5456,7 +6034,7 @@ { "title": "Properties", "kind": 1024, - "children": [178, 179] + "children": [181, 182] } ] } @@ -5472,7 +6050,7 @@ ] }, { - "id": 219, + "id": 224, "name": "createSignedUrl", "kind": 2048, "kindString": "Method", @@ -5480,13 +6058,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 376, + "line": 417, "character": 8 } ], "signatures": [ { - "id": 220, + "id": 225, "name": "createSignedUrl", "kind": 4096, "kindString": "Call signature", @@ -5496,7 +6074,7 @@ }, "parameters": [ { - "id": 221, + "id": 226, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -5510,7 +6088,7 @@ } }, { - "id": 222, + "id": 227, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", @@ -5524,7 +6102,7 @@ } }, { - "id": 223, + "id": 228, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5534,14 +6112,14 @@ "type": { "type": "reflection", "declaration": { - "id": 224, + "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 225, + "id": 230, "name": "download", "kind": 1024, "kindString": "Property", @@ -5554,7 +6132,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 379, + "line": 420, "character": 16 } ], @@ -5573,7 +6151,7 @@ } }, { - "id": 226, + "id": 231, "name": "transform", "kind": 1024, "kindString": "Property", @@ -5586,23 +6164,23 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 379, + "line": 420, "character": 45 } ], "type": { "type": "reference", - "id": 435, + "id": 482, "name": "TransformOptions", "dereferenced": { - "id": 435, + "id": 482, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 440, + "id": 487, "name": "format", "kind": 1024, "kindString": "Property", @@ -5616,7 +6194,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 110, + "line": 140, "character": 2 } ], @@ -5626,7 +6204,7 @@ } }, { - "id": 437, + "id": 484, "name": "height", "kind": 1024, "kindString": "Property", @@ -5639,7 +6217,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 90, + "line": 120, "character": 2 } ], @@ -5649,7 +6227,7 @@ } }, { - "id": 439, + "id": 486, "name": "quality", "kind": 1024, "kindString": "Property", @@ -5662,7 +6240,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 103, + "line": 133, "character": 2 } ], @@ -5672,7 +6250,7 @@ } }, { - "id": 438, + "id": 485, "name": "resize", "kind": 1024, "kindString": "Property", @@ -5685,7 +6263,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 127, "character": 2 } ], @@ -5708,7 +6286,7 @@ } }, { - "id": 436, + "id": 483, "name": "width", "kind": 1024, "kindString": "Property", @@ -5721,7 +6299,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 116, "character": 2 } ], @@ -5735,13 +6313,13 @@ { "title": "Properties", "kind": 1024, - "children": [440, 437, 439, 438, 436] + "children": [487, 484, 486, 485, 483] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 112, "character": 17 } ] @@ -5753,7 +6331,7 @@ { "title": "Properties", "kind": 1024, - "children": [225, 226] + "children": [230, 231] } ] } @@ -5766,94 +6344,6 @@ { "type": "union", "types": [ - { - "type": "reflection", - "declaration": { - "id": 227, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 228, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 382, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 229, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 230, - "name": "signedUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 382, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [230] - } - ] - } - } - }, - { - "id": 231, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 383, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [228, 231] - } - ] - } - }, { "type": "reflection", "declaration": { @@ -5872,7 +6362,95 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 386, + "line": 423, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 234, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 235, + "name": "signedUrl", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 423, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [235] + } + ] + } + } + }, + { + "id": 236, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 424, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [233, 236] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 237, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 238, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 427, "character": 8 } ], @@ -5882,7 +6460,7 @@ } }, { - "id": 234, + "id": 239, "name": "error", "kind": 1024, "kindString": "Property", @@ -5890,13 +6468,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 387, + "line": 428, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -5905,7 +6483,7 @@ { "title": "Properties", "kind": 1024, - "children": [233, 234] + "children": [238, 239] } ] } @@ -5921,7 +6499,7 @@ ] }, { - "id": 235, + "id": 240, "name": "createSignedUrls", "kind": 2048, "kindString": "Method", @@ -5929,13 +6507,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 421, + "line": 462, "character": 8 } ], "signatures": [ { - "id": 236, + "id": 241, "name": "createSignedUrls", "kind": 4096, "kindString": "Call signature", @@ -5945,7 +6523,7 @@ }, "parameters": [ { - "id": 237, + "id": 242, "name": "paths", "kind": 32768, "kindString": "Parameter", @@ -5962,7 +6540,7 @@ } }, { - "id": 238, + "id": 243, "name": "expiresIn", "kind": 32768, "kindString": "Parameter", @@ -5976,7 +6554,7 @@ } }, { - "id": 239, + "id": 244, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5986,14 +6564,14 @@ "type": { "type": "reflection", "declaration": { - "id": 240, + "id": 245, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 241, + "id": 246, "name": "download", "kind": 1024, "kindString": "Property", @@ -6004,7 +6582,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 424, + "line": 465, "character": 16 } ], @@ -6027,7 +6605,7 @@ { "title": "Properties", "kind": 1024, - "children": [241] + "children": [246] } ] } @@ -6043,14 +6621,14 @@ { "type": "reflection", "declaration": { - "id": 242, + "id": 247, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 243, + "id": 248, "name": "data", "kind": 1024, "kindString": "Property", @@ -6058,7 +6636,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 427, + "line": 468, "character": 8 } ], @@ -6067,14 +6645,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 244, + "id": 249, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 245, + "id": 250, "name": "error", "kind": 1024, "kindString": "Property", @@ -6082,7 +6660,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 427, + "line": 468, "character": 16 } ], @@ -6101,7 +6679,7 @@ } }, { - "id": 246, + "id": 251, "name": "path", "kind": 1024, "kindString": "Property", @@ -6109,7 +6687,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 427, + "line": 468, "character": 38 } ], @@ -6128,7 +6706,7 @@ } }, { - "id": 247, + "id": 252, "name": "signedUrl", "kind": 1024, "kindString": "Property", @@ -6136,7 +6714,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 427, + "line": 468, "character": 59 } ], @@ -6150,7 +6728,7 @@ { "title": "Properties", "kind": 1024, - "children": [245, 246, 247] + "children": [250, 251, 252] } ] } @@ -6158,7 +6736,7 @@ } }, { - "id": 248, + "id": 253, "name": "error", "kind": 1024, "kindString": "Property", @@ -6166,7 +6744,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 428, + "line": 469, "character": 8 } ], @@ -6180,7 +6758,7 @@ { "title": "Properties", "kind": 1024, - "children": [243, 248] + "children": [248, 253] } ] } @@ -6188,14 +6766,14 @@ { "type": "reflection", "declaration": { - "id": 249, + "id": 254, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 250, + "id": 255, "name": "data", "kind": 1024, "kindString": "Property", @@ -6203,7 +6781,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 431, + "line": 472, "character": 8 } ], @@ -6213,7 +6791,7 @@ } }, { - "id": 251, + "id": 256, "name": "error", "kind": 1024, "kindString": "Property", @@ -6221,13 +6799,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 432, + "line": 473, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -6236,7 +6814,7 @@ { "title": "Properties", "kind": 1024, - "children": [250, 251] + "children": [255, 256] } ] } @@ -6252,7 +6830,7 @@ ] }, { - "id": 252, + "id": 257, "name": "download", "kind": 2048, "kindString": "Method", @@ -6260,13 +6838,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 470, + "line": 511, "character": 8 } ], "signatures": [ { - "id": 253, + "id": 258, "name": "download", "kind": 4096, "kindString": "Call signature", @@ -6276,7 +6854,7 @@ }, "parameters": [ { - "id": 254, + "id": 259, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -6290,7 +6868,7 @@ } }, { - "id": 255, + "id": 260, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6300,14 +6878,14 @@ "type": { "type": "reflection", "declaration": { - "id": 256, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 257, + "id": 262, "name": "transform", "kind": 1024, "kindString": "Property", @@ -6320,23 +6898,23 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 472, + "line": 513, "character": 16 } ], "type": { "type": "reference", - "id": 435, + "id": 482, "name": "TransformOptions", "dereferenced": { - "id": 435, + "id": 482, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 440, + "id": 487, "name": "format", "kind": 1024, "kindString": "Property", @@ -6350,7 +6928,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 110, + "line": 140, "character": 2 } ], @@ -6360,7 +6938,7 @@ } }, { - "id": 437, + "id": 484, "name": "height", "kind": 1024, "kindString": "Property", @@ -6373,7 +6951,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 90, + "line": 120, "character": 2 } ], @@ -6383,7 +6961,7 @@ } }, { - "id": 439, + "id": 486, "name": "quality", "kind": 1024, "kindString": "Property", @@ -6396,7 +6974,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 103, + "line": 133, "character": 2 } ], @@ -6406,7 +6984,7 @@ } }, { - "id": 438, + "id": 485, "name": "resize", "kind": 1024, "kindString": "Property", @@ -6419,7 +6997,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 127, "character": 2 } ], @@ -6442,7 +7020,7 @@ } }, { - "id": 436, + "id": 483, "name": "width", "kind": 1024, "kindString": "Property", @@ -6455,7 +7033,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 116, "character": 2 } ], @@ -6469,13 +7047,13 @@ { "title": "Properties", "kind": 1024, - "children": [440, 437, 439, 438, 436] + "children": [487, 484, 486, 485, 483] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 112, "character": 17 } ] @@ -6487,7 +7065,7 @@ { "title": "Properties", "kind": 1024, - "children": [257] + "children": [262] } ] } @@ -6503,14 +7081,14 @@ { "type": "reflection", "declaration": { - "id": 258, + "id": 263, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 259, + "id": 264, "name": "data", "kind": 1024, "kindString": "Property", @@ -6518,7 +7096,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 475, + "line": 516, "character": 8 } ], @@ -6530,7 +7108,7 @@ } }, { - "id": 260, + "id": 265, "name": "error", "kind": 1024, "kindString": "Property", @@ -6538,7 +7116,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 476, + "line": 517, "character": 8 } ], @@ -6552,7 +7130,7 @@ { "title": "Properties", "kind": 1024, - "children": [259, 260] + "children": [264, 265] } ] } @@ -6560,14 +7138,14 @@ { "type": "reflection", "declaration": { - "id": 261, + "id": 266, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 262, + "id": 267, "name": "data", "kind": 1024, "kindString": "Property", @@ -6575,7 +7153,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 479, + "line": 520, "character": 8 } ], @@ -6585,7 +7163,7 @@ } }, { - "id": 263, + "id": 268, "name": "error", "kind": 1024, "kindString": "Property", @@ -6593,13 +7171,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 480, + "line": 521, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -6608,7 +7186,7 @@ { "title": "Properties", "kind": 1024, - "children": [262, 263] + "children": [267, 268] } ] } @@ -6624,7 +7202,173 @@ ] }, { - "id": 264, + "id": 278, + "name": "exists", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 583, + "character": 8 + } + ], + "signatures": [ + { + "id": 279, + "name": "exists", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Checks the existence of a file." + }, + "parameters": [ + { + "id": 280, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 281, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 282, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 587, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 283, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 588, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [282, 283] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 284, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 285, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 591, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 286, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 592, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 493, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [285, 286] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 287, "name": "getPublicUrl", "kind": 2048, "kindString": "Method", @@ -6632,13 +7376,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 513, + "line": 624, "character": 2 } ], "signatures": [ { - "id": 265, + "id": 288, "name": "getPublicUrl", "kind": 4096, "kindString": "Call signature", @@ -6648,7 +7392,7 @@ }, "parameters": [ { - "id": 266, + "id": 289, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -6662,7 +7406,7 @@ } }, { - "id": 267, + "id": 290, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6672,14 +7416,14 @@ "type": { "type": "reflection", "declaration": { - "id": 268, + "id": 291, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 269, + "id": 292, "name": "download", "kind": 1024, "kindString": "Property", @@ -6692,7 +7436,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 515, + "line": 626, "character": 16 } ], @@ -6711,7 +7455,7 @@ } }, { - "id": 270, + "id": 293, "name": "transform", "kind": 1024, "kindString": "Property", @@ -6724,23 +7468,23 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 515, + "line": 626, "character": 45 } ], "type": { "type": "reference", - "id": 435, + "id": 482, "name": "TransformOptions", "dereferenced": { - "id": 435, + "id": 482, "name": "TransformOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 440, + "id": 487, "name": "format", "kind": 1024, "kindString": "Property", @@ -6754,7 +7498,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 110, + "line": 140, "character": 2 } ], @@ -6764,7 +7508,7 @@ } }, { - "id": 437, + "id": 484, "name": "height", "kind": 1024, "kindString": "Property", @@ -6777,7 +7521,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 90, + "line": 120, "character": 2 } ], @@ -6787,7 +7531,7 @@ } }, { - "id": 439, + "id": 486, "name": "quality", "kind": 1024, "kindString": "Property", @@ -6800,7 +7544,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 103, + "line": 133, "character": 2 } ], @@ -6810,7 +7554,7 @@ } }, { - "id": 438, + "id": 485, "name": "resize", "kind": 1024, "kindString": "Property", @@ -6823,7 +7567,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 127, "character": 2 } ], @@ -6846,7 +7590,7 @@ } }, { - "id": 436, + "id": 483, "name": "width", "kind": 1024, "kindString": "Property", @@ -6859,7 +7603,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 86, + "line": 116, "character": 2 } ], @@ -6873,13 +7617,13 @@ { "title": "Properties", "kind": 1024, - "children": [440, 437, 439, 438, 436] + "children": [487, 484, 486, 485, 483] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 82, + "line": 112, "character": 17 } ] @@ -6891,7 +7635,7 @@ { "title": "Properties", "kind": 1024, - "children": [269, 270] + "children": [292, 293] } ] } @@ -6901,14 +7645,14 @@ "type": { "type": "reflection", "declaration": { - "id": 271, + "id": 294, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 272, + "id": 295, "name": "data", "kind": 1024, "kindString": "Property", @@ -6916,21 +7660,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 516, + "line": 627, "character": 7 } ], "type": { "type": "reflection", "declaration": { - "id": 273, + "id": 296, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 274, + "id": 297, "name": "publicUrl", "kind": 1024, "kindString": "Property", @@ -6938,7 +7682,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 516, + "line": 627, "character": 15 } ], @@ -6952,7 +7696,7 @@ { "title": "Properties", "kind": 1024, - "children": [274] + "children": [297] } ] } @@ -6963,7 +7707,7 @@ { "title": "Properties", "kind": 1024, - "children": [272] + "children": [295] } ] } @@ -6972,7 +7716,181 @@ ] }, { - "id": 284, + "id": 269, + "name": "info", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 550, + "character": 8 + } + ], + "signatures": [ + { + "id": 270, + "name": "info", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Retrieves the details of an existing file." + }, + "parameters": [ + { + "id": 271, + "name": "path", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 272, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 273, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 554, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 488, + "typeArguments": [ + { + "type": "reference", + "id": 447, + "name": "FileObjectV2" + } + ], + "name": "Camelize" + } + }, + { + "id": 274, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 555, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [273, 274] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 275, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 276, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 558, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 277, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 559, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 493, + "name": "StorageError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [276, 277] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 307, "name": "list", "kind": 2048, "kindString": "Method", @@ -6980,13 +7898,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 647, + "line": 758, "character": 8 } ], "signatures": [ { - "id": 285, + "id": 308, "name": "list", "kind": 4096, "kindString": "Call signature", @@ -6996,7 +7914,7 @@ }, "parameters": [ { - "id": 286, + "id": 309, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -7012,7 +7930,7 @@ } }, { - "id": 287, + "id": 310, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7021,17 +7939,17 @@ }, "type": { "type": "reference", - "id": 426, + "id": 473, "name": "SearchOptions", "dereferenced": { - "id": 426, + "id": 473, "name": "SearchOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 427, + "id": 474, "name": "limit", "kind": 1024, "kindString": "Property", @@ -7044,7 +7962,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 52, + "line": 82, "character": 2 } ], @@ -7054,7 +7972,7 @@ } }, { - "id": 428, + "id": 475, "name": "offset", "kind": 1024, "kindString": "Property", @@ -7067,7 +7985,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 57, + "line": 87, "character": 2 } ], @@ -7077,7 +7995,7 @@ } }, { - "id": 430, + "id": 477, "name": "search", "kind": 1024, "kindString": "Property", @@ -7090,7 +8008,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 67, + "line": 97, "character": 2 } ], @@ -7100,7 +8018,7 @@ } }, { - "id": 429, + "id": 476, "name": "sortBy", "kind": 1024, "kindString": "Property", @@ -7113,23 +8031,23 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 62, + "line": 92, "character": 2 } ], "type": { "type": "reference", - "id": 418, + "id": 461, "name": "SortBy", "dereferenced": { - "id": 418, + "id": 461, "name": "SortBy", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 419, + "id": 462, "name": "column", "kind": 1024, "kindString": "Property", @@ -7139,7 +8057,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 25, + "line": 41, "character": 2 } ], @@ -7149,7 +8067,7 @@ } }, { - "id": 420, + "id": 463, "name": "order", "kind": 1024, "kindString": "Property", @@ -7159,7 +8077,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 26, + "line": 42, "character": 2 } ], @@ -7173,13 +8091,13 @@ { "title": "Properties", "kind": 1024, - "children": [419, 420] + "children": [462, 463] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 24, + "line": 40, "character": 17 } ] @@ -7191,13 +8109,13 @@ { "title": "Properties", "kind": 1024, - "children": [427, 428, 430, 429] + "children": [474, 475, 477, 476] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 78, "character": 17 } ] @@ -7205,7 +8123,7 @@ } }, { - "id": 288, + "id": 311, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -7214,17 +8132,17 @@ }, "type": { "type": "reference", - "id": 431, + "id": 478, "name": "FetchParameters", "dereferenced": { - "id": 431, + "id": 478, "name": "FetchParameters", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 432, + "id": 479, "name": "signal", "kind": 1024, "kindString": "Property", @@ -7237,7 +8155,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 104, "character": 2 } ], @@ -7253,13 +8171,13 @@ { "title": "Properties", "kind": 1024, - "children": [432] + "children": [479] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 100, "character": 17 } ] @@ -7276,14 +8194,14 @@ { "type": "reflection", "declaration": { - "id": 289, + "id": 312, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 290, + "id": 313, "name": "data", "kind": 1024, "kindString": "Property", @@ -7291,7 +8209,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 653, + "line": 764, "character": 8 } ], @@ -7299,13 +8217,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 408, + "id": 437, "name": "FileObject" } } }, { - "id": 291, + "id": 314, "name": "error", "kind": 1024, "kindString": "Property", @@ -7313,7 +8231,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 654, + "line": 765, "character": 8 } ], @@ -7327,7 +8245,7 @@ { "title": "Properties", "kind": 1024, - "children": [290, 291] + "children": [313, 314] } ] } @@ -7335,14 +8253,14 @@ { "type": "reflection", "declaration": { - "id": 292, + "id": 315, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 293, + "id": 316, "name": "data", "kind": 1024, "kindString": "Property", @@ -7350,7 +8268,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 657, + "line": 768, "character": 8 } ], @@ -7360,7 +8278,7 @@ } }, { - "id": 294, + "id": 317, "name": "error", "kind": 1024, "kindString": "Property", @@ -7368,13 +8286,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 658, + "line": 769, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -7383,7 +8301,7 @@ { "title": "Properties", "kind": 1024, - "children": [293, 294] + "children": [316, 317] } ] } @@ -7399,7 +8317,7 @@ ] }, { - "id": 195, + "id": 198, "name": "move", "kind": 2048, "kindString": "Method", @@ -7407,13 +8325,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 302, + "line": 330, "character": 8 } ], "signatures": [ { - "id": 196, + "id": 199, "name": "move", "kind": 4096, "kindString": "Call signature", @@ -7423,7 +8341,7 @@ }, "parameters": [ { - "id": 197, + "id": 200, "name": "fromPath", "kind": 32768, "kindString": "Parameter", @@ -7437,18 +8355,78 @@ } }, { - "id": 198, + "id": 201, "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" + "shortText": "The new file path, including the new file name. For example `folder/image-new.png`." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 202, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The destination options.\n" + }, + "type": { + "type": "reference", + "id": 471, + "name": "DestinationOptions", + "dereferenced": { + "id": 471, + "name": "DestinationOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 472, + "name": "destinationBucket", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [472] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 74, + "character": 17 + } + ] + } + } } ], "type": { @@ -7460,14 +8438,14 @@ { "type": "reflection", "declaration": { - "id": 199, + "id": 203, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 200, + "id": 204, "name": "data", "kind": 1024, "kindString": "Property", @@ -7475,21 +8453,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 307, + "line": 336, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 201, + "id": 205, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 202, + "id": 206, "name": "message", "kind": 1024, "kindString": "Property", @@ -7497,7 +8475,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 307, + "line": 336, "character": 16 } ], @@ -7511,14 +8489,14 @@ { "title": "Properties", "kind": 1024, - "children": [202] + "children": [206] } ] } } }, { - "id": 203, + "id": 207, "name": "error", "kind": 1024, "kindString": "Property", @@ -7526,7 +8504,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 308, + "line": 337, "character": 8 } ], @@ -7540,7 +8518,7 @@ { "title": "Properties", "kind": 1024, - "children": [200, 203] + "children": [204, 207] } ] } @@ -7548,14 +8526,14 @@ { "type": "reflection", "declaration": { - "id": 204, + "id": 208, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 205, + "id": 209, "name": "data", "kind": 1024, "kindString": "Property", @@ -7563,7 +8541,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 311, + "line": 340, "character": 8 } ], @@ -7573,7 +8551,7 @@ } }, { - "id": 206, + "id": 210, "name": "error", "kind": 1024, "kindString": "Property", @@ -7581,13 +8559,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 312, + "line": 341, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -7596,7 +8574,7 @@ { "title": "Properties", "kind": 1024, - "children": [205, 206] + "children": [209, 210] } ] } @@ -7612,7 +8590,7 @@ ] }, { - "id": 275, + "id": 298, "name": "remove", "kind": 2048, "kindString": "Method", @@ -7620,13 +8598,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 551, + "line": 662, "character": 8 } ], "signatures": [ { - "id": 276, + "id": 299, "name": "remove", "kind": 4096, "kindString": "Call signature", @@ -7636,7 +8614,7 @@ }, "parameters": [ { - "id": 277, + "id": 300, "name": "paths", "kind": 32768, "kindString": "Parameter", @@ -7662,14 +8640,14 @@ { "type": "reflection", "declaration": { - "id": 278, + "id": 301, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 279, + "id": 302, "name": "data", "kind": 1024, "kindString": "Property", @@ -7677,7 +8655,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 555, + "line": 666, "character": 8 } ], @@ -7685,13 +8663,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 408, + "id": 437, "name": "FileObject" } } }, { - "id": 280, + "id": 303, "name": "error", "kind": 1024, "kindString": "Property", @@ -7699,7 +8677,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 556, + "line": 667, "character": 8 } ], @@ -7713,7 +8691,7 @@ { "title": "Properties", "kind": 1024, - "children": [279, 280] + "children": [302, 303] } ] } @@ -7721,14 +8699,14 @@ { "type": "reflection", "declaration": { - "id": 281, + "id": 304, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 282, + "id": 305, "name": "data", "kind": 1024, "kindString": "Property", @@ -7736,7 +8714,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 559, + "line": 670, "character": 8 } ], @@ -7746,7 +8724,7 @@ } }, { - "id": 283, + "id": 306, "name": "error", "kind": 1024, "kindString": "Property", @@ -7754,13 +8732,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 560, + "line": 671, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -7769,7 +8747,7 @@ { "title": "Properties", "kind": 1024, - "children": [282, 283] + "children": [305, 306] } ] } @@ -7785,7 +8763,47 @@ ] }, { - "id": 180, + "id": 321, + "name": "toBase64", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 795, + "character": 2 + } + ], + "signatures": [ + { + "id": 322, + "name": "toBase64", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 323, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 183, "name": "update", "kind": 2048, "kindString": "Method", @@ -7793,13 +8811,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 269, + "line": 296, "character": 8 } ], "signatures": [ { - "id": 181, + "id": 184, "name": "update", "kind": 4096, "kindString": "Call signature", @@ -7809,7 +8827,7 @@ }, "parameters": [ { - "id": 182, + "id": 185, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -7823,7 +8841,7 @@ } }, { - "id": 183, + "id": 186, "name": "fileBody", "kind": 32768, "kindString": "Parameter", @@ -7904,7 +8922,7 @@ } }, { - "id": 184, + "id": 187, "name": "fileOptions", "kind": 32768, "kindString": "Parameter", @@ -7913,17 +8931,17 @@ }, "type": { "type": "reference", - "id": 421, + "id": 464, "name": "FileOptions", "dereferenced": { - "id": 421, + "id": 464, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 422, + "id": 465, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -7936,7 +8954,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 33, + "line": 49, "character": 2 } ], @@ -7946,7 +8964,7 @@ } }, { - "id": 423, + "id": 466, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -7959,7 +8977,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 37, + "line": 53, "character": 2 } ], @@ -7969,7 +8987,7 @@ } }, { - "id": 425, + "id": 468, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -7982,7 +9000,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 45, + "line": 61, "character": 2 } ], @@ -7992,7 +9010,77 @@ } }, { - "id": 424, + "id": 470, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optionally add extra headers" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 469, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "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." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 467, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -8005,7 +9093,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 41, + "line": 57, "character": 2 } ], @@ -8019,13 +9107,13 @@ { "title": "Properties", "kind": 1024, - "children": [422, 423, 425, 424] + "children": [465, 466, 468, 470, 469, 467] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 29, + "line": 45, "character": 17 } ] @@ -8042,14 +9130,14 @@ { "type": "reflection", "declaration": { - "id": 185, + "id": 188, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 186, + "id": 189, "name": "data", "kind": 1024, "kindString": "Property", @@ -8057,21 +9145,21 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 285, + "line": 312, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 187, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 190, + "id": 193, "name": "fullPath", "kind": 1024, "kindString": "Property", @@ -8079,7 +9167,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 285, + "line": 312, "character": 42 } ], @@ -8089,7 +9177,7 @@ } }, { - "id": 188, + "id": 191, "name": "id", "kind": 1024, "kindString": "Property", @@ -8097,7 +9185,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 285, + "line": 312, "character": 16 } ], @@ -8107,7 +9195,7 @@ } }, { - "id": 189, + "id": 192, "name": "path", "kind": 1024, "kindString": "Property", @@ -8115,7 +9203,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 285, + "line": 312, "character": 28 } ], @@ -8129,67 +9217,12 @@ { "title": "Properties", "kind": 1024, - "children": [190, 188, 189] + "children": [193, 191, 192] } ] } } }, - { - "id": 191, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 286, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [186, 191] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 192, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 193, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 289, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, { "id": 194, "name": "error", @@ -8199,13 +9232,68 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 290, + "line": 313, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [189, 194] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 195, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 196, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 316, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 197, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/packages/StorageFileApi.ts", + "line": 317, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -8214,7 +9302,7 @@ { "title": "Properties", "kind": 1024, - "children": [193, 194] + "children": [196, 197] } ] } @@ -8238,7 +9326,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 135, + "line": 154, "character": 8 } ], @@ -8291,17 +9379,17 @@ }, "type": { "type": "reference", - "id": 421, + "id": 464, "name": "FileOptions", "dereferenced": { - "id": 421, + "id": 464, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 422, + "id": 465, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -8314,7 +9402,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 33, + "line": 49, "character": 2 } ], @@ -8324,7 +9412,7 @@ } }, { - "id": 423, + "id": 466, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -8337,7 +9425,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 37, + "line": 53, "character": 2 } ], @@ -8347,7 +9435,7 @@ } }, { - "id": 425, + "id": 468, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -8360,7 +9448,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 45, + "line": 61, "character": 2 } ], @@ -8370,7 +9458,77 @@ } }, { - "id": 424, + "id": 470, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optionally add extra headers" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 469, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "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." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 467, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -8383,7 +9541,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 41, + "line": 57, "character": 2 } ], @@ -8397,13 +9555,13 @@ { "title": "Properties", "kind": 1024, - "children": [422, 423, 425, 424] + "children": [465, 466, 468, 470, 469, 467] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 29, + "line": 45, "character": 17 } ] @@ -8435,7 +9593,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 160, "character": 8 } ], @@ -8457,7 +9615,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 160, "character": 42 } ], @@ -8475,7 +9633,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 160, "character": 16 } ], @@ -8493,7 +9651,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 141, + "line": 160, "character": 28 } ], @@ -8522,7 +9680,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 142, + "line": 161, "character": 8 } ], @@ -8559,7 +9717,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 145, + "line": 164, "character": 8 } ], @@ -8577,13 +9735,13 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 146, + "line": 165, "character": 8 } ], "type": { "type": "reference", - "id": 444, + "id": 493, "name": "StorageError" } } @@ -8616,7 +9774,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 158, + "line": 177, "character": 8 } ], @@ -8683,17 +9841,17 @@ }, "type": { "type": "reference", - "id": 421, + "id": 464, "name": "FileOptions", "dereferenced": { - "id": 421, + "id": 464, "name": "FileOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 422, + "id": 465, "name": "cacheControl", "kind": 1024, "kindString": "Property", @@ -8706,7 +9864,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 33, + "line": 49, "character": 2 } ], @@ -8716,7 +9874,7 @@ } }, { - "id": 423, + "id": 466, "name": "contentType", "kind": 1024, "kindString": "Property", @@ -8729,7 +9887,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 37, + "line": 53, "character": 2 } ], @@ -8739,7 +9897,7 @@ } }, { - "id": 425, + "id": 468, "name": "duplex", "kind": 1024, "kindString": "Property", @@ -8752,7 +9910,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 45, + "line": 61, "character": 2 } ], @@ -8762,7 +9920,77 @@ } }, { - "id": 424, + "id": 470, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optionally add extra headers" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 71, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 469, + "name": "metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "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." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 467, "name": "upsert", "kind": 1024, "kindString": "Property", @@ -8775,7 +10003,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 41, + "line": 57, "character": 2 } ], @@ -8789,13 +10017,13 @@ { "title": "Properties", "kind": 1024, - "children": [422, 423, 425, 424] + "children": [465, 466, 468, 470, 469, 467] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 29, + "line": 45, "character": 17 } ] @@ -8827,7 +10055,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 201, + "line": 220, "character": 10 } ], @@ -8849,7 +10077,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 201, + "line": 220, "character": 35 } ], @@ -8868,7 +10096,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 201, + "line": 220, "character": 18 } ], @@ -8899,7 +10127,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 202, + "line": 221, "character": 10 } ], @@ -8937,7 +10165,7 @@ "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 206, + "line": 225, "character": 17 } ], @@ -8988,13 +10216,15 @@ { "title": "Methods", "kind": 2048, - "children": [207, 167, 219, 235, 252, 264, 284, 195, 275, 180, 137, 152] + "children": [ + 211, 167, 224, 240, 257, 278, 287, 269, 307, 198, 298, 321, 183, 137, 152 + ] } ], "sources": [ { "fileName": "src/packages/StorageFileApi.ts", - "line": 39, + "line": 42, "character": 21 } ] diff --git a/apps/docs/spec/enrichments/tsdoc_v2/supabase.json b/apps/docs/spec/enrichments/tsdoc_v2/supabase.json index e2d874f92c7..7d41ba80e5d 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/supabase.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/supabase.json @@ -13,7 +13,7 @@ "flags": {}, "children": [ { - "id": 213, + "id": 227, "name": "QueryData", "kind": 16777216, "kindString": "Reference", @@ -25,10 +25,10 @@ "character": 50 } ], - "target": 112 + "target": 123 }, { - "id": 214, + "id": 228, "name": "QueryError", "kind": 16777216, "kindString": "Reference", @@ -40,10 +40,10 @@ "character": 61 } ], - "target": 116 + "target": 127 }, { - "id": 212, + "id": 226, "name": "QueryResult", "kind": 16777216, "kindString": "Reference", @@ -55,10 +55,10 @@ "character": 37 } ], - "target": 110 + "target": 121 }, { - "id": 211, + "id": 225, "name": "SupabaseClientOptions", "kind": 16777216, "kindString": "Reference", @@ -73,7 +73,7 @@ "target": 70 }, { - "id": 119, + "id": 130, "name": "SupabaseClient", "kind": 128, "kindString": "Class", @@ -84,7 +84,7 @@ }, "children": [ { - "id": 120, + "id": 131, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -92,13 +92,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 69, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 121, + "id": 132, "name": "new SupabaseClient", "kind": 16384, "kindString": "Constructor signature", @@ -108,7 +108,7 @@ }, "typeParameter": [ { - "id": 122, + "id": 133, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -119,7 +119,7 @@ } }, { - "id": 123, + "id": 134, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -139,7 +139,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, @@ -159,7 +159,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } } @@ -168,14 +168,14 @@ } }, { - "id": 124, + "id": 135, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "default": { @@ -184,18 +184,18 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, "extendsType": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "trueType": { @@ -218,7 +218,7 @@ ], "parameters": [ { - "id": 125, + "id": 136, "name": "supabaseUrl", "kind": 32768, "kindString": "Parameter", @@ -232,7 +232,7 @@ } }, { - "id": 126, + "id": 137, "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", @@ -246,7 +246,7 @@ } }, { - "id": 127, + "id": 138, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -259,7 +259,7 @@ "typeArguments": [ { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" } ], @@ -269,21 +269,21 @@ ], "type": { "type": "reference", - "id": 119, + "id": 130, "typeArguments": [ { "type": "reference", - "id": 122, + "id": 133, "name": "Database" }, { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, { "type": "reference", - "id": 124, + "id": 135, "name": "Schema" } ], @@ -293,7 +293,64 @@ ] }, { - "id": 128, + "id": 153, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 54, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 154, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 155, + "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": 139, "name": "auth", "kind": 1024, "kindString": "Property", @@ -314,7 +371,7 @@ } }, { - "id": 131, + "id": 142, "name": "authUrl", "kind": 1024, "kindString": "Property", @@ -334,7 +391,7 @@ } }, { - "id": 141, + "id": 152, "name": "changedAccessToken", "kind": 1024, "kindString": "Property", @@ -355,7 +412,7 @@ } }, { - "id": 136, + "id": 147, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -373,21 +430,21 @@ "type": { "type": "reflection", "declaration": { - "id": 137, + "id": 148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 138, + "id": 149, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 139, + "id": 150, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -411,7 +468,7 @@ } }, { - "id": 140, + "id": 151, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -446,7 +503,7 @@ } }, { - "id": 133, + "id": 144, "name": "functionsUrl", "kind": 1024, "kindString": "Property", @@ -466,7 +523,7 @@ } }, { - "id": 142, + "id": 156, "name": "headers", "kind": 1024, "kindString": "Property", @@ -476,7 +533,7 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 55, + "line": 56, "character": 12 } ], @@ -498,7 +555,7 @@ } }, { - "id": 129, + "id": 140, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -518,7 +575,7 @@ } }, { - "id": 130, + "id": 141, "name": "realtimeUrl", "kind": 1024, "kindString": "Property", @@ -538,7 +595,7 @@ } }, { - "id": 134, + "id": 145, "name": "rest", "kind": 1024, "kindString": "Property", @@ -557,50 +614,18 @@ "typeArguments": [ { "type": "reference", - "id": 122, + "id": 133, "name": "Database" }, { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 123, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 122, - "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" - } + "type": "reference", + "id": 135, + "name": "Schema" } ], "qualifiedName": "PostgrestClient", @@ -609,7 +634,7 @@ } }, { - "id": 135, + "id": 146, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -629,7 +654,7 @@ } }, { - "id": 132, + "id": 143, "name": "storageUrl", "kind": 1024, "kindString": "Property", @@ -649,7 +674,7 @@ } }, { - "id": 144, + "id": 158, "name": "supabaseKey", "kind": 1024, "kindString": "Property", @@ -662,7 +687,7 @@ } }, { - "id": 143, + "id": 157, "name": "supabaseUrl", "kind": 1024, "kindString": "Property", @@ -675,7 +700,7 @@ } }, { - "id": 145, + "id": 159, "name": "functions", "kind": 262144, "kindString": "Accessor", @@ -683,13 +708,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 118, + "line": 139, "character": 6 } ], "getSignature": [ { - "id": 146, + "id": 160, "name": "functions", "kind": 524288, "kindString": "Get signature", @@ -707,7 +732,7 @@ ] }, { - "id": 147, + "id": 161, "name": "storage", "kind": 262144, "kindString": "Accessor", @@ -715,13 +740,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 128, + "line": 149, "character": 6 } ], "getSignature": [ { - "id": 148, + "id": 162, "name": "storage", "kind": 524288, "kindString": "Get signature", @@ -739,7 +764,7 @@ ] }, { - "id": 186, + "id": 200, "name": "_getAccessToken", "kind": 2048, "kindString": "Method", @@ -749,13 +774,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 246, + "line": 269, "character": 16 } ], "signatures": [ { - "id": 187, + "id": 201, "name": "_getAccessToken", "kind": 4096, "kindString": "Call signature", @@ -785,7 +810,7 @@ ] }, { - "id": 203, + "id": 217, "name": "_handleTokenChanged", "kind": 2048, "kindString": "Method", @@ -795,20 +820,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 297, + "line": 329, "character": 10 } ], "signatures": [ { - "id": 204, + "id": 218, "name": "_handleTokenChanged", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 205, + "id": 219, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -821,7 +846,7 @@ } }, { - "id": 206, + "id": 220, "name": "source", "kind": 32768, "kindString": "Parameter", @@ -841,7 +866,7 @@ } }, { - "id": 207, + "id": 221, "name": "token", "kind": 32768, "kindString": "Parameter", @@ -862,7 +887,7 @@ ] }, { - "id": 197, + "id": 211, "name": "_initRealtimeClient", "kind": 2048, "kindString": "Method", @@ -872,20 +897,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 283, + "line": 315, "character": 10 } ], "signatures": [ { - "id": 198, + "id": 212, "name": "_initRealtimeClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 199, + "id": 213, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -908,7 +933,7 @@ ] }, { - "id": 188, + "id": 202, "name": "_initSupabaseAuthClient", "kind": 2048, "kindString": "Method", @@ -918,20 +943,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 252, + "line": 279, "character": 10 } ], "signatures": [ { - "id": 189, + "id": 203, "name": "_initSupabaseAuthClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 190, + "id": 204, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -943,7 +968,7 @@ } }, { - "id": 191, + "id": 205, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -968,7 +993,7 @@ } }, { - "id": 192, + "id": 206, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -978,21 +1003,21 @@ "type": { "type": "reflection", "declaration": { - "id": 193, + "id": 207, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 194, + "id": 208, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 209, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1016,7 +1041,7 @@ } }, { - "id": 196, + "id": 210, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1059,7 +1084,7 @@ ] }, { - "id": 200, + "id": 214, "name": "_listenForAuthEvents", "kind": 2048, "kindString": "Method", @@ -1069,13 +1094,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 290, + "line": 322, "character": 10 } ], "signatures": [ { - "id": 201, + "id": 215, "name": "_listenForAuthEvents", "kind": 4096, "kindString": "Call signature", @@ -1083,7 +1108,7 @@ "type": { "type": "reflection", "declaration": { - "id": 202, + "id": 216, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1094,7 +1119,7 @@ ] }, { - "id": 175, + "id": 189, "name": "channel", "kind": 2048, "kindString": "Method", @@ -1102,13 +1127,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 218, + "line": 241, "character": 2 } ], "signatures": [ { - "id": 176, + "id": 190, "name": "channel", "kind": 4096, "kindString": "Call signature", @@ -1118,7 +1143,7 @@ }, "parameters": [ { - "id": 177, + "id": 191, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -1132,7 +1157,7 @@ } }, { - "id": 178, + "id": 192, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -1159,7 +1184,7 @@ ] }, { - "id": 149, + "id": 163, "name": "from", "kind": 2048, "kindString": "Method", @@ -1167,13 +1192,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 133, + "line": 154, "character": 2 } ], "signatures": [ { - "id": 150, + "id": 164, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1183,7 +1208,7 @@ }, "typeParameter": [ { - "id": 151, + "id": 165, "name": "TableName", "kind": 131072, "kindString": "Type parameter", @@ -1194,21 +1219,21 @@ } }, { - "id": 152, + "id": 166, "name": "Table", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 91, + "id": 100, "name": "GenericTable" } } ], "parameters": [ { - "id": 153, + "id": 167, "name": "relation", "kind": 32768, "kindString": "Parameter", @@ -1218,7 +1243,7 @@ }, "type": { "type": "reference", - "id": 151, + "id": 165, "name": "TableName" } } @@ -1228,30 +1253,30 @@ "typeArguments": [ { "type": "reference", - "id": 124, + "id": 135, "name": "Schema" }, { "type": "reference", - "id": 152, + "id": 166, "name": "Table" }, { "type": "reference", - "id": 151, + "id": 165, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 152, + "id": 166, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { - "id": 154, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1276,7 +1301,7 @@ } }, { - "id": 155, + "id": 169, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1286,7 +1311,7 @@ }, "typeParameter": [ { - "id": 156, + "id": 170, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", @@ -1297,21 +1322,21 @@ } }, { - "id": 157, + "id": 171, "name": "View", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 100, + "id": 111, "name": "GenericView" } } ], "parameters": [ { - "id": 158, + "id": 172, "name": "relation", "kind": 32768, "kindString": "Parameter", @@ -1321,7 +1346,7 @@ }, "type": { "type": "reference", - "id": 156, + "id": 170, "name": "ViewName" } } @@ -1331,30 +1356,30 @@ "typeArguments": [ { "type": "reference", - "id": 124, + "id": 135, "name": "Schema" }, { "type": "reference", - "id": 157, + "id": 171, "name": "View" }, { "type": "reference", - "id": 156, + "id": 170, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 157, + "id": 171, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { - "id": 159, + "id": 173, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1381,7 +1406,7 @@ ] }, { - "id": 179, + "id": 193, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -1389,13 +1414,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 225, + "line": 248, "character": 2 } ], "signatures": [ { - "id": 180, + "id": 194, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -1416,7 +1441,7 @@ ] }, { - "id": 184, + "id": 198, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -1424,13 +1449,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 242, + "line": 265, "character": 2 } ], "signatures": [ { - "id": 185, + "id": 199, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -1470,7 +1495,7 @@ ] }, { - "id": 181, + "id": 195, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -1478,13 +1503,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 235, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 182, + "id": 196, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -1494,7 +1519,7 @@ }, "parameters": [ { - "id": 183, + "id": 197, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -1539,7 +1564,7 @@ ] }, { - "id": 164, + "id": 178, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -1547,13 +1572,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 191, + "line": 212, "character": 2 } ], "signatures": [ { - "id": 165, + "id": 179, "name": "rpc", "kind": 4096, "kindString": "Call signature", @@ -1563,7 +1588,7 @@ }, "typeParameter": [ { - "id": 166, + "id": 180, "name": "FnName", "kind": 131072, "kindString": "Type parameter", @@ -1574,21 +1599,21 @@ } }, { - "id": 167, + "id": 181, "name": "Fn", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 101, + "id": 112, "name": "GenericFunction" } } ], "parameters": [ { - "id": 168, + "id": 182, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -1598,12 +1623,12 @@ }, "type": { "type": "reference", - "id": 166, + "id": 180, "name": "FnName" } }, { - "id": 169, + "id": 183, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -1619,14 +1644,14 @@ }, "objectType": { "type": "reference", - "id": 167, + "id": 181, "name": "Fn" } }, "defaultValue": "{}" }, { - "id": 170, + "id": 184, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -1637,14 +1662,14 @@ "type": { "type": "reflection", "declaration": { - "id": 171, + "id": 185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 174, + "id": 188, "name": "count", "kind": 1024, "kindString": "Property", @@ -1657,7 +1682,7 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 197, + "line": 218, "character": 6 } ], @@ -1680,7 +1705,7 @@ } }, { - "id": 173, + "id": 187, "name": "get", "kind": 1024, "kindString": "Property", @@ -1693,7 +1718,7 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 196, + "line": 217, "character": 6 } ], @@ -1703,7 +1728,7 @@ } }, { - "id": 172, + "id": 186, "name": "head", "kind": 1024, "kindString": "Property", @@ -1716,7 +1741,7 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 195, + "line": 216, "character": 6 } ], @@ -1730,7 +1755,7 @@ { "title": "Properties", "kind": 1024, - "children": [174, 173, 172] + "children": [188, 187, 186] } ] } @@ -1743,7 +1768,7 @@ "typeArguments": [ { "type": "reference", - "id": 124, + "id": 135, "name": "Schema" }, { @@ -1756,7 +1781,7 @@ }, "objectType": { "type": "reference", - "id": 167, + "id": 181, "name": "Fn" } }, @@ -1832,17 +1857,18 @@ }, "objectType": { "type": "reference", - "id": 167, + "id": 181, "name": "Fn" } }, { - "type": "intrinsic", - "name": "unknown" + "type": "reference", + "id": 180, + "name": "FnName" }, { - "type": "intrinsic", - "name": "unknown" + "type": "literal", + "value": null } ], "qualifiedName": "PostgrestFilterBuilder", @@ -1853,7 +1879,7 @@ ] }, { - "id": 160, + "id": 174, "name": "schema", "kind": 2048, "kindString": "Method", @@ -1861,13 +1887,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 157, + "line": 178, "character": 2 } ], "signatures": [ { - "id": 161, + "id": 175, "name": "schema", "kind": 4096, "kindString": "Call signature", @@ -1878,7 +1904,7 @@ }, "typeParameter": [ { - "id": 162, + "id": 176, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", @@ -1891,7 +1917,7 @@ ], "parameters": [ { - "id": 163, + "id": 177, "name": "schema", "kind": 32768, "kindString": "Parameter", @@ -1901,7 +1927,7 @@ }, "type": { "type": "reference", - "id": 162, + "id": 176, "name": "DynamicSchema" } } @@ -1911,12 +1937,12 @@ "typeArguments": [ { "type": "reference", - "id": 122, + "id": 133, "name": "Database" }, { "type": "reference", - "id": 162, + "id": 176, "name": "DynamicSchema" }, { @@ -1925,18 +1951,18 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 162, + "id": 176, "name": "DynamicSchema" }, "objectType": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, "extendsType": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "trueType": { @@ -1968,22 +1994,22 @@ { "title": "Constructors", "kind": 512, - "children": [120] + "children": [131] }, { "title": "Properties", "kind": 1024, - "children": [128, 131, 141, 136, 133, 142, 129, 130, 134, 135, 132, 144, 143] + "children": [153, 139, 142, 152, 147, 144, 156, 140, 141, 145, 146, 143, 158, 157] }, { "title": "Accessors", "kind": 262144, - "children": [145, 147] + "children": [159, 161] }, { "title": "Methods", "kind": 2048, - "children": [186, 203, 197, 188, 200, 175, 149, 179, 184, 181, 164, 160] + "children": [200, 217, 211, 202, 214, 189, 163, 193, 198, 195, 178, 174] } ], "sources": [ @@ -1995,7 +2021,7 @@ ], "typeParameter": [ { - "id": 208, + "id": 222, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -2006,7 +2032,7 @@ } }, { - "id": 209, + "id": 223, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -2023,7 +2049,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } } @@ -2040,7 +2066,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, @@ -2060,7 +2086,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } } @@ -2069,14 +2095,14 @@ } }, { - "id": 210, + "id": 224, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "default": { @@ -2085,30 +2111,30 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, "extendsType": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, @@ -2212,7 +2238,7 @@ "flags": {}, "type": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "default": { @@ -2232,7 +2258,7 @@ }, "extendsType": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "trueType": { @@ -2300,7 +2326,7 @@ ], "type": { "type": "reference", - "id": 119, + "id": 130, "typeArguments": [ { "type": "reference", @@ -2328,12 +2354,12 @@ { "title": "References", "kind": 16777216, - "children": [213, 214, 212, 211] + "children": [227, 228, 226, 225] }, { "title": "Classes", "kind": 128, - "children": [119] + "children": [130] }, { "title": "Functions", @@ -3218,15 +3244,23 @@ ], "type": { "type": "reference", - "id": 70, "typeArguments": [ { "type": "reference", - "id": 62, - "name": "SchemaName" + "id": 70, + "typeArguments": [ + { + "type": "reference", + "id": 62, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" } ], - "name": "SupabaseClientOptions" + "qualifiedName": "Required", + "package": "typescript", + "name": "Required" } } ] @@ -3393,7 +3427,7 @@ } }, { - "id": 101, + "id": 112, "name": "GenericFunction", "kind": 4194304, "kindString": "Type alias", @@ -3401,25 +3435,246 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 85, + "line": 107, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 102, + "id": 113, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 103, + "id": 114, "name": "Args", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 115, + "name": "Returns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 109, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [114, 115] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 107, + "character": 30 + } + ] + } + } + }, + { + "id": 107, + "name": "GenericNonUpdatableView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 108, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 110, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 102, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 93, + "name": "GenericRelationship" + } + } + }, + { + "id": 109, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 101, + "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": [110, 109] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, + "character": 38 + } + ] + } + } + }, + { + "id": 93, + "name": "GenericRelationship", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 83, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 94, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 96, + "name": "columns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 85, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 95, + "name": "foreignKeyName", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 84, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 97, + "name": "isOneToOne", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", @@ -3427,6 +3682,288 @@ "character": 2 } ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 99, + "name": "referencedColumns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 98, + "name": "referencedRelation", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 87, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [96, 95, 97, 99, 98] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 83, + "character": 34 + } + ] + } + } + }, + { + "id": 116, + "name": "GenericSchema", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 112, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 117, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 120, + "name": "Functions", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 112, + "name": "GenericFunction" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 118, + "name": "Tables", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 100, + "name": "GenericTable" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 119, + "name": "Views", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 114, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 111, + "name": "GenericView" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [120, 118, 119] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 112, + "character": 28 + } + ] + } + } + }, + { + "id": 100, + "name": "GenericTable", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 91, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 101, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 103, + "name": "Insert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 93, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 105, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 95, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 93, + "name": "GenericRelationship" + } + } + }, + { + "id": 102, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 92, + "character": 2 + } + ], "type": { "type": "reference", "typeArguments": [ @@ -3446,327 +3983,6 @@ }, { "id": 104, - "name": "Returns", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [103, 104] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 85, - "character": 30 - } - ] - } - } - }, - { - "id": 97, - "name": "GenericNonUpdatableView", - "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": 99, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 80, - "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": [99] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 38 - } - ] - } - } - }, - { - "id": 105, - "name": "GenericSchema", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 90, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 106, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 109, - "name": "Functions", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 101, - "name": "GenericFunction" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 107, - "name": "Tables", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 91, - "name": "GenericTable" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 108, - "name": "Views", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 100, - "name": "GenericView" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [109, 107, 108] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 90, - "character": 28 - } - ] - } - } - }, - { - "id": 91, - "name": "GenericTable", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 92, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 94, - "name": "Insert", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 93, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 95, "name": "Update", "kind": 1024, "kindString": "Property", @@ -3774,7 +3990,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 94, "character": 2 } ], @@ -3800,13 +4016,13 @@ { "title": "Properties", "kind": 1024, - "children": [94, 93, 95] + "children": [103, 105, 102, 104] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 71, + "line": 91, "character": 27 } ] @@ -3814,7 +4030,7 @@ } }, { - "id": 96, + "id": 106, "name": "GenericUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -3822,18 +4038,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 77, + "line": 98, "character": 12 } ], "type": { "type": "reference", - "id": 91, + "id": 100, "name": "GenericTable" } }, { - "id": 100, + "id": 111, "name": "GenericView", "kind": 4194304, "kindString": "Type alias", @@ -3841,7 +4057,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 83, + "line": 105, "character": 12 } ], @@ -3850,19 +4066,19 @@ "types": [ { "type": "reference", - "id": 96, + "id": 106, "name": "GenericUpdatableView" }, { "type": "reference", - "id": 97, + "id": 107, "name": "GenericNonUpdatableView" } ] } }, { - "id": 112, + "id": 123, "name": "QueryData", "kind": 4194304, "kindString": "Type alias", @@ -3870,13 +4086,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, + "line": 122, "character": 12 } ], "typeParameter": [ { - "id": 115, + "id": 126, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -3887,7 +4103,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 115, + "id": 126, "name": "T" }, "extendsType": { @@ -3896,14 +4112,14 @@ { "type": "reflection", "declaration": { - "id": 113, + "id": 124, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 114, + "id": 125, "name": "data", "kind": 1024, "kindString": "Property", @@ -3911,7 +4127,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, + "line": 122, "character": 51 } ], @@ -3925,13 +4141,13 @@ { "title": "Properties", "kind": 1024, - "children": [114] + "children": [125] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, + "line": 122, "character": 49 } ] @@ -3965,7 +4181,7 @@ } }, { - "id": 116, + "id": 127, "name": "QueryError", "kind": 4194304, "kindString": "Type alias", @@ -3973,7 +4189,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 101, + "line": 123, "character": 12 } ], @@ -3985,7 +4201,7 @@ } }, { - "id": 110, + "id": 121, "name": "QueryResult", "kind": 4194304, "kindString": "Type alias", @@ -3996,13 +4212,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 99, + "line": 121, "character": 12 } ], "typeParameter": [ { - "id": 111, + "id": 122, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -4013,7 +4229,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 111, + "id": 122, "name": "T" }, "extendsType": { @@ -4053,7 +4269,7 @@ ], "typeParameter": [ { - "id": 90, + "id": 92, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -4377,7 +4593,7 @@ ], "type": { "type": "reference", - "id": 90, + "id": 92, "name": "SchemaName" } } @@ -4524,6 +4740,56 @@ "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } + }, + { + "id": 90, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "signatures": [ + { + "id": 91, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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 client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", + "text": "When 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.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -4531,6 +4797,11 @@ "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] + }, + { + "title": "Methods", + "kind": 2048, + "children": [90] } ], "sources": [ @@ -4553,7 +4824,7 @@ { "title": "Type Aliases", "kind": 4194304, - "children": [69, 101, 97, 105, 91, 96, 100, 112, 116, 110, 70] + "children": [69, 112, 107, 93, 116, 100, 106, 111, 123, 127, 121, 70] } ], "sources": [ @@ -4565,14 +4836,14 @@ ] }, { - "id": 117, + "id": 128, "name": "lib/version", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 118, + "id": 129, "name": "version", "kind": 32, "kindString": "Variable", @@ -4597,7 +4868,7 @@ { "title": "Variables", "kind": 32, - "children": [118] + "children": [129] } ], "sources": [ @@ -4613,7 +4884,7 @@ { "title": "Modules", "kind": 2, - "children": [1, 10, 24, 53, 67, 117] + "children": [1, 10, 24, 53, 67, 128] } ] } diff --git a/apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json index 0e66dfc7222..628359a9643 100644 --- a/apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json +++ b/apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json @@ -13,7 +13,7 @@ "flags": {}, "children": [ { - "id": 213, + "id": 227, "name": "QueryData", "kind": 16777216, "kindString": "Reference", @@ -25,10 +25,10 @@ "character": 50 } ], - "target": 112 + "target": 123 }, { - "id": 214, + "id": 228, "name": "QueryError", "kind": 16777216, "kindString": "Reference", @@ -40,10 +40,10 @@ "character": 61 } ], - "target": 116 + "target": 127 }, { - "id": 212, + "id": 226, "name": "QueryResult", "kind": 16777216, "kindString": "Reference", @@ -55,10 +55,10 @@ "character": 37 } ], - "target": 110 + "target": 121 }, { - "id": 211, + "id": 225, "name": "SupabaseClientOptions", "kind": 16777216, "kindString": "Reference", @@ -73,7 +73,7 @@ "target": 70 }, { - "id": 119, + "id": 130, "name": "SupabaseClient", "kind": 128, "kindString": "Class", @@ -84,7 +84,7 @@ }, "children": [ { - "id": 120, + "id": 131, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -92,13 +92,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 69, + "line": 70, "character": 2 } ], "signatures": [ { - "id": 121, + "id": 132, "name": "new SupabaseClient", "kind": 16384, "kindString": "Constructor signature", @@ -108,7 +108,7 @@ }, "typeParameter": [ { - "id": 122, + "id": 133, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -119,7 +119,7 @@ } }, { - "id": 123, + "id": 134, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -139,7 +139,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, @@ -159,7 +159,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } } @@ -168,14 +168,14 @@ } }, { - "id": 124, + "id": 135, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "default": { @@ -184,18 +184,18 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, "extendsType": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "trueType": { @@ -218,7 +218,7 @@ ], "parameters": [ { - "id": 125, + "id": 136, "name": "supabaseUrl", "kind": 32768, "kindString": "Parameter", @@ -232,7 +232,7 @@ } }, { - "id": 126, + "id": 137, "name": "supabaseKey", "kind": 32768, "kindString": "Parameter", @@ -246,7 +246,7 @@ } }, { - "id": 127, + "id": 138, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -259,7 +259,7 @@ "typeArguments": [ { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" } ], @@ -279,7 +279,7 @@ ], "typeParameter": [ { - "id": 90, + "id": 92, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -603,7 +603,7 @@ ], "type": { "type": "reference", - "id": 90, + "id": 92, "name": "SchemaName", "dereferenced": {} } @@ -775,6 +775,56 @@ "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } + }, + { + "id": 90, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "signatures": [ + { + "id": 91, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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 client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", + "text": "When 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.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -782,6 +832,11 @@ "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] + }, + { + "title": "Methods", + "kind": 2048, + "children": [90] } ], "sources": [ @@ -799,21 +854,21 @@ ], "type": { "type": "reference", - "id": 119, + "id": 130, "typeArguments": [ { "type": "reference", - "id": 122, + "id": 133, "name": "Database" }, { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, { "type": "reference", - "id": 124, + "id": 135, "name": "Schema" } ], @@ -823,7 +878,64 @@ ] }, { - "id": 128, + "id": 153, + "name": "accessToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isProtected": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "src/SupabaseClient.ts", + "line": 54, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 154, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "signatures": [ + { + "id": 155, + "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": 139, "name": "auth", "kind": 1024, "kindString": "Property", @@ -844,7 +956,7 @@ } }, { - "id": 131, + "id": 142, "name": "authUrl", "kind": 1024, "kindString": "Property", @@ -864,7 +976,7 @@ } }, { - "id": 141, + "id": 152, "name": "changedAccessToken", "kind": 1024, "kindString": "Property", @@ -885,7 +997,7 @@ } }, { - "id": 136, + "id": 147, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -903,21 +1015,21 @@ "type": { "type": "reflection", "declaration": { - "id": 137, + "id": 148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 138, + "id": 149, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 139, + "id": 150, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -941,7 +1053,7 @@ } }, { - "id": 140, + "id": 151, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -976,7 +1088,7 @@ } }, { - "id": 133, + "id": 144, "name": "functionsUrl", "kind": 1024, "kindString": "Property", @@ -996,7 +1108,7 @@ } }, { - "id": 142, + "id": 156, "name": "headers", "kind": 1024, "kindString": "Property", @@ -1006,7 +1118,7 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 55, + "line": 56, "character": 12 } ], @@ -1028,7 +1140,7 @@ } }, { - "id": 129, + "id": 140, "name": "realtime", "kind": 1024, "kindString": "Property", @@ -1048,7 +1160,7 @@ } }, { - "id": 130, + "id": 141, "name": "realtimeUrl", "kind": 1024, "kindString": "Property", @@ -1068,7 +1180,7 @@ } }, { - "id": 134, + "id": 145, "name": "rest", "kind": 1024, "kindString": "Property", @@ -1087,50 +1199,18 @@ "typeArguments": [ { "type": "reference", - "id": 122, + "id": 133, "name": "Database" }, { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 123, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 122, - "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" - } + "type": "reference", + "id": 135, + "name": "Schema" } ], "qualifiedName": "PostgrestClient", @@ -1139,7 +1219,7 @@ } }, { - "id": 135, + "id": 146, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -1159,7 +1239,7 @@ } }, { - "id": 132, + "id": 143, "name": "storageUrl", "kind": 1024, "kindString": "Property", @@ -1179,7 +1259,7 @@ } }, { - "id": 144, + "id": 158, "name": "supabaseKey", "kind": 1024, "kindString": "Property", @@ -1192,7 +1272,7 @@ } }, { - "id": 143, + "id": 157, "name": "supabaseUrl", "kind": 1024, "kindString": "Property", @@ -1205,7 +1285,7 @@ } }, { - "id": 145, + "id": 159, "name": "functions", "kind": 262144, "kindString": "Accessor", @@ -1213,13 +1293,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 118, + "line": 139, "character": 6 } ], "getSignature": [ { - "id": 146, + "id": 160, "name": "functions", "kind": 524288, "kindString": "Get signature", @@ -1237,7 +1317,7 @@ ] }, { - "id": 147, + "id": 161, "name": "storage", "kind": 262144, "kindString": "Accessor", @@ -1245,13 +1325,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 128, + "line": 149, "character": 6 } ], "getSignature": [ { - "id": 148, + "id": 162, "name": "storage", "kind": 524288, "kindString": "Get signature", @@ -1269,7 +1349,7 @@ ] }, { - "id": 186, + "id": 200, "name": "_getAccessToken", "kind": 2048, "kindString": "Method", @@ -1279,13 +1359,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 246, + "line": 269, "character": 16 } ], "signatures": [ { - "id": 187, + "id": 201, "name": "_getAccessToken", "kind": 4096, "kindString": "Call signature", @@ -1315,7 +1395,7 @@ ] }, { - "id": 203, + "id": 217, "name": "_handleTokenChanged", "kind": 2048, "kindString": "Method", @@ -1325,20 +1405,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 297, + "line": 329, "character": 10 } ], "signatures": [ { - "id": 204, + "id": 218, "name": "_handleTokenChanged", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 205, + "id": 219, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -1351,7 +1431,7 @@ } }, { - "id": 206, + "id": 220, "name": "source", "kind": 32768, "kindString": "Parameter", @@ -1371,7 +1451,7 @@ } }, { - "id": 207, + "id": 221, "name": "token", "kind": 32768, "kindString": "Parameter", @@ -1392,7 +1472,7 @@ ] }, { - "id": 197, + "id": 211, "name": "_initRealtimeClient", "kind": 2048, "kindString": "Method", @@ -1402,20 +1482,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 283, + "line": 315, "character": 10 } ], "signatures": [ { - "id": 198, + "id": 212, "name": "_initRealtimeClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 199, + "id": 213, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -1438,7 +1518,7 @@ ] }, { - "id": 188, + "id": 202, "name": "_initSupabaseAuthClient", "kind": 2048, "kindString": "Method", @@ -1448,20 +1528,20 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 252, + "line": 279, "character": 10 } ], "signatures": [ { - "id": 189, + "id": 203, "name": "_initSupabaseAuthClient", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 190, + "id": 204, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -1493,7 +1573,7 @@ } }, { - "id": 191, + "id": 205, "name": "headers", "kind": 32768, "kindString": "Parameter", @@ -1518,7 +1598,7 @@ } }, { - "id": 192, + "id": 206, "name": "fetch", "kind": 32768, "kindString": "Parameter", @@ -1528,21 +1608,21 @@ "type": { "type": "reflection", "declaration": { - "id": 193, + "id": 207, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 194, + "id": 208, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 209, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -1566,7 +1646,7 @@ } }, { - "id": 196, + "id": 210, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1609,7 +1689,7 @@ ] }, { - "id": 200, + "id": 214, "name": "_listenForAuthEvents", "kind": 2048, "kindString": "Method", @@ -1619,13 +1699,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 290, + "line": 322, "character": 10 } ], "signatures": [ { - "id": 201, + "id": 215, "name": "_listenForAuthEvents", "kind": 4096, "kindString": "Call signature", @@ -1633,7 +1713,7 @@ "type": { "type": "reflection", "declaration": { - "id": 202, + "id": 216, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1644,7 +1724,7 @@ ] }, { - "id": 175, + "id": 189, "name": "channel", "kind": 2048, "kindString": "Method", @@ -1652,13 +1732,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 218, + "line": 241, "character": 2 } ], "signatures": [ { - "id": 176, + "id": 190, "name": "channel", "kind": 4096, "kindString": "Call signature", @@ -1668,7 +1748,7 @@ }, "parameters": [ { - "id": 177, + "id": 191, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -1682,7 +1762,7 @@ } }, { - "id": 178, + "id": 192, "name": "opts", "kind": 32768, "kindString": "Parameter", @@ -1709,7 +1789,7 @@ ] }, { - "id": 149, + "id": 163, "name": "from", "kind": 2048, "kindString": "Method", @@ -1717,13 +1797,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 133, + "line": 154, "character": 2 } ], "signatures": [ { - "id": 150, + "id": 164, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1733,7 +1813,7 @@ }, "typeParameter": [ { - "id": 151, + "id": 165, "name": "TableName", "kind": 131072, "kindString": "Type parameter", @@ -1744,21 +1824,21 @@ } }, { - "id": 152, + "id": 166, "name": "Table", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 91, + "id": 100, "name": "GenericTable" } } ], "parameters": [ { - "id": 153, + "id": 167, "name": "relation", "kind": 32768, "kindString": "Parameter", @@ -1768,7 +1848,7 @@ }, "type": { "type": "reference", - "id": 151, + "id": 165, "name": "TableName", "dereferenced": {} } @@ -1779,30 +1859,30 @@ "typeArguments": [ { "type": "reference", - "id": 124, + "id": 135, "name": "Schema" }, { "type": "reference", - "id": 152, + "id": 166, "name": "Table" }, { "type": "reference", - "id": 151, + "id": 165, "name": "TableName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 152, + "id": 166, "name": "Table" }, "extendsType": { "type": "reflection", "declaration": { - "id": 154, + "id": 168, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1827,7 +1907,7 @@ } }, { - "id": 155, + "id": 169, "name": "from", "kind": 4096, "kindString": "Call signature", @@ -1837,7 +1917,7 @@ }, "typeParameter": [ { - "id": 156, + "id": 170, "name": "ViewName", "kind": 131072, "kindString": "Type parameter", @@ -1848,21 +1928,21 @@ } }, { - "id": 157, + "id": 171, "name": "View", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 100, + "id": 111, "name": "GenericView" } } ], "parameters": [ { - "id": 158, + "id": 172, "name": "relation", "kind": 32768, "kindString": "Parameter", @@ -1872,7 +1952,7 @@ }, "type": { "type": "reference", - "id": 156, + "id": 170, "name": "ViewName", "dereferenced": {} } @@ -1883,30 +1963,30 @@ "typeArguments": [ { "type": "reference", - "id": 124, + "id": 135, "name": "Schema" }, { "type": "reference", - "id": 157, + "id": 171, "name": "View" }, { "type": "reference", - "id": 156, + "id": 170, "name": "ViewName" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 157, + "id": 171, "name": "View" }, "extendsType": { "type": "reflection", "declaration": { - "id": 159, + "id": 173, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1933,7 +2013,7 @@ ] }, { - "id": 179, + "id": 193, "name": "getChannels", "kind": 2048, "kindString": "Method", @@ -1941,13 +2021,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 225, + "line": 248, "character": 2 } ], "signatures": [ { - "id": 180, + "id": 194, "name": "getChannels", "kind": 4096, "kindString": "Call signature", @@ -1968,7 +2048,7 @@ ] }, { - "id": 184, + "id": 198, "name": "removeAllChannels", "kind": 2048, "kindString": "Method", @@ -1976,13 +2056,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 242, + "line": 265, "character": 2 } ], "signatures": [ { - "id": 185, + "id": 199, "name": "removeAllChannels", "kind": 4096, "kindString": "Call signature", @@ -2022,7 +2102,7 @@ ] }, { - "id": 181, + "id": 195, "name": "removeChannel", "kind": 2048, "kindString": "Method", @@ -2030,13 +2110,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 235, + "line": 258, "character": 2 } ], "signatures": [ { - "id": 182, + "id": 196, "name": "removeChannel", "kind": 4096, "kindString": "Call signature", @@ -2046,7 +2126,7 @@ }, "parameters": [ { - "id": 183, + "id": 197, "name": "channel", "kind": 32768, "kindString": "Parameter", @@ -2091,7 +2171,7 @@ ] }, { - "id": 164, + "id": 178, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -2099,13 +2179,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 191, + "line": 212, "character": 2 } ], "signatures": [ { - "id": 165, + "id": 179, "name": "rpc", "kind": 4096, "kindString": "Call signature", @@ -2115,7 +2195,7 @@ }, "typeParameter": [ { - "id": 166, + "id": 180, "name": "FnName", "kind": 131072, "kindString": "Type parameter", @@ -2126,21 +2206,21 @@ } }, { - "id": 167, + "id": 181, "name": "Fn", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 101, + "id": 112, "name": "GenericFunction" } } ], "parameters": [ { - "id": 168, + "id": 182, "name": "fn", "kind": 32768, "kindString": "Parameter", @@ -2150,13 +2230,13 @@ }, "type": { "type": "reference", - "id": 166, + "id": 180, "name": "FnName", "dereferenced": {} } }, { - "id": 169, + "id": 183, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -2172,14 +2252,14 @@ }, "objectType": { "type": "reference", - "id": 167, + "id": 181, "name": "Fn" } }, "defaultValue": "{}" }, { - "id": 170, + "id": 184, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -2190,14 +2270,14 @@ "type": { "type": "reflection", "declaration": { - "id": 171, + "id": 185, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 174, + "id": 188, "name": "count", "kind": 1024, "kindString": "Property", @@ -2210,7 +2290,7 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 197, + "line": 218, "character": 6 } ], @@ -2233,7 +2313,7 @@ } }, { - "id": 173, + "id": 187, "name": "get", "kind": 1024, "kindString": "Property", @@ -2246,7 +2326,7 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 196, + "line": 217, "character": 6 } ], @@ -2256,7 +2336,7 @@ } }, { - "id": 172, + "id": 186, "name": "head", "kind": 1024, "kindString": "Property", @@ -2269,7 +2349,7 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 195, + "line": 216, "character": 6 } ], @@ -2283,7 +2363,7 @@ { "title": "Properties", "kind": 1024, - "children": [174, 173, 172] + "children": [188, 187, 186] } ] } @@ -2296,7 +2376,7 @@ "typeArguments": [ { "type": "reference", - "id": 124, + "id": 135, "name": "Schema" }, { @@ -2309,7 +2389,7 @@ }, "objectType": { "type": "reference", - "id": 167, + "id": 181, "name": "Fn" } }, @@ -2385,17 +2465,18 @@ }, "objectType": { "type": "reference", - "id": 167, + "id": 181, "name": "Fn" } }, { - "type": "intrinsic", - "name": "unknown" + "type": "reference", + "id": 180, + "name": "FnName" }, { - "type": "intrinsic", - "name": "unknown" + "type": "literal", + "value": null } ], "qualifiedName": "PostgrestFilterBuilder", @@ -2406,7 +2487,7 @@ ] }, { - "id": 160, + "id": 174, "name": "schema", "kind": 2048, "kindString": "Method", @@ -2414,13 +2495,13 @@ "sources": [ { "fileName": "src/SupabaseClient.ts", - "line": 157, + "line": 178, "character": 2 } ], "signatures": [ { - "id": 161, + "id": 175, "name": "schema", "kind": 4096, "kindString": "Call signature", @@ -2431,7 +2512,7 @@ }, "typeParameter": [ { - "id": 162, + "id": 176, "name": "DynamicSchema", "kind": 131072, "kindString": "Type parameter", @@ -2444,7 +2525,7 @@ ], "parameters": [ { - "id": 163, + "id": 177, "name": "schema", "kind": 32768, "kindString": "Parameter", @@ -2454,7 +2535,7 @@ }, "type": { "type": "reference", - "id": 162, + "id": 176, "name": "DynamicSchema", "dereferenced": {} } @@ -2465,12 +2546,12 @@ "typeArguments": [ { "type": "reference", - "id": 122, + "id": 133, "name": "Database" }, { "type": "reference", - "id": 162, + "id": 176, "name": "DynamicSchema" }, { @@ -2479,18 +2560,18 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 162, + "id": 176, "name": "DynamicSchema" }, "objectType": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, "extendsType": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "trueType": { @@ -2522,22 +2603,22 @@ { "title": "Constructors", "kind": 512, - "children": [120] + "children": [131] }, { "title": "Properties", "kind": 1024, - "children": [128, 131, 141, 136, 133, 142, 129, 130, 134, 135, 132, 144, 143] + "children": [153, 139, 142, 152, 147, 144, 156, 140, 141, 145, 146, 143, 158, 157] }, { "title": "Accessors", "kind": 262144, - "children": [145, 147] + "children": [159, 161] }, { "title": "Methods", "kind": 2048, - "children": [186, 203, 197, 188, 200, 175, 149, 179, 184, 181, 164, 160] + "children": [200, 217, 211, 202, 214, 189, 163, 193, 198, 195, 178, 174] } ], "sources": [ @@ -2549,7 +2630,7 @@ ], "typeParameter": [ { - "id": 208, + "id": 222, "name": "Database", "kind": 131072, "kindString": "Type parameter", @@ -2560,7 +2641,7 @@ } }, { - "id": 209, + "id": 223, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -2577,7 +2658,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } } @@ -2594,7 +2675,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, @@ -2614,7 +2695,7 @@ "operator": "keyof", "target": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } } @@ -2623,14 +2704,14 @@ } }, { - "id": 210, + "id": 224, "name": "Schema", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "default": { @@ -2639,30 +2720,30 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, "extendsType": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 123, + "id": 134, "name": "SchemaName" }, "objectType": { "type": "reference", - "id": 122, + "id": 133, "name": "Database" } }, @@ -2766,7 +2847,7 @@ "flags": {}, "type": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "default": { @@ -2786,7 +2867,7 @@ }, "extendsType": { "type": "reference", - "id": 105, + "id": 116, "name": "GenericSchema" }, "trueType": { @@ -2864,7 +2945,7 @@ ], "typeParameter": [ { - "id": 90, + "id": 92, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -3188,7 +3269,7 @@ ], "type": { "type": "reference", - "id": 90, + "id": 92, "name": "SchemaName", "dereferenced": {} } @@ -3360,6 +3441,56 @@ "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } + }, + { + "id": 90, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "signatures": [ + { + "id": 91, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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 client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", + "text": "When 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.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -3367,6 +3498,11 @@ "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] + }, + { + "title": "Methods", + "kind": 2048, + "children": [90] } ], "sources": [ @@ -3384,7 +3520,7 @@ ], "type": { "type": "reference", - "id": 119, + "id": 130, "typeArguments": [ { "type": "reference", @@ -3412,12 +3548,12 @@ { "title": "References", "kind": 16777216, - "children": [213, 214, 212, 211] + "children": [227, 228, 226, 225] }, { "title": "Classes", "kind": 128, - "children": [119] + "children": [130] }, { "title": "Functions", @@ -4294,7 +4430,7 @@ ], "typeParameter": [ { - "id": 90, + "id": 92, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -4618,7 +4754,7 @@ ], "type": { "type": "reference", - "id": 90, + "id": 92, "name": "SchemaName", "dereferenced": {} } @@ -4790,6 +4926,56 @@ "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } + }, + { + "id": 90, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "signatures": [ + { + "id": 91, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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 client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", + "text": "When 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.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -4797,6 +4983,11 @@ "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] + }, + { + "title": "Methods", + "kind": 2048, + "children": [90] } ], "sources": [ @@ -4842,7 +5033,7 @@ ], "typeParameter": [ { - "id": 90, + "id": 92, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -5166,7 +5357,7 @@ ], "type": { "type": "reference", - "id": 90, + "id": 92, "name": "SchemaName", "dereferenced": {} } @@ -5338,6 +5529,56 @@ "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } + }, + { + "id": 90, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "signatures": [ + { + "id": 91, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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 client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", + "text": "When 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.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -5345,6 +5586,11 @@ "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] + }, + { + "title": "Methods", + "kind": 2048, + "children": [90] } ], "sources": [ @@ -5362,15 +5608,23 @@ ], "type": { "type": "reference", - "id": 70, "typeArguments": [ { "type": "reference", - "id": 62, - "name": "SchemaName" + "id": 70, + "typeArguments": [ + { + "type": "reference", + "id": 62, + "name": "SchemaName" + } + ], + "name": "SupabaseClientOptions" } ], - "name": "SupabaseClientOptions" + "qualifiedName": "Required", + "package": "typescript", + "name": "Required" } } ] @@ -5537,7 +5791,7 @@ } }, { - "id": 101, + "id": 112, "name": "GenericFunction", "kind": 4194304, "kindString": "Type alias", @@ -5545,25 +5799,246 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 85, + "line": 107, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 102, + "id": 113, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 103, + "id": 114, "name": "Args", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 108, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 115, + "name": "Returns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 109, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [114, 115] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 107, + "character": 30 + } + ] + } + } + }, + { + "id": 107, + "name": "GenericNonUpdatableView", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 108, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 110, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 102, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 93, + "name": "GenericRelationship" + } + } + }, + { + "id": 109, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 101, + "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": [110, 109] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 100, + "character": 38 + } + ] + } + } + }, + { + "id": 93, + "name": "GenericRelationship", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 83, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 94, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 96, + "name": "columns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 85, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 95, + "name": "foreignKeyName", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 84, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 97, + "name": "isOneToOne", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", @@ -5571,6 +6046,288 @@ "character": 2 } ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 99, + "name": "referencedColumns", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 88, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 98, + "name": "referencedRelation", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 87, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [96, 95, 97, 99, 98] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 83, + "character": 34 + } + ] + } + } + }, + { + "id": 116, + "name": "GenericSchema", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 112, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 117, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 120, + "name": "Functions", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 112, + "name": "GenericFunction" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 118, + "name": "Tables", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 100, + "name": "GenericTable" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 119, + "name": "Views", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 114, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "id": 111, + "name": "GenericView" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [120, 118, 119] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 112, + "character": 28 + } + ] + } + } + }, + { + "id": 100, + "name": "GenericTable", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 91, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 101, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 103, + "name": "Insert", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 93, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + }, + { + "id": 105, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 95, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 93, + "name": "GenericRelationship" + } + } + }, + { + "id": 102, + "name": "Row", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 92, + "character": 2 + } + ], "type": { "type": "reference", "typeArguments": [ @@ -5590,327 +6347,6 @@ }, { "id": 104, - "name": "Returns", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 87, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [103, 104] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 85, - "character": 30 - } - ] - } - } - }, - { - "id": 97, - "name": "GenericNonUpdatableView", - "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": 99, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 80, - "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": [99] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 38 - } - ] - } - } - }, - { - "id": 105, - "name": "GenericSchema", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 90, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 106, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 109, - "name": "Functions", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 101, - "name": "GenericFunction" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 107, - "name": "Tables", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 91, - "name": "GenericTable" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 108, - "name": "Views", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 100, - "name": "GenericView" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [109, 107, 108] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 90, - "character": 28 - } - ] - } - } - }, - { - "id": 91, - "name": "GenericTable", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 92, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 94, - "name": "Insert", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 93, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 95, "name": "Update", "kind": 1024, "kindString": "Property", @@ -5918,7 +6354,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 74, + "line": 94, "character": 2 } ], @@ -5944,13 +6380,13 @@ { "title": "Properties", "kind": 1024, - "children": [94, 93, 95] + "children": [103, 105, 102, 104] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 71, + "line": 91, "character": 27 } ] @@ -5958,7 +6394,7 @@ } }, { - "id": 96, + "id": 106, "name": "GenericUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -5966,18 +6402,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 77, + "line": 98, "character": 12 } ], "type": { "type": "reference", - "id": 91, + "id": 100, "name": "GenericTable" } }, { - "id": 100, + "id": 111, "name": "GenericView", "kind": 4194304, "kindString": "Type alias", @@ -5985,7 +6421,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 83, + "line": 105, "character": 12 } ], @@ -5993,7 +6429,7 @@ "type": "union", "types": [ { - "id": 96, + "id": 106, "name": "GenericUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -6001,18 +6437,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 77, + "line": 98, "character": 12 } ], "type": { "type": "reference", - "id": 91, + "id": 100, "name": "GenericTable" } }, { - "id": 97, + "id": 107, "name": "GenericNonUpdatableView", "kind": 4194304, "kindString": "Type alias", @@ -6020,21 +6456,43 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 79, + "line": 100, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 98, + "id": 108, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 99, + "id": 110, + "name": "Relationships", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 102, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 93, + "name": "GenericRelationship" + } + } + }, + { + "id": 109, "name": "Row", "kind": 1024, "kindString": "Property", @@ -6042,7 +6500,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 80, + "line": 101, "character": 2 } ], @@ -6068,13 +6526,13 @@ { "title": "Properties", "kind": 1024, - "children": [99] + "children": [110, 109] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 79, + "line": 100, "character": 38 } ] @@ -6085,7 +6543,7 @@ } }, { - "id": 112, + "id": 123, "name": "QueryData", "kind": 4194304, "kindString": "Type alias", @@ -6093,13 +6551,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, + "line": 122, "character": 12 } ], "typeParameter": [ { - "id": 115, + "id": 126, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6110,7 +6568,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 115, + "id": 126, "name": "T" }, "extendsType": { @@ -6119,14 +6577,14 @@ { "type": "reflection", "declaration": { - "id": 113, + "id": 124, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 114, + "id": 125, "name": "data", "kind": 1024, "kindString": "Property", @@ -6134,7 +6592,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, + "line": 122, "character": 51 } ], @@ -6148,13 +6606,13 @@ { "title": "Properties", "kind": 1024, - "children": [114] + "children": [125] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, + "line": 122, "character": 49 } ] @@ -6188,7 +6646,7 @@ } }, { - "id": 116, + "id": 127, "name": "QueryError", "kind": 4194304, "kindString": "Type alias", @@ -6196,7 +6654,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 101, + "line": 123, "character": 12 } ], @@ -6208,7 +6666,7 @@ } }, { - "id": 110, + "id": 121, "name": "QueryResult", "kind": 4194304, "kindString": "Type alias", @@ -6219,13 +6677,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 99, + "line": 121, "character": 12 } ], "typeParameter": [ { - "id": 111, + "id": 122, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -6236,7 +6694,7 @@ "type": "conditional", "checkType": { "type": "reference", - "id": 111, + "id": 122, "name": "T" }, "extendsType": { @@ -6276,7 +6734,7 @@ ], "typeParameter": [ { - "id": 90, + "id": 92, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", @@ -6600,7 +7058,7 @@ ], "type": { "type": "reference", - "id": 90, + "id": 92, "name": "SchemaName", "dereferenced": {} } @@ -6772,6 +7230,56 @@ "package": "@supabase/realtime-js", "name": "RealtimeClientOptions" } + }, + { + "id": 90, + "name": "accessToken", + "kind": 2048, + "kindString": "Method", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 80, + "character": 2 + } + ], + "signatures": [ + { + "id": 91, + "name": "accessToken", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "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 client library. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the client libraries.", + "text": "When 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.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] } ], "groups": [ @@ -6779,6 +7287,11 @@ "title": "Properties", "kind": 1024, "children": [75, 72, 86, 85] + }, + { + "title": "Methods", + "kind": 2048, + "children": [90] } ], "sources": [ @@ -6801,7 +7314,7 @@ { "title": "Type Aliases", "kind": 4194304, - "children": [69, 101, 97, 105, 91, 96, 100, 112, 116, 110, 70] + "children": [69, 112, 107, 93, 116, 100, 106, 111, 123, 127, 121, 70] } ], "sources": [ @@ -6813,14 +7326,14 @@ ] }, { - "id": 117, + "id": 128, "name": "lib/version", "kind": 2, "kindString": "Module", "flags": {}, "children": [ { - "id": 118, + "id": 129, "name": "version", "kind": 32, "kindString": "Variable", @@ -6845,7 +7358,7 @@ { "title": "Variables", "kind": 32, - "children": [118] + "children": [129] } ], "sources": [ @@ -6861,7 +7374,7 @@ { "title": "Modules", "kind": 2, - "children": [1, 10, 24, 53, 67, 117] + "children": [1, 10, 24, 53, 67, 128] } ] } diff --git a/apps/docs/spec/storage_v0_openapi.json b/apps/docs/spec/storage_v0_openapi.json index ddcefea4a7c..294aa475c84 100644 --- a/apps/docs/spec/storage_v0_openapi.json +++ b/apps/docs/spec/storage_v0_openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Supabase Storage API", "description": "API documentation for Supabase Storage", - "version": "0.0.1" + "version": "0.0.0" }, "components": { "schemas": { @@ -37,12 +37,12 @@ "/upload/resumable/": { "post": { "summary": "Handle POST request for TUS Resumable uploads", - "tags": ["object"], + "tags": ["resumable"], "responses": { "200": { "description": "Default Response" } } }, "options": { "summary": "Handle OPTIONS request for TUS Resumable uploads", - "tags": ["object"], + "tags": ["resumable"], "description": "Handle OPTIONS request for TUS Resumable uploads", "responses": { "200": { "description": "Default Response" } } } @@ -50,22 +50,68 @@ "/upload/resumable/{wildcard}": { "post": { "summary": "Handle POST request for TUS Resumable uploads", - "tags": ["object"], + "tags": ["resumable"], "responses": { "200": { "description": "Default Response" } } }, "put": { "summary": "Handle PUT request for TUS Resumable uploads", - "tags": ["object"], + "tags": ["resumable"], "responses": { "200": { "description": "Default Response" } } }, "patch": { "summary": "Handle PATCH request for TUS Resumable uploads", - "tags": ["object"], + "tags": ["resumable"], + "responses": { "200": { "description": "Default Response" } } + }, + "delete": { + "summary": "Handle DELETE request for TUS Resumable uploads", + "tags": ["resumable"], "responses": { "200": { "description": "Default Response" } } }, "options": { "summary": "Handle OPTIONS request for TUS Resumable uploads", - "tags": ["object"], + "tags": ["resumable"], + "description": "Handle OPTIONS request for TUS Resumable uploads", + "responses": { "200": { "description": "Default Response" } } + } + }, + "/upload/resumable/sign/": { + "post": { + "summary": "Handle POST request for TUS Resumable uploads", + "tags": ["resumable"], + "responses": { "200": { "description": "Default Response" } } + }, + "options": { + "summary": "Handle OPTIONS request for TUS Resumable uploads", + "tags": ["resumable"], + "description": "Handle OPTIONS request for TUS Resumable uploads", + "responses": { "200": { "description": "Default Response" } } + } + }, + "/upload/resumable/sign/{wildcard}": { + "post": { + "summary": "Handle POST request for TUS Resumable uploads", + "tags": ["resumable"], + "responses": { "200": { "description": "Default Response" } } + }, + "put": { + "summary": "Handle PUT request for TUS Resumable uploads", + "tags": ["resumable"], + "responses": { "200": { "description": "Default Response" } } + }, + "patch": { + "summary": "Handle PATCH request for TUS Resumable uploads", + "tags": ["resumable"], + "responses": { "200": { "description": "Default Response" } } + }, + "delete": { + "summary": "Handle DELETE request for TUS Resumable uploads", + "tags": ["resumable"], + "responses": { "200": { "description": "Default Response" } } + }, + "options": { + "summary": "Handle OPTIONS request for TUS Resumable uploads", + "tags": ["resumable"], "description": "Handle OPTIONS request for TUS Resumable uploads", "responses": { "200": { "description": "Default Response" } } } @@ -486,8 +532,8 @@ }, "get": { "summary": "Get object", - "tags": ["deprecated"], - "description": "use GET /object/authenticated/{bucketName} instead", + "tags": ["object"], + "description": "Serve objects", "parameters": [ { "schema": { "type": "string" }, @@ -502,13 +548,6 @@ "in": "path", "name": "*", "required": true - }, - { - "schema": { "type": "string" }, - "example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs", - "in": "header", - "name": "authorization", - "required": true } ], "responses": { @@ -692,6 +731,12 @@ { "type": "null" } ] }, + "user_metadata": { + "anyOf": [ + { "type": "object", "additionalProperties": true }, + { "type": "null" } + ] + }, "buckets": { "type": "object", "properties": { @@ -834,7 +879,8 @@ "examples": [ "/object/sign/upload/avatars/folder/cat.png?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1cmwiOiJhdmF0YXJzL2ZvbGRlci9jYXQucG5nIiwiaWF0IjoxNjE3NzI2MjczLCJleHAiOjE2MTc3MjcyNzN9.s7Gt8ME80iREVxPhH01ZNv8oUn4XtaWsmiQ5csiUHn4" ] - } + }, + "token": { "type": "string" } }, "required": ["url"] } @@ -1128,6 +1174,7 @@ "properties": { "bucketId": { "type": "string", "examples": ["avatars"] }, "sourceKey": { "type": "string", "examples": ["folder/cat.png"] }, + "destinationBucket": { "type": "string", "examples": ["users"] }, "destinationKey": { "type": "string", "examples": ["folder/newcat.png"] } }, "required": ["bucketId", "sourceKey", "destinationKey"] @@ -1240,6 +1287,12 @@ { "type": "null" } ] }, + "user_metadata": { + "anyOf": [ + { "type": "object", "additionalProperties": true }, + { "type": "null" } + ] + }, "buckets": { "type": "object", "properties": { @@ -1343,8 +1396,8 @@ "/object/info/{bucketName}/{wildcard}": { "get": { "summary": "Retrieve object info", - "tags": ["deprecated"], - "description": "use HEAD /object/authenticated/{bucketName} instead", + "tags": ["object"], + "description": "Object Info", "parameters": [ { "schema": { "type": "string" }, @@ -1359,13 +1412,6 @@ "in": "path", "name": "*", "required": true - }, - { - "schema": { "type": "string" }, - "example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs", - "in": "header", - "name": "authorization", - "required": true } ], "responses": { @@ -1388,9 +1434,18 @@ "schema": { "type": "object", "properties": { - "sourceKey": { "type": "string", "examples": ["folder/source.png"] }, "bucketId": { "type": "string", "examples": ["avatars"] }, - "destinationKey": { "type": "string", "examples": ["folder/destination.png"] } + "sourceKey": { "type": "string", "examples": ["folder/source.png"] }, + "destinationBucket": { "type": "string", "examples": ["users"] }, + "destinationKey": { "type": "string", "examples": ["folder/destination.png"] }, + "metadata": { + "type": "object", + "properties": { + "cacheControl": { "type": "string" }, + "mimetype": { "type": "string" } + } + }, + "copyMetadata": { "type": "boolean", "examples": [true] } }, "required": ["sourceKey", "bucketId", "destinationKey"] } @@ -1416,7 +1471,59 @@ "description": "Successful response", "type": "object", "properties": { - "Key": { "type": "string", "examples": ["folder/destination.png"] } + "Id": { "type": "string" }, + "Key": { "type": "string", "examples": ["folder/destination.png"] }, + "name": { "type": "string" }, + "bucket_id": { "type": "string" }, + "owner": { "type": "string" }, + "owner_id": { "type": "string" }, + "version": { "type": "string" }, + "id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, + "updated_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, + "created_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, + "last_accessed_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, + "metadata": { + "anyOf": [ + { "type": "object", "additionalProperties": true }, + { "type": "null" } + ] + }, + "user_metadata": { + "anyOf": [ + { "type": "object", "additionalProperties": true }, + { "type": "null" } + ] + }, + "buckets": { + "type": "object", + "properties": { + "id": { "type": "string" }, + "name": { "type": "string" }, + "owner": { "type": "string" }, + "public": { "type": "boolean" }, + "file_size_limit": { "type": ["null", "integer"] }, + "allowed_mime_types": { + "type": ["null", "array"], + "items": { "type": "string" } + }, + "created_at": { "type": "string" }, + "updated_at": { "type": "string" } + }, + "required": ["id", "name"], + "additionalProperties": false, + "examples": [ + { + "id": "bucket2", + "name": "bucket2", + "public": false, + "file_size_limit": 1000000, + "allowed_mime_types": ["image/png", "image/jpeg"], + "owner": "4d56e902-f0a0-4662-8448-a4d9e643c142", + "created_at": "2021-02-17T04:43:32.770206+00:00", + "updated_at": "2021-02-17T04:43:32.770206+00:00" + } + ] + } }, "required": ["Key"] } @@ -1500,7 +1607,7 @@ "/render/image/authenticated/{bucketName}/{wildcard}": { "get": { "summary": "Render an authenticated image with the given transformations", - "tags": ["object"], + "tags": ["transformation"], "parameters": [ { "schema": { "type": "integer", "minimum": 0 }, @@ -1571,7 +1678,7 @@ "/render/image/sign/{bucketName}/{wildcard}": { "get": { "summary": "Render an authenticated image with the given transformations", - "tags": ["object"], + "tags": ["transformation"], "parameters": [ { "schema": { "type": "string" }, @@ -1617,7 +1724,7 @@ "/render/image/public/{bucketName}/{wildcard}": { "get": { "summary": "Render a public image with the given transformations", - "tags": ["object"], + "tags": ["transformation"], "parameters": [ { "schema": { "type": "integer", "minimum": 0 }, @@ -1684,11 +1791,40 @@ } } } + }, + "/s3/{Bucket}/{wildcard}": { + "put": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } }, + "post": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } }, + "delete": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } }, + "get": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } } + }, + "/s3/{Bucket}": { + "delete": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } }, + "put": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } }, + "post": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } }, + "get": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } } + }, + "/s3/{Bucket}/": { + "delete": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } }, + "put": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } }, + "post": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } }, + "get": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } } + }, + "/s3/": { + "get": { "tags": ["s3"], "responses": { "200": { "description": "Default Response" } } } + }, + "/health/": { + "get": { + "summary": "healthcheck", + "responses": { "200": { "description": "Default Response" } } + } } }, "tags": [ { "name": "object", "description": "Object end-points" }, { "name": "bucket", "description": "Bucket end-points" }, - { "name": "deprecated", "description": "Deprecated end-points" } + { "name": "s3", "description": "S3 end-points" }, + { "name": "transformation", "description": "Image transformation" }, + { "name": "resumable", "description": "Resumable Upload end-points" } ] } diff --git a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json index 3026c4a5ddd..62ea0ee1c78 100644 --- a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json +++ b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json @@ -605,20 +605,11 @@ "format": "uri", "description": "Template URL used to create the project from the CLI.", "example": "https://github.com/supabase/supabase/tree/master/examples/slack-clone/nextjs-slack-clone" - }, - "release_channel": { - "type": "string", - "enum": ["internal", "alpha", "beta", "ga", "withdrawn", "preview"], - "description": "Release channel. If not provided, GA will be used." - }, - "postgres_engine": { - "type": "string", - "enum": ["15", "17-oriole"], - "description": "Postgres engine version. If not provided, the latest version will be used." } }, "required": ["db_pass", "name", "organization_id", "region"], - "additionalProperties": false + "additionalProperties": false, + "hideDefinitions": ["release_channel", "postgres_engine"] } } } @@ -8285,18 +8276,8 @@ "application/json": { "schema": { "type": "object", - "properties": { - "release_channel": { - "type": "string", - "enum": ["internal", "alpha", "beta", "ga", "withdrawn", "preview"], - "description": "Release channel version. If not provided, GeneralAvailability will be used." - }, - "postgres_engine": { - "type": "string", - "enum": ["15", "17-oriole"], - "description": "Postgres engine version. If not provided, the latest version from the given release channel will be used." - } - } + "properties": {}, + "hideDefinitions": ["release_channel", "postgres_engine"] } } } @@ -8581,7 +8562,25 @@ "type": "array", "items": { "type": "object", - "properties": {}, + "properties": { + "name": { + "type": "string" + }, + "schemas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": ["name"], + "additionalProperties": true + } + } + }, + "required": ["name", "schemas"], "additionalProperties": true } } @@ -8908,6 +8907,160 @@ ] } }, + "/v1/projects/{ref}/functions/deploy": { + "post": { + "operationId": "v1-deploy-a-function", + "summary": "Deploy a function", + "description": "A new endpoint to deploy functions. It will create if function does not exist.", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "type": "string" + } + }, + { + "name": "slug", + "required": false, + "in": "query", + "schema": { + "pattern": "/^[A-Za-z0-9_-]+$/", + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "array", + "items": { + "type": "file", + "items": { + "type": "string", + "format": "binary" + } + } + }, + "metadata": { + "type": "object", + "properties": { + "entrypoint_path": { + "required": true, + "type": "string" + }, + "import_map_path": { + "required": false, + "type": "string" + }, + "static_patterns": { + "required": false, + "type": "array", + "items": { + "type": "string" + } + }, + "verify_jwt": { + "required": false, + "type": "boolean" + }, + "name": { + "required": false, + "type": "string" + } + } + } + }, + "required": ["file", "metadata"] + } + } + } + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "version": { + "type": "integer" + }, + "created_at": { + "type": "integer", + "format": "int64" + }, + "updated_at": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "name": { + "type": "string" + }, + "status": { + "enum": ["ACTIVE", "REMOVED", "THROTTLED"], + "type": "string" + }, + "verify_jwt": { + "type": "boolean" + }, + "import_map": { + "type": "boolean" + }, + "entrypoint_path": { + "type": "string" + }, + "import_map_path": { + "type": "string" + }, + "compute_multiplier": { + "type": "number" + } + }, + "required": [ + "version", + "created_at", + "updated_at", + "id", + "slug", + "name", + "status" + ] + } + } + } + }, + "403": { + "description": "" + }, + "500": { + "description": "Failed to deploy function" + } + }, + "tags": ["Edge Functions"], + "security": [ + { + "bearer": [] + } + ] + } + }, "/v1/projects/{ref}/functions/{function_slug}": { "get": { "operationId": "v1-get-a-function", @@ -10832,20 +10985,11 @@ "format": "uri", "description": "Template URL used to create the project from the CLI.", "example": "https://github.com/supabase/supabase/tree/master/examples/slack-clone/nextjs-slack-clone" - }, - "release_channel": { - "type": "string", - "enum": ["internal", "alpha", "beta", "ga", "withdrawn", "preview"], - "description": "Release channel. If not provided, GA will be used." - }, - "postgres_engine": { - "type": "string", - "enum": ["15", "17-oriole"], - "description": "Postgres engine version. If not provided, the latest version will be used." } }, "required": ["db_pass", "name", "organization_id", "region"], - "additionalProperties": false + "additionalProperties": false, + "hideDefinitions": ["release_channel", "postgres_engine"] }, "V1ProjectResponse": { "type": "object", @@ -14410,18 +14554,8 @@ }, "RestoreProjectBodyDto": { "type": "object", - "properties": { - "release_channel": { - "type": "string", - "enum": ["internal", "alpha", "beta", "ga", "withdrawn", "preview"], - "description": "Release channel version. If not provided, GeneralAvailability will be used." - }, - "postgres_engine": { - "type": "string", - "enum": ["15", "17-oriole"], - "description": "Postgres engine version. If not provided, the latest version from the given release channel will be used." - } - } + "properties": {}, + "hideDefinitions": ["release_channel", "postgres_engine"] }, "V1AnalyticsResponse": { "type": "object", @@ -14492,7 +14626,25 @@ "type": "array", "items": { "type": "object", - "properties": {}, + "properties": { + "name": { + "type": "string" + }, + "schemas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": ["name"], + "additionalProperties": true + } + } + }, + "required": ["name", "schemas"], "additionalProperties": true } } @@ -14568,6 +14720,50 @@ }, "required": ["slug", "name", "body"] }, + "FunctionDeployBody": { + "type": "object", + "properties": { + "file": { + "type": "array", + "items": { + "type": "file", + "items": { + "type": "string", + "format": "binary" + } + } + }, + "metadata": { + "type": "object", + "properties": { + "entrypoint_path": { + "required": true, + "type": "string" + }, + "import_map_path": { + "required": false, + "type": "string" + }, + "static_patterns": { + "required": false, + "type": "array", + "items": { + "type": "string" + } + }, + "verify_jwt": { + "required": false, + "type": "boolean" + }, + "name": { + "required": false, + "type": "string" + } + } + } + }, + "required": ["file", "metadata"] + }, "FunctionSlugResponse": { "type": "object", "properties": { diff --git a/apps/docs/spec/transforms/auth_v1_openapi_deparsed.json b/apps/docs/spec/transforms/auth_v1_openapi_deparsed.json index 97739b7a407..8cc701baac6 100644 --- a/apps/docs/spec/transforms/auth_v1_openapi_deparsed.json +++ b/apps/docs/spec/transforms/auth_v1_openapi_deparsed.json @@ -1,6 +1,4 @@ { - "produces": ["application/json"], - "schemes": ["http", "https"], "swagger": "2.0", "info": { "description": "Documentation of the gotrue API.", @@ -9,6 +7,8 @@ }, "host": "localhost:9999", "basePath": "/", + "schemes": ["http", "https"], + "produces": ["application/json"], "paths": { "/admin/generate_link": { "post": { diff --git a/apps/docs/spec/transforms/storage_v0_openapi_deparsed.json b/apps/docs/spec/transforms/storage_v0_openapi_deparsed.json index ac66694a702..015db0229d7 100644 --- a/apps/docs/spec/transforms/storage_v0_openapi_deparsed.json +++ b/apps/docs/spec/transforms/storage_v0_openapi_deparsed.json @@ -3,41 +3,30 @@ "info": { "title": "Supabase Storage API", "description": "API documentation for Supabase Storage", - "version": "0.0.1" + "version": "0.0.0" }, - "components": { - "schemas": { - "def-0": { - "type": "object", - "properties": { - "authorization": { - "type": "string", - "examples": [ - "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs" - ] - } - }, - "required": ["authorization"], - "title": "authSchema" - }, - "def-1": { - "type": "object", - "properties": { - "statusCode": { - "type": "string" - }, - "error": { - "type": "string" - }, - "message": { - "type": "string" - } - }, - "required": ["statusCode", "error", "message"], - "title": "errorSchema" - } + "tags": [ + { + "name": "object", + "description": "Object end-points" + }, + { + "name": "bucket", + "description": "Bucket end-points" + }, + { + "name": "s3", + "description": "S3 end-points" + }, + { + "name": "transformation", + "description": "Image transformation" + }, + { + "name": "resumable", + "description": "Resumable Upload end-points" } - }, + ], "paths": { "/metrics": { "get": { @@ -51,7 +40,7 @@ "/upload/resumable/": { "post": { "summary": "Handle POST request for TUS Resumable uploads", - "tags": ["object"], + "tags": ["resumable"], "responses": { "200": { "description": "Default Response" @@ -60,7 +49,7 @@ }, "options": { "summary": "Handle OPTIONS request for TUS Resumable uploads", - "tags": ["object"], + "tags": ["resumable"], "description": "Handle OPTIONS request for TUS Resumable uploads", "responses": { "200": { @@ -72,7 +61,7 @@ "/upload/resumable/{wildcard}": { "post": { "summary": "Handle POST request for TUS Resumable uploads", - "tags": ["object"], + "tags": ["resumable"], "responses": { "200": { "description": "Default Response" @@ -81,7 +70,7 @@ }, "put": { "summary": "Handle PUT request for TUS Resumable uploads", - "tags": ["object"], + "tags": ["resumable"], "responses": { "200": { "description": "Default Response" @@ -90,7 +79,16 @@ }, "patch": { "summary": "Handle PATCH request for TUS Resumable uploads", - "tags": ["object"], + "tags": ["resumable"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "delete": { + "summary": "Handle DELETE request for TUS Resumable uploads", + "tags": ["resumable"], "responses": { "200": { "description": "Default Response" @@ -99,7 +97,76 @@ }, "options": { "summary": "Handle OPTIONS request for TUS Resumable uploads", - "tags": ["object"], + "tags": ["resumable"], + "description": "Handle OPTIONS request for TUS Resumable uploads", + "responses": { + "200": { + "description": "Default Response" + } + } + } + }, + "/upload/resumable/sign/": { + "post": { + "summary": "Handle POST request for TUS Resumable uploads", + "tags": ["resumable"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "options": { + "summary": "Handle OPTIONS request for TUS Resumable uploads", + "tags": ["resumable"], + "description": "Handle OPTIONS request for TUS Resumable uploads", + "responses": { + "200": { + "description": "Default Response" + } + } + } + }, + "/upload/resumable/sign/{wildcard}": { + "post": { + "summary": "Handle POST request for TUS Resumable uploads", + "tags": ["resumable"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "put": { + "summary": "Handle PUT request for TUS Resumable uploads", + "tags": ["resumable"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "patch": { + "summary": "Handle PATCH request for TUS Resumable uploads", + "tags": ["resumable"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "delete": { + "summary": "Handle DELETE request for TUS Resumable uploads", + "tags": ["resumable"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "options": { + "summary": "Handle OPTIONS request for TUS Resumable uploads", + "tags": ["resumable"], "description": "Handle OPTIONS request for TUS Resumable uploads", "responses": { "200": { @@ -744,8 +811,8 @@ }, "get": { "summary": "Get object", - "tags": ["deprecated"], - "description": "use GET /object/authenticated/{bucketName} instead", + "tags": ["object"], + "description": "Serve objects", "parameters": [ { "schema": { @@ -764,15 +831,6 @@ "in": "path", "name": "*", "required": true - }, - { - "schema": { - "type": "string" - }, - "example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs", - "in": "header", - "name": "authorization", - "required": true } ], "responses": { @@ -1084,6 +1142,17 @@ } ] }, + "user_metadata": { + "anyOf": [ + { + "type": "object", + "additionalProperties": true + }, + { + "type": "null" + } + ] + }, "buckets": { "type": "object", "properties": { @@ -1288,6 +1357,9 @@ "examples": [ "/object/sign/upload/avatars/folder/cat.png?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1cmwiOiJhdmF0YXJzL2ZvbGRlci9jYXQucG5nIiwiaWF0IjoxNjE3NzI2MjczLCJleHAiOjE2MTc3MjcyNzN9.s7Gt8ME80iREVxPhH01ZNv8oUn4XtaWsmiQ5csiUHn4" ] + }, + "token": { + "type": "string" } }, "required": ["url"] @@ -1730,6 +1802,10 @@ "type": "string", "examples": ["folder/cat.png"] }, + "destinationBucket": { + "type": "string", + "examples": ["users"] + }, "destinationKey": { "type": "string", "examples": ["folder/newcat.png"] @@ -1942,6 +2018,17 @@ } ] }, + "user_metadata": { + "anyOf": [ + { + "type": "object", + "additionalProperties": true + }, + { + "type": "null" + } + ] + }, "buckets": { "type": "object", "properties": { @@ -2101,8 +2188,8 @@ "/object/info/{bucketName}/{wildcard}": { "get": { "summary": "Retrieve object info", - "tags": ["deprecated"], - "description": "use HEAD /object/authenticated/{bucketName} instead", + "tags": ["object"], + "description": "Object Info", "parameters": [ { "schema": { @@ -2121,15 +2208,6 @@ "in": "path", "name": "*", "required": true - }, - { - "schema": { - "type": "string" - }, - "example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs", - "in": "header", - "name": "authorization", - "required": true } ], "responses": { @@ -2169,17 +2247,36 @@ "schema": { "type": "object", "properties": { - "sourceKey": { - "type": "string", - "examples": ["folder/source.png"] - }, "bucketId": { "type": "string", "examples": ["avatars"] }, + "sourceKey": { + "type": "string", + "examples": ["folder/source.png"] + }, + "destinationBucket": { + "type": "string", + "examples": ["users"] + }, "destinationKey": { "type": "string", "examples": ["folder/destination.png"] + }, + "metadata": { + "type": "object", + "properties": { + "cacheControl": { + "type": "string" + }, + "mimetype": { + "type": "string" + } + } + }, + "copyMetadata": { + "type": "boolean", + "examples": [true] } }, "required": ["sourceKey", "bucketId", "destinationKey"] @@ -2208,9 +2305,135 @@ "description": "Successful response", "type": "object", "properties": { + "Id": { + "type": "string" + }, "Key": { "type": "string", "examples": ["folder/destination.png"] + }, + "name": { + "type": "string" + }, + "bucket_id": { + "type": "string" + }, + "owner": { + "type": "string" + }, + "owner_id": { + "type": "string" + }, + "version": { + "type": "string" + }, + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "updated_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "created_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "last_accessed_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "metadata": { + "anyOf": [ + { + "type": "object", + "additionalProperties": true + }, + { + "type": "null" + } + ] + }, + "user_metadata": { + "anyOf": [ + { + "type": "object", + "additionalProperties": true + }, + { + "type": "null" + } + ] + }, + "buckets": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "owner": { + "type": "string" + }, + "public": { + "type": "boolean" + }, + "file_size_limit": { + "type": ["null", "integer"] + }, + "allowed_mime_types": { + "type": ["null", "array"], + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": ["id", "name"], + "additionalProperties": false, + "examples": [ + { + "id": "bucket2", + "name": "bucket2", + "public": false, + "file_size_limit": 1000000, + "allowed_mime_types": ["image/png", "image/jpeg"], + "owner": "4d56e902-f0a0-4662-8448-a4d9e643c142", + "created_at": "2021-02-17T04:43:32.770206+00:00", + "updated_at": "2021-02-17T04:43:32.770206+00:00" + } + ] } }, "required": ["Key"] @@ -2352,7 +2575,7 @@ "/render/image/authenticated/{bucketName}/{wildcard}": { "get": { "summary": "Render an authenticated image with the given transformations", - "tags": ["object"], + "tags": ["transformation"], "parameters": [ { "schema": { @@ -2461,7 +2684,7 @@ "/render/image/sign/{bucketName}/{wildcard}": { "get": { "summary": "Render an authenticated image with the given transformations", - "tags": ["object"], + "tags": ["transformation"], "parameters": [ { "schema": { @@ -2531,7 +2754,7 @@ "/render/image/public/{bucketName}/{wildcard}": { "get": { "summary": "Render a public image with the given transformations", - "tags": ["object"], + "tags": ["transformation"], "parameters": [ { "schema": { @@ -2636,20 +2859,161 @@ } } } + }, + "/s3/{Bucket}/{wildcard}": { + "put": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "post": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "delete": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "get": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + } + }, + "/s3/{Bucket}": { + "delete": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "put": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "post": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "get": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + } + }, + "/s3/{Bucket}/": { + "delete": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "put": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "post": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + }, + "get": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + } + }, + "/s3/": { + "get": { + "tags": ["s3"], + "responses": { + "200": { + "description": "Default Response" + } + } + } + }, + "/health/": { + "get": { + "summary": "healthcheck", + "responses": { + "200": { + "description": "Default Response" + } + } + } } }, - "tags": [ - { - "name": "object", - "description": "Object end-points" - }, - { - "name": "bucket", - "description": "Bucket end-points" - }, - { - "name": "deprecated", - "description": "Deprecated end-points" + "components": { + "schemas": { + "def-0": { + "type": "object", + "properties": { + "authorization": { + "type": "string", + "examples": [ + "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs" + ] + } + }, + "required": ["authorization"], + "title": "authSchema" + }, + "def-1": { + "type": "object", + "properties": { + "statusCode": { + "type": "string" + }, + "error": { + "type": "string" + }, + "message": { + "type": "string" + } + }, + "required": ["statusCode", "error", "message"], + "title": "errorSchema" + } } - ] + } } diff --git a/packages/generator/package.json b/packages/generator/package.json index 63a67443163..89dc9df2010 100644 --- a/packages/generator/package.json +++ b/packages/generator/package.json @@ -27,6 +27,7 @@ "@types/lodash": "^4.14.202", "json-stringify-safe": "^5.0.1", "lodash": "^4.17.21", + "tsconfig": "workspace:*", "tsx": "^4.7.0" } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 356616c4708..752647903cb 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1449,6 +1449,9 @@ importers: lodash: specifier: ^4.17.21 version: 4.17.21 + tsconfig: + specifier: workspace:* + version: link:../tsconfig tsx: specifier: ^4.7.0 version: 4.7.0 From 8cbff35e8d29c4e7c968a18050727906f4f4f24e Mon Sep 17 00:00:00 2001 From: Jordi Enric <37541088+jordienr@users.noreply.github.com> Date: Tue, 4 Feb 2025 15:52:57 +0100 Subject: [PATCH 005/148] fix layout shift when toggling checkbox (#33319) --- packages/ui/src/components/shadcn/ui/checkbox.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/ui/src/components/shadcn/ui/checkbox.tsx b/packages/ui/src/components/shadcn/ui/checkbox.tsx index 6ac93373628..09d634e25ba 100644 --- a/packages/ui/src/components/shadcn/ui/checkbox.tsx +++ b/packages/ui/src/components/shadcn/ui/checkbox.tsx @@ -13,7 +13,7 @@ const Checkbox = React.forwardRef< Date: Tue, 4 Feb 2025 16:26:21 +0100 Subject: [PATCH 006/148] Update humans.txt (#33317) Add myself to humans.txt --- apps/docs/public/humans.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/apps/docs/public/humans.txt b/apps/docs/public/humans.txt index 69fb2aae602..aceecb2178c 100644 --- a/apps/docs/public/humans.txt +++ b/apps/docs/public/humans.txt @@ -45,6 +45,7 @@ John Pena Jon M Jonny Summers-Muir Jordi Enric +José Luis Ledesma Joshen Lim Julien Goux Kamil Ogórek From 2d55512553b18f83c5e5354fd0f978495394d6f0 Mon Sep 17 00:00:00 2001 From: Charis <26616127+charislam@users.noreply.github.com> Date: Tue, 4 Feb 2025 13:18:31 -0500 Subject: [PATCH 007/148] chore: activate spelling and admonitions lints for docs (#33292) --- .github/workflows/docs-lint-v2.yml | 6 +- apps/docs/components/HomePageCover.tsx | 2 +- .../NavigationMenu.constants.ts | 2 +- .../guides/ai/choosing-compute-addon.mdx | 4 +- .../ai/examples/building-chatgpt-plugins.mdx | 4 +- .../ai/examples/headless-vector-search.mdx | 2 +- .../ai/examples/image-search-openai-clip.mdx | 8 +- .../ai/examples/nextjs-vector-search.mdx | 2 +- .../content/guides/ai/examples/openai.mdx | 2 +- .../semantic-image-search-amazon-titan.mdx | 4 +- apps/docs/content/guides/ai/going-to-prod.mdx | 6 +- .../guides/ai/integrations/llamaindex.mdx | 4 +- apps/docs/content/guides/ai/langchain.mdx | 2 +- .../quickstarts/generate-text-embeddings.mdx | 2 +- .../guides/ai/rag-with-permissions.mdx | 8 +- .../docs/content/guides/ai/vector-columns.mdx | 4 +- .../content/guides/api/creating-routes.mdx | 12 +- .../guides/api/rest/generating-types.mdx | 2 +- apps/docs/content/guides/api/sql-to-api.mdx | 2 +- apps/docs/content/guides/api/sql-to-rest.mdx | 2 +- .../content/guides/auth/auth-anonymous.mdx | 10 +- .../docs/content/guides/auth/auth-captcha.mdx | 22 +-- .../guides/auth/auth-helpers/auth-ui.mdx | 4 +- .../auth/auth-helpers/flutter-auth-ui.mdx | 12 +- .../guides/auth/auth-helpers/nextjs-pages.mdx | 18 +- .../guides/auth/auth-helpers/nextjs.mdx | 2 +- .../guides/auth/auth-helpers/sveltekit.mdx | 20 +-- apps/docs/content/guides/auth/auth-hooks.mdx | 10 +- .../auth/auth-hooks/send-email-hook.mdx | 2 +- .../guides/auth/auth-hooks/send-sms-hook.mdx | 2 +- apps/docs/content/guides/auth/auth-mfa.mdx | 2 +- apps/docs/content/guides/auth/auth-smtp.mdx | 2 +- .../auth/enterprise-sso/auth-sso-saml.mdx | 20 +-- apps/docs/content/guides/auth/jwts.mdx | 2 +- .../auth/native-mobile-deep-linking.mdx | 15 +- apps/docs/content/guides/auth/passwords.mdx | 4 +- apps/docs/content/guides/auth/phone-login.mdx | 2 +- .../auth/server-side/creating-a-client.mdx | 2 +- .../guides/auth/social-login/auth-apple.mdx | 12 +- .../guides/auth/social-login/auth-azure.mdx | 4 +- .../auth/social-login/auth-bitbucket.mdx | 6 +- .../guides/auth/social-login/auth-discord.mdx | 4 +- .../auth/social-login/auth-facebook.mdx | 6 +- .../guides/auth/social-login/auth-figma.mdx | 4 +- .../guides/auth/social-login/auth-github.mdx | 6 +- .../guides/auth/social-login/auth-gitlab.mdx | 4 +- .../guides/auth/social-login/auth-google.mdx | 14 +- .../guides/auth/social-login/auth-kakao.mdx | 6 +- .../auth/social-login/auth-keycloak.mdx | 16 +- .../auth/social-login/auth-linkedin.mdx | 4 +- .../guides/auth/social-login/auth-notion.mdx | 6 +- .../guides/auth/social-login/auth-slack.mdx | 4 +- .../guides/auth/social-login/auth-spotify.mdx | 4 +- .../guides/auth/social-login/auth-twitch.mdx | 6 +- .../guides/auth/social-login/auth-twitter.mdx | 4 +- .../guides/auth/social-login/auth-workos.mdx | 2 +- .../guides/auth/social-login/auth-zoom.mdx | 4 +- .../guides/auth/third-party/overview.mdx | 2 +- apps/docs/content/guides/auth/users.mdx | 2 +- apps/docs/content/guides/cron/install.mdx | 2 +- apps/docs/content/guides/cron/quickstart.mdx | 4 +- apps/docs/content/guides/database/arrays.mdx | 6 + .../database/connecting-to-postgres.mdx | 2 +- .../guides/database/connection-management.mdx | 38 ++-- .../database/custom-postgres-config.mdx | 2 +- .../guides/database/extensions/http.mdx | 2 +- .../guides/database/extensions/pg_hashids.mdx | 4 +- .../guides/database/extensions/pg_net.mdx | 2 +- .../database/extensions/pg_stat_monitor.mdx | 30 ++-- .../extensions/pg_stat_statements.mdx | 20 +-- .../guides/database/extensions/pgaudit.mdx | 28 +-- .../guides/database/extensions/postgis.mdx | 10 +- .../guides/database/extensions/rum.mdx | 12 +- .../database/extensions/timescaledb.mdx | 4 +- .../guides/database/extensions/uuid-ossp.mdx | 2 +- .../guides/database/full-text-search.mdx | 32 ++-- .../content/guides/database/functions.mdx | 14 +- apps/docs/content/guides/database/inspect.mdx | 4 +- apps/docs/content/guides/database/json.mdx | 4 + .../docs/content/guides/database/orioledb.mdx | 4 +- apps/docs/content/guides/database/pgadmin.mdx | 2 +- ...ims-and-role-based-access-control-rbac.mdx | 2 +- .../guides/database/postgres/indexes.mdx | 2 +- .../guides/database/postgres/roles.mdx | 6 +- .../database/postgres/row-level-security.mdx | 2 +- .../postgres/setup-replication-external.mdx | 4 +- .../guides/database/postgres/timeouts.mdx | 23 ++- apps/docs/content/guides/database/prisma.mdx | 16 +- .../content/guides/database/supavisor.mdx | 20 +-- apps/docs/content/guides/database/tables.mdx | 100 ++++++----- apps/docs/content/guides/database/testing.mdx | 2 +- .../content/guides/deployment/branching.mdx | 4 +- .../guides/deployment/database-migrations.mdx | 2 +- .../guides/deployment/going-into-prod.mdx | 6 +- .../deployment/managing-environments.mdx | 6 +- .../shared-responsibility-model.mdx | 2 +- .../content/guides/functions/ai-models.mdx | 6 +- .../content/guides/functions/compression.mdx | 2 +- .../content/guides/functions/dependencies.mdx | 4 +- .../guides/functions/ephemeral-storage.mdx | 6 +- ...uth-send-email-hook-react-email-resend.mdx | 6 +- .../functions/examples/image-manipulation.mdx | 6 +- .../functions/examples/push-notifications.mdx | 4 +- .../guides/functions/examples/screenshots.mdx | 2 +- .../functions/examples/semantic-search.mdx | 2 +- .../guides/functions/examples/send-emails.mdx | 2 +- apps/docs/content/guides/functions/limits.mdx | 2 +- .../guides/functions/local-development.mdx | 2 +- .../content/guides/functions/quickstart.mdx | 6 +- .../docs/content/guides/functions/routing.mdx | 10 +- .../content/guides/functions/status-codes.mdx | 2 +- .../content/guides/functions/unit-test.mdx | 2 +- apps/docs/content/guides/functions/wasm.mdx | 6 +- .../content/guides/functions/websockets.mdx | 14 +- apps/docs/content/guides/getting-started.mdx | 4 +- .../guides/getting-started/architecture.mdx | 6 +- .../guides/getting-started/features.mdx | 10 +- .../getting-started/quickstarts/flutter.mdx | 4 +- .../getting-started/quickstarts/hono.mdx | 2 +- .../quickstarts/ios-swiftui.mdx | 4 +- .../getting-started/quickstarts/laravel.mdx | 2 +- .../getting-started/quickstarts/nuxtjs.mdx | 14 +- .../getting-started/quickstarts/redwoodjs.mdx | 2 +- .../getting-started/quickstarts/refine.mdx | 2 +- .../tutorials/with-angular.mdx | 14 +- .../tutorials/with-flutter.mdx | 2 +- .../tutorials/with-ionic-angular.mdx | 16 +- .../tutorials/with-ionic-react.mdx | 4 +- .../tutorials/with-ionic-vue.mdx | 4 +- .../getting-started/tutorials/with-kotlin.mdx | 4 +- .../getting-started/tutorials/with-nuxt-3.mdx | 6 +- .../tutorials/with-redwoodjs.mdx | 2 +- .../tutorials/with-solidjs.mdx | 2 +- .../getting-started/tutorials/with-svelte.mdx | 6 +- .../tutorials/with-sveltekit.mdx | 6 +- .../getting-started/tutorials/with-swift.mdx | 4 +- .../local-development/cli/getting-started.mdx | 2 +- .../customizing-email-templates.mdx | 12 +- .../guides/local-development/overview.mdx | 4 +- .../guides/platform/access-control.mdx | 2 +- .../content/guides/platform/billing-faq.mdx | 8 +- .../guides/platform/compute-and-disk.mdx | 2 +- .../guides/platform/custom-domains.mdx | 4 +- .../content/guides/platform/fly-postgres.mdx | 2 +- .../content/guides/platform/ipv4-address.mdx | 2 +- .../platform/migrating-to-supabase/auth0.mdx | 8 +- .../migrating-to-supabase/firebase-auth.mdx | 6 +- .../firebase-storage.mdx | 4 +- .../migrating-to-supabase/firestore-data.mdx | 6 +- .../platform/migrating-to-supabase/mysql.mdx | 2 +- .../backup-restore.mdx | 4 +- .../dashboard-restore.mdx | 6 +- .../guides/platform/org-based-billing.mdx | 2 +- .../guides/platform/project-transfer.mdx | 4 +- apps/docs/content/guides/platform/sso.mdx | 4 +- .../content/guides/platform/sso/azure.mdx | 6 +- .../content/guides/platform/sso/gsuite.mdx | 8 +- .../docs/content/guides/platform/sso/okta.mdx | 8 +- apps/docs/content/guides/queues/api.mdx | 28 +-- apps/docs/content/guides/queues/pgmq.mdx | 170 +++++++++--------- .../docs/content/guides/queues/quickstart.mdx | 6 +- .../content/guides/realtime/benchmarks.mdx | 4 +- .../docs/content/guides/realtime/concepts.mdx | 2 +- .../content/guides/realtime/error_codes.mdx | 66 +++---- .../guides/realtime/postgres-changes.mdx | 12 +- apps/docs/content/guides/realtime/quotas.mdx | 2 +- .../content/guides/resources/glossary.mdx | 6 +- .../content/guides/self-hosting/docker.mdx | 12 +- .../guides/storage/buckets/fundamentals.mdx | 2 +- .../content/guides/storage/cdn/smart-cdn.mdx | 2 +- .../guides/storage/debugging/error-codes.mdx | 80 ++++----- .../guides/storage/s3/compatibility.mdx | 8 + .../guides/storage/serving/downloads.mdx | 8 +- .../storage/serving/image-transformations.mdx | 8 +- .../storage/uploads/resumable-uploads.mdx | 10 +- .../telemetry/advanced-log-filtering.mdx | 2 +- .../content/guides/telemetry/log-drains.mdx | 14 +- .../docs/content/guides/telemetry/metrics.mdx | 5 +- .../guides/telemetry/sentry-monitoring.mdx | 4 +- ...monitor-supavisor-postgres-connections.mdx | 24 +-- apps/docs/features/command/Quickstarts.tsx | 2 +- apps/docs/package.json | 2 +- apps/docs/spec/supabase_kt_v1.yml | 8 +- pnpm-lock.yaml | 66 +++---- supa-mdx-lint.config.toml | 8 +- supa-mdx-lint/Rule001HeadingCase.toml | 2 +- supa-mdx-lint/Rule003Spelling.toml | 116 +++++++++++- vale/styles/Custom/Spelling.yml | 10 -- 188 files changed, 951 insertions(+), 824 deletions(-) delete mode 100644 vale/styles/Custom/Spelling.yml diff --git a/.github/workflows/docs-lint-v2.yml b/.github/workflows/docs-lint-v2.yml index 5ec6e0d3127..fc1112313fc 100644 --- a/.github/workflows/docs-lint-v2.yml +++ b/.github/workflows/docs-lint-v2.yml @@ -38,10 +38,10 @@ jobs: ~/.cargo/registry/index/ ~/.cargo/registry/cache/ ~/.cargo/git/db/ - key: 6435a4cd1eeea7c2bbd343731de7e8a5127cb2d1 + key: 0be447eba738c3fd56698eff8ad01fa56c2391d7 - name: install linter if: steps.cache-cargo.outputs.cache-hit != 'true' - run: cargo install --locked --git https://github.com/supabase-community/supa-mdx-lint --rev 6435a4cd1eeea7c2bbd343731de7e8a5127cb2d1 + run: cargo install --locked --git https://github.com/supabase-community/supa-mdx-lint --rev 0be447eba738c3fd56698eff8ad01fa56c2391d7 - name: install reviewdog uses: reviewdog/action-setup@3f401fe1d58fe77e10d665ab713057375e39b887 # v1.3.0 with: @@ -54,7 +54,7 @@ jobs: run: | set -o pipefail git diff --name-only origin/$BASE_REF HEAD \ - | { grep -E "^apps/docs/content/guides/" || test $? = 1; } \ + | { grep -E "^apps/docs/content/" || test $? = 1; } \ | xargs -r supa-mdx-lint --format rdf \ | reviewdog -f=rdjsonl -reporter=github-pr-review - name: run linter on push or workflow dispatch diff --git a/apps/docs/components/HomePageCover.tsx b/apps/docs/components/HomePageCover.tsx index dd67ee4e641..25bd3b32a48 100644 --- a/apps/docs/components/HomePageCover.tsx +++ b/apps/docs/components/HomePageCover.tsx @@ -74,7 +74,7 @@ const HomePageCover = (props) => { href: '/guides/getting-started/quickstarts/vue', }, { - tooltip: 'NuxtJS', + tooltip: 'Nuxt', icon: '/docs/img/icons/nuxt-icon', href: '/guides/getting-started/quickstarts/nuxtjs', }, diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts index aed0de1cdac..c3fccd5395e 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts @@ -258,7 +258,7 @@ export const gettingstarted: NavMenuConstant = { items: [ { name: 'Next.js', url: '/guides/getting-started/quickstarts/nextjs' }, { name: 'React', url: '/guides/getting-started/quickstarts/reactjs' }, - { name: 'NuxtJS', url: '/guides/getting-started/quickstarts/nuxtjs' }, + { name: 'Nuxt', url: '/guides/getting-started/quickstarts/nuxtjs' }, { name: 'Vue', url: '/guides/getting-started/quickstarts/vue' }, { name: 'Hono', url: '/guides/getting-started/quickstarts/hono' }, { name: 'Flutter', url: '/guides/getting-started/quickstarts/flutter' }, diff --git a/apps/docs/content/guides/ai/choosing-compute-addon.mdx b/apps/docs/content/guides/ai/choosing-compute-addon.mdx index fe8c562b023..7c36ccfdd72 100644 --- a/apps/docs/content/guides/ai/choosing-compute-addon.mdx +++ b/apps/docs/content/guides/ai/choosing-compute-addon.mdx @@ -277,7 +277,7 @@ There are various ways to improve your pgvector performance. Here are some tips: It's useful to execute a few thousand “warm-up” queries before going into production. This helps help with RAM utilization. This can also help to determine that you've selected the right compute size for your workload. -### Finetune index parameters +### Fine-tune index parameters You can increase the Requests per Second by increasing `m` and `ef_construction` or `lists`. This also has an important caveat: building the index takes longer with higher values for these parameters. @@ -301,7 +301,7 @@ You can increase the Requests per Second by increasing `m` and `ef_construction` - + multi database - Include the script in your `package.json` script commands to enable Vercel to automaticall run it at build time. + Include the script in your `package.json` script commands to enable Vercel to automatically run it at build time. diff --git a/apps/docs/content/guides/ai/examples/openai.mdx b/apps/docs/content/guides/ai/examples/openai.mdx index b437530179c..eeda26ee421 100644 --- a/apps/docs/content/guides/ai/examples/openai.mdx +++ b/apps/docs/content/guides/ai/examples/openai.mdx @@ -91,7 +91,7 @@ You should see a GPT response come back from OpenAI! ## Deploy -Deploy your function to the cloud by runnning: +Deploy your function to the cloud by running: ```bash supabase functions deploy --no-verify-jwt openai diff --git a/apps/docs/content/guides/ai/examples/semantic-image-search-amazon-titan.mdx b/apps/docs/content/guides/ai/examples/semantic-image-search-amazon-titan.mdx index 373720b7797..4f831e609da 100644 --- a/apps/docs/content/guides/ai/examples/semantic-image-search-amazon-titan.mdx +++ b/apps/docs/content/guides/ai/examples/semantic-image-search-amazon-titan.mdx @@ -84,7 +84,7 @@ bedrock_client = boto3.client( ## Create embeddings for your images -In the root of your project, create a new folder called `images` and add some images. You can use the images from the example project on [GitHub](https://github.com/supabase/supabase/tree/master/examples/ai/aws_bedrock_image_search/images) or you can find license free images on [unsplash](https://unsplash.com). +In the root of your project, create a new folder called `images` and add some images. You can use the images from the example project on [GitHub](https://github.com/supabase/supabase/tree/master/examples/ai/aws_bedrock_image_search/images) or you can find license free images on [Unsplash](https://unsplash.com). To send images to the Amazon Bedrock API we need to need to encode them as `base64` strings. Create the following helper methods: @@ -188,7 +188,7 @@ seed = "image_search.main:seed" search = "image_search.main:search" ``` -After activating the virtual environtment with `poetry shell` you can now run your seed script via `poetry run seed`. You can inspect the generated embeddings in your Supabase Dashboard by visiting the [Table Editor](https://supabase.com/dashboard/project/_/editor), selecting the `vecs` schema, and the `image_vectors` table. +After activating the virtual environment with `poetry shell` you can now run your seed script via `poetry run seed`. You can inspect the generated embeddings in your Supabase Dashboard by visiting the [Table Editor](https://supabase.com/dashboard/project/_/editor), selecting the `vecs` schema, and the `image_vectors` table. ## Perform an image search from a text query diff --git a/apps/docs/content/guides/ai/going-to-prod.mdx b/apps/docs/content/guides/ai/going-to-prod.mdx index a82522b043b..5d43a161a6f 100644 --- a/apps/docs/content/guides/ai/going-to-prod.mdx +++ b/apps/docs/content/guides/ai/going-to-prod.mdx @@ -29,7 +29,7 @@ On the other hand, if you need to scale your application, you will need to [crea `pgvector` supports two types of indexes: HNSW and IVFFlat. We recommend using [HNSW](/docs/guides/ai/vector-indexes/hnsw-indexes) because of its [performance](https://supabase.com/blog/increase-performance-pgvector-hnsw#hnsw-performance-1536-dimensions) and [robustness against changing data](/docs/guides/ai/vector-indexes/hnsw-indexes#when-should-you-create-hnsw-indexes). dbpedia embeddings comparing ivfflat and hnsw queries-per-second using the 4XL compute addon @@ -66,5 +66,5 @@ You can view the inserted items in the [Table Editor](https://supabase.com/dashb ## Resources -- Visit the LlamaIndex + SupabaseVectorStore [docs](https://gpt-index.readthedocs.io/en/latest/examples/vector_stores/SupabaseVectorIndexDemo.html) +- Visit the LlamaIndex + `SupabaseVectorStore` [docs](https://gpt-index.readthedocs.io/en/latest/examples/vector_stores/SupabaseVectorIndexDemo.html) - Visit the official LlamaIndex [repo](https://github.com/jerryjliu/llama_index/) diff --git a/apps/docs/content/guides/ai/langchain.mdx b/apps/docs/content/guides/ai/langchain.mdx index df6a2b80dde..f0874ca37a7 100644 --- a/apps/docs/content/guides/ai/langchain.mdx +++ b/apps/docs/content/guides/ai/langchain.mdx @@ -147,7 +147,7 @@ export const run = async () => { ### Advanced metadata filtering -You can also use query builder-style filtering ([similar to how the Supabase JavaScript library works](https://supabase.com/docs/reference/javascript/using-filters)) instead of passing an object. Note that since the filter properties will be in the metadata column, you need to use arrow operators (`->` for integer or `->>` for text) as defined in [Postgrest API documentation](https://postgrest.org/en/stable/references/api/tables_views.html?highlight=operators#json-columns) and specify the data type of the property (e.g. the column should look something like `metadata->some_int_value::int`). +You can also use query builder-style filtering ([similar to how the Supabase JavaScript library works](https://supabase.com/docs/reference/javascript/using-filters)) instead of passing an object. Note that since the filter properties will be in the metadata column, you need to use arrow operators (`->` for integer or `->>` for text) as defined in [PostgREST API documentation](https://postgrest.org/en/stable/references/api/tables_views.html?highlight=operators#json-columns) and specify the data type of the property (e.g. the column should look something like `metadata->some_int_value::int`). ```js import { SupabaseFilterRPCCall, SupabaseVectorStore } from 'langchain/vectorstores/supabase' diff --git a/apps/docs/content/guides/ai/quickstarts/generate-text-embeddings.mdx b/apps/docs/content/guides/ai/quickstarts/generate-text-embeddings.mdx index 816b5ccaf2e..197d928c2e2 100644 --- a/apps/docs/content/guides/ai/quickstarts/generate-text-embeddings.mdx +++ b/apps/docs/content/guides/ai/quickstarts/generate-text-embeddings.mdx @@ -109,7 +109,7 @@ Let's build an Edge Function that will accept an input string and generate an em Note the two options we pass to `session.run()`: - - `mean_pool`: The first option sets `pooling` to `mean`. Pooling referes to how token-level embedding representations are compressed into a single sentence embedding that reflects the meaning of the entire sentence. Average pooling is the most common type of pooling for sentence embeddings. + - `mean_pool`: The first option sets `pooling` to `mean`. Pooling refers to how token-level embedding representations are compressed into a single sentence embedding that reflects the meaning of the entire sentence. Average pooling is the most common type of pooling for sentence embeddings. - `normalize`: The second option tells to normalize the embedding vector so that it can be used with distance measures like dot product. A normalized vector means its length (magnitude) is 1 - also referred to as a unit vector. A vector is normalized by dividing each element by the vector's length (magnitude), which maintains its direction but changes its length to 1. diff --git a/apps/docs/content/guides/ai/rag-with-permissions.mdx b/apps/docs/content/guides/ai/rag-with-permissions.mdx index 3a3256527e0..996659da5fd 100644 --- a/apps/docs/content/guides/ai/rag-with-permissions.mdx +++ b/apps/docs/content/guides/ai/rag-with-permissions.mdx @@ -50,7 +50,7 @@ on document_sections for select to authenticated using ( ); ``` - + In this example, the current user is determined using the built-in `auth.uid()` function when the query is executed through your project's auto-generated [REST API](/docs/guides/api). If you are connecting to your Supabase database through a direct Postgres connection, see [Direct Postgres Connection](#direct-postgres-connection) below for directions on how to achieve the same access control. @@ -117,7 +117,7 @@ RLS is latency-sensitive, so extra caution should be taken before implementing t - + For data sources other than Postgres, see [Foreign Data Wrappers](/docs/guides/database/extensions/wrappers/overview) for a list of external sources supported today. If your data lives in a source not provided in the list, please contact [support](https://supabase.com/dashboard/support/new) and we'll be happy to discuss your use case. @@ -161,7 +161,7 @@ import foreign schema public limit to (users, documents) from server foreign_server into external; ``` - + This example maps the `authenticated` role in Supabase to the `postgres` user in the external DB. In production, it's best to create a custom user on the external DB that has the minimum permissions necessary to access the information you need. @@ -224,7 +224,7 @@ where document_sections.embedding <#> embedding < -match_threshold order by document_sections.embedding <#> embedding; ``` - + You might be tempted to discard RLS completely and simply filter by user within the `where` clause. Though this will work, we recommend RLS as a general best practice since RLS is always applied even as new queries and application logic is introduced in the future. diff --git a/apps/docs/content/guides/ai/vector-columns.mdx b/apps/docs/content/guides/ai/vector-columns.mdx index 9c8c2c811b9..eee63e05822 100644 --- a/apps/docs/content/guides/ai/vector-columns.mdx +++ b/apps/docs/content/guides/ai/vector-columns.mdx @@ -61,7 +61,7 @@ create table documents ( In the above SQL snippet, we create a `documents` table with a column called `embedding` (note this is just a regular Postgres column - you can name it whatever you like). We give the `embedding` column a `vector` data type with 384 dimensions. Change this to the number of dimensions produced by your embedding model. For example, if you are [generating embeddings](/docs/guides/ai/quickstarts/generate-text-embeddings) using the open source [`gte-small`](https://huggingface.co/Supabase/gte-small) model, you would set this number to 384 since that model produces 384 dimensions. - + In general, embeddings with fewer dimensions perform best. See our [analysis on fewer dimensions in pgvector](https://supabase.com/blog/fewer-dimensions-are-better-pgvector). @@ -155,7 +155,7 @@ const { data: documents } = await supabaseClient.rpc('match_documents', { In this example `embedding` would be another embedding you wish to compare against your table of pre-generated embedding documents. For example if you were building a search engine, every time the user submits their query you would first generate an embedding on the search query itself, then pass it into the above `rpc()` function to match. - + Be sure to use embeddings produced from the same embedding model when calculating distance. Comparing embeddings from two different models will produce no meaningful result. diff --git a/apps/docs/content/guides/api/creating-routes.mdx b/apps/docs/content/guides/api/creating-routes.mdx index 43e78a99f84..64c44884024 100644 --- a/apps/docs/content/guides/api/creating-routes.mdx +++ b/apps/docs/content/guides/api/creating-routes.mdx @@ -105,9 +105,9 @@ curl '/rest/v1/todos' \ -JS Reference: [select()](/docs/reference/javascript/select), -[insert()](/docs/reference/javascript/insert), -[update()](/docs/reference/javascript/update), -[upsert()](/docs/reference/javascript/upsert), -[delete()](/docs/reference/javascript/delete), -[rpc()](/docs/reference/javascript/rpc) (call Postgres functions). +JS Reference: [`select()`](/docs/reference/javascript/select), +[`insert()`](/docs/reference/javascript/insert), +[`update()`](/docs/reference/javascript/update), +[`upsert()`](/docs/reference/javascript/upsert), +[`delete()`](/docs/reference/javascript/delete), +[`rpc()`](/docs/reference/javascript/rpc) (call Postgres functions). diff --git a/apps/docs/content/guides/api/rest/generating-types.mdx b/apps/docs/content/guides/api/rest/generating-types.mdx index c5cf62d86e8..ad6036620e7 100644 --- a/apps/docs/content/guides/api/rest/generating-types.mdx +++ b/apps/docs/content/guides/api/rest/generating-types.mdx @@ -258,7 +258,7 @@ jobs: branch: ${{ github.ref }} ``` -Alternatively, you can use a community-supported GitHub action: [generate-supabase-db-types-github-action](https://github.com/lyqht/generate-supabase-db-types-github-action). +Alternatively, you can use a community-supported GitHub action: [`generate-supabase-db-types-github-action`](https://github.com/lyqht/generate-supabase-db-types-github-action). ## Resources diff --git a/apps/docs/content/guides/api/sql-to-api.mdx b/apps/docs/content/guides/api/sql-to-api.mdx index 2e2183d0766..e3456d988b4 100644 --- a/apps/docs/content/guides/api/sql-to-api.mdx +++ b/apps/docs/content/guides/api/sql-to-api.mdx @@ -66,7 +66,7 @@ const { data, error } = await supabase ## Resources - [Supabase - Get started for free](https://supabase.com) -- [Postgrest Operators](https://postgrest.org/en/stable/api.html#operators) +- [PostgREST Operators](https://postgrest.org/en/stable/api.html#operators) - [Supabase API: JavaScript select](/docs/reference/javascript/select) - [Supabase API: JavaScript modifiers](/docs/reference/javascript/using-modifiers) - [Supabase API: JavaScript filters](/docs/reference/javascript/using-filters) diff --git a/apps/docs/content/guides/api/sql-to-rest.mdx b/apps/docs/content/guides/api/sql-to-rest.mdx index e96e844932b..13d3ad031ce 100644 --- a/apps/docs/content/guides/api/sql-to-rest.mdx +++ b/apps/docs/content/guides/api/sql-to-rest.mdx @@ -7,7 +7,7 @@ description: 'Translate SQL queries to HTTP requests and Supabase client code' Sometimes it's challenging to translate SQL queries to the equivalent [PostgREST](https://postgrest.org/) request or Supabase client code. Use this tool to help with this translation. - + PostgREST supports a subset of SQL, so not all SQL queries will translate. diff --git a/apps/docs/content/guides/auth/auth-anonymous.mdx b/apps/docs/content/guides/auth/auth-anonymous.mdx index 1e4a506e1b6..04433660137 100644 --- a/apps/docs/content/guides/auth/auth-anonymous.mdx +++ b/apps/docs/content/guides/auth/auth-anonymous.mdx @@ -189,7 +189,7 @@ response = supabase.auth.update_user({ > -You can use the [`linkIdentity()`](/docs/reference/javascript/auth-linkidentity) method to link an oauth identity to the anonymous user. +You can use the [`linkIdentity()`](/docs/reference/javascript/auth-linkidentity) method to link an OAuth identity to the anonymous user. ```js const { data, error } = await supabase.auth.linkIdentity({ provider: 'google' }) @@ -216,7 +216,7 @@ try await supabase.auth.linkIdentity(provider: .google) -You can use the [`linkIdentity()`](/docs/reference/kotlin/auth-linkidentity) method to link an oauth identity to the anonymous user. +You can use the [`linkIdentity()`](/docs/reference/kotlin/auth-linkidentity) method to link an OAuth identity to the anonymous user. ```kotlin supabase.auth.linkIdentity(Google) @@ -225,7 +225,7 @@ supabase.auth.linkIdentity(Google) -You can use the [`link_identity()`](/docs/reference/python/auth-linkidentity) method to link an oauth identity to the anonymous user. +You can use the [`link_identity()`](/docs/reference/python/auth-linkidentity) method to link an OAuth identity to the anonymous user. ```python response = supabase.auth.link_identity({'provider': 'google'}) @@ -250,7 +250,7 @@ to authenticated using ( true ); ``` - + RLS policies are permissive by default, which means that they are combined using an "OR" operator when multiple policies are applied. It is important to construct restrictive policies to ensure that the checks for an anonymous user are always enforced when combined with other policies. @@ -313,7 +313,7 @@ async function resolveDataConflicts(anonymousUserId, existingUserId) { ## Abuse prevention and rate limits -Since anonymous users are stored in your database, bad actors can abuse the endpoint to increase your database size drastically. It is strongly recommended to [enable invisible Captcha or Cloudflare Turnstile](/docs/guides/auth/auth-captcha) to prevent abuse for anonymous sign-ins. An IP-based rate limit is enforced at 30 requests per hour which can be modified in your [dashboard](/dashboard/project/_/auth/rate-limits). You can refer to the full list of rate limits [here](/docs/guides/platform/going-into-prod#rate-limiting-resource-allocation--abuse-prevention). +Since anonymous users are stored in your database, bad actors can abuse the endpoint to increase your database size drastically. It is strongly recommended to [enable invisible CAPTCHA or Cloudflare Turnstile](/docs/guides/auth/auth-captcha) to prevent abuse for anonymous sign-ins. An IP-based rate limit is enforced at 30 requests per hour which can be modified in your [dashboard](/dashboard/project/_/auth/rate-limits). You can refer to the full list of rate limits [here](/docs/guides/platform/going-into-prod#rate-limiting-resource-allocation--abuse-prevention). ## Automatic cleanup diff --git a/apps/docs/content/guides/auth/auth-captcha.mdx b/apps/docs/content/guides/auth/auth-captcha.mdx index a55b4e46ab2..9d5e8c99dab 100644 --- a/apps/docs/content/guides/auth/auth-captcha.mdx +++ b/apps/docs/content/guides/auth/auth-captcha.mdx @@ -41,13 +41,13 @@ In the Settings page, look for the **Sitekey** section and copy the key. ## Enable CAPTCHA protection for your Supabase project -Navigate to the **[Auth](https://supabase.com/dashboard/project/_/settings/auth)** section of your Project Settings in the Supabase Dashboard and find the **Enable Captcha protection** toggle under Settings > Authentication > Bot and Abuse Protection > Enable Captcha protection. +Navigate to the **[Auth](https://supabase.com/dashboard/project/_/settings/auth)** section of your Project Settings in the Supabase Dashboard and find the **Enable CAPTCHA protection** toggle under Settings > Authentication > Bot and Abuse Protection > Enable CAPTCHA protection. -Select your CAPTCHA provider from the dropdown, enter your Captcha **Secret key**, and click **Save**. +Select your CAPTCHA provider from the dropdown, enter your CAPTCHA **Secret key**, and click **Save**. ## Add the CAPTCHA frontend component -The frontend requires some changes to provide the captcha on-screen for the user. This example uses React and the corresponding Captcha React component, but both Captcha providers can be used with any JavaScript framework. +The frontend requires some changes to provide the CAPTCHA on-screen for the user. This example uses React and the corresponding CAPTCHA React component, but both CAPTCHA providers can be used with any JavaScript framework. ``` -We will pass it the sitekey we copied from the hCaptcha website as a property along with a onVerify property which takes a callback function. This callback function will have a token as one of its properties. Let's set the token in the state using `setCaptchaToken` +We will pass it the sitekey we copied from the hCaptcha website as a property along with a `onVerify` property which takes a callback function. This callback function will have a token as one of its properties. Let's set the token in the state using `setCaptchaToken` ```jsx ``` -Now lets use the captcha token we receive in our Supabase signUp function. +Now lets use the CAPTCHA token we receive in our Supabase signUp function. ```jsx await supabase.auth.signUp({ @@ -104,9 +104,9 @@ await supabase.auth.signUp({ }) ``` -We will also need to reset the captcha challenge after we have made a call to the function above. +We will also need to reset the CAPTCHA challenge after we have made a call to the function above. -Create a ref to use on our HCaptcha component. +Create a ref to use on our `HCaptcha` component. ```jsx const captcha = useRef() @@ -136,7 +136,7 @@ In order to test that this works locally we will need to use something like [ngr -The frontend requires some changes to provide the captcha on-screen for the user. Turnstile can be used with any JavaScript framework but we'll use React and the Turnstile React component for this example. +The frontend requires some changes to provide the CAPTCHA on-screen for the user. Turnstile can be used with any JavaScript framework but we'll use React and the Turnstile React component for this example. Install @marsidev/react-turnstile in your project as a dependency. @@ -183,9 +183,9 @@ await supabase.auth.signUp({ }) ``` -To test locally, you will need to add localhost to the domain whitelist as per the [Cloudflare docs](https://developers.cloudflare.com/turnstile/reference/testing/) +To test locally, you will need to add localhost to the domain allowlist as per the [Cloudflare docs](https://developers.cloudflare.com/turnstile/reference/testing/) -Run the application and you should now be provided with a captcha challenge. +Run the application and you should now be provided with a CAPTCHA challenge. diff --git a/apps/docs/content/guides/auth/auth-helpers/auth-ui.mdx b/apps/docs/content/guides/auth/auth-helpers/auth-ui.mdx index 55d96374d17..7b239511062 100644 --- a/apps/docs/content/guides/auth/auth-helpers/auth-ui.mdx +++ b/apps/docs/content/guides/auth/auth-helpers/auth-ui.mdx @@ -5,7 +5,7 @@ description: 'A prebuilt, customizable React component for authenticating users. sitemapPriority: 0.5 --- - + As of 7th Feb 2024, [this repository](https://github.com/supabase-community/auth-ui) is no longer maintained by the Supabase Team. At the moment, the team does not have capacity to give the expected level of care to this repository. We may revisit Auth UI in the future but regrettably have to leave it on hold for now as we focus on other priorities such as improving the Server-Side Rendering (SSR) package and advanced Auth primitives. @@ -444,7 +444,7 @@ A full list of the available variables is below: | `phone_input_label` | Phone number | | `phone_input_placeholder` | Your phone number | | `token_input_label` | Token | -| `token_input_placeholder` | Your Otp token | +| `token_input_placeholder` | Your OTP token | | `button_label` | Verify token | | `loading_button_label` | Signing in ... | diff --git a/apps/docs/content/guides/auth/auth-helpers/flutter-auth-ui.mdx b/apps/docs/content/guides/auth/auth-helpers/flutter-auth-ui.mdx index c088488c816..73507acfc71 100644 --- a/apps/docs/content/guides/auth/auth-helpers/flutter-auth-ui.mdx +++ b/apps/docs/content/guides/auth/auth-helpers/flutter-auth-ui.mdx @@ -36,9 +36,9 @@ void main() async { ### Email Auth -Use a SupaEmailAuth widget to create an email and password signin and signup form. It also contains a button to toggle to display a forgot password form. +Use a `SupaEmailAuth` widget to create an email and password signin and signup form. It also contains a button to toggle to display a forgot password form. -You can pass metadataFields to add additional fields to the form to pass as metadata to Supabase. +You can pass `metadataFields` to add additional fields to the form to pass as metadata to Supabase. ```dart SupaEmailAuth( @@ -63,7 +63,7 @@ SupaEmailAuth( ### Magic link Auth -Use SupaMagicAuth widget to create a magic link signIn form. +Use `SupaMagicAuth` widget to create a magic link signIn form. ```dart SupaMagicAuth( @@ -75,7 +75,7 @@ SupaMagicAuth( ### Reset password -Use SupaResetPassword to create a password reset form. +Use `SupaResetPassword` to create a password reset form. ```dart SupaResetPassword( @@ -87,7 +87,7 @@ SupaResetPassword( ### Phone Auth -Use SupaPhoneAuth to create a phone authentication form. +Use `SupaPhoneAuth` to create a phone authentication form. ```dart SupaPhoneAuth( @@ -100,7 +100,7 @@ SupaPhoneAuth( The package supports login with [official social providers](../../auth#providers). -Use SupaSocialsAuth to create list of social login buttons. +Use `SupaSocialsAuth` to create list of social login buttons. ```dart SupaSocialsAuth( diff --git a/apps/docs/content/guides/auth/auth-helpers/nextjs-pages.mdx b/apps/docs/content/guides/auth/auth-helpers/nextjs-pages.mdx index 79747f20853..abc435c7719 100644 --- a/apps/docs/content/guides/auth/auth-helpers/nextjs-pages.mdx +++ b/apps/docs/content/guides/auth/auth-helpers/nextjs-pages.mdx @@ -20,7 +20,7 @@ The `auth-helpers` package has been replaced with the `@supabase/ssr` package. W size="medium" className="text-foreground-light border-b mt-8 pb-2" > - + () ``` -Retrieving a supabase client object from the SessionContext: +Retrieving a `supabase` client object from the `SessionContext`: ```tsx import { useSupabaseClient } from '@supabase/auth-helpers-react' @@ -286,7 +286,7 @@ export default LoginPage ## Server-side rendering (SSR) -Create a server supabase client to retrieve the logged in user's session: +Create a server Supabase client to retrieve the logged in user's session: ```jsx pages/profile.js import { createPagesServerClient } from '@supabase/auth-helpers-nextjs' @@ -321,7 +321,7 @@ export const getServerSideProps = async (ctx) => { ## Server-side data fetching with RLS -You can use the server supabase client to run [row level security](/docs/learn/auth-deep-dive/auth-row-level-security) authenticated queries server-side: +You can use the server Supabase client to run [row level security](/docs/learn/auth-deep-dive/auth-row-level-security) authenticated queries server-side: { ## Protecting API routes -Create a server supabase client to retrieve the logged in user's session: +Create a server Supabase client to retrieve the logged in user's session: { - The `useUser` hook now returns the `user` object or `null`. - Usage with TypeScript: You can pass types that were [generated with the Supabase CLI](/docs/reference/javascript/typescript-support#generating-types) to the Supabase Client to get enhanced type safety and auto completion: -Creating a new supabase client object: +Creating a new `supabase` client object: ```tsx import { Database } from '../database.types' @@ -925,7 +925,7 @@ import { Database } from '../database.types' const [supabaseClient] = useState(() => createPagesBrowserClient()) ``` -Retrieving a supabase client object from the SessionContext: +Retrieving a `supabase` client object from the `SessionContext`: ```tsx import { useSupabaseClient } from '@supabase/auth-helpers-react' diff --git a/apps/docs/content/guides/auth/auth-helpers/nextjs.mdx b/apps/docs/content/guides/auth/auth-helpers/nextjs.mdx index 3b715239ec7..d69f84558e8 100644 --- a/apps/docs/content/guides/auth/auth-helpers/nextjs.mdx +++ b/apps/docs/content/guides/auth/auth-helpers/nextjs.mdx @@ -1304,7 +1304,7 @@ supabase.auth.signUp({ #### Deprecated functions -With v0.7.x of the Next.js Auth Helpers a new naming convention has been implemented for createClient functions. The `createMiddlewareSupabaseClient`, `createBrowserSupabaseClient`, `createServerComponentSupabaseClient` and `createRouteHandlerSupabaseClient` functions have been marked as deprecated, and will be removed in a future version of the Auth Helpers. +With v0.7.x of the Next.js Auth Helpers a new naming convention has been implemented for `createClient` functions. The `createMiddlewareSupabaseClient`, `createBrowserSupabaseClient`, `createServerComponentSupabaseClient` and `createRouteHandlerSupabaseClient` functions have been marked as deprecated, and will be removed in a future version of the Auth Helpers. - `createMiddlewareSupabaseClient` has been replaced with `createMiddlewareClient` - `createBrowserSupabaseClient` has been replaced with `createClientComponentClient` diff --git a/apps/docs/content/guides/auth/auth-helpers/sveltekit.mdx b/apps/docs/content/guides/auth/auth-helpers/sveltekit.mdx index b94647a0660..ddb5107adb1 100644 --- a/apps/docs/content/guides/auth/auth-helpers/sveltekit.mdx +++ b/apps/docs/content/guides/auth/auth-helpers/sveltekit.mdx @@ -20,7 +20,7 @@ We generally recommend using the new `@supabase/ssr` package instead of `auth-he size="medium" className="text-foreground-light border-b mt-8 pb-2" > - + { -Note that we are specifying filterSerializedResponseHeaders here. We need to tell SvelteKit that supabase needs the `content-range` and `x-supabase-api-version` headers. +Note that we are specifying `filterSerializedResponseHeaders` here. We need to tell SvelteKit that Supabase needs the `content-range` and `x-supabase-api-version` headers. @@ -213,7 +213,7 @@ export const GET = async ({ url, locals: { supabase } }) => { ### Generate types from your database -In order to get the most out of TypeScript and it's intellisense, you should import the generated Database types into the `app.d.ts` type definition file that comes with your SvelteKit project, where `import('./DatabaseDefinitions')` points to the generated types file outlined in [v2 docs here](https://supabase.com/docs/reference/javascript/release-notes#typescript-support) after you have logged in, linked, and generated types through the Supabase CLI. +In order to get the most out of TypeScript and its IntelliSense, you should import the generated Database types into the `app.d.ts` type definition file that comes with your SvelteKit project, where `import('./DatabaseDefinitions')` points to the generated types file outlined in [v2 docs here](https://supabase.com/docs/reference/javascript/release-notes#typescript-support) after you have logged in, linked, and generated types through the Supabase CLI. ```ts src/app.d.ts // src/app.d.ts @@ -377,13 +377,13 @@ TypeScript types can be [generated with the Supabase CLI](https://supabase.com/d Access the client inside pages by `$page.data.supabase` or `data.supabase` when using `export let data`. -The usage of `depends` tells sveltekit that this load function should be executed whenever `invalidate` is called to keep the page store in sync. +The usage of `depends` tells SvelteKit that this load function should be executed whenever `invalidate` is called to keep the page store in sync. `createSupabaseLoadClient` caches the client when running in a browser environment and therefore does not create a new client for every time the load function runs. #### Setting up the event listener on the client side -We need to create an event listener in the root `+layout.svelte` file in order to catch supabase events being triggered. +We need to create an event listener in the root `+layout.svelte` file in order to catch Supabase events being triggered. ```svelte src/routes/+layout.svelte @@ -416,7 +416,7 @@ The usage of `invalidate` tells SvelteKit that the root `+layout.ts` load functi #### Sign in / sign up / sign out -We can access the supabase instance in our `+page.svelte` file through the data object. +We can access the Supabase instance in our `+page.svelte` file through the data object. ```svelte src/routes/auth/+page.svelte @@ -634,7 +634,7 @@ If you try to submit a form with the action `?/createPost` without a valid sessi To avoid writing the same auth logic in every single route you can also use the handle hook to protect multiple routes at once. For this to work with your Supabase session, you need to use -Sveltekit's [sequence helper](https://kit.svelte.dev/docs/modules#sveltejs-kit-hooks) function. +SvelteKit's [sequence helper](https://kit.svelte.dev/docs/modules#sveltejs-kit-hooks) function. Edit your `/src/hooks.server.js` with the below: { Since version 0.9 relies on `hooks.server.ts` to setup our client, we no longer need the `hooks.client.ts` in our project for Supabase related code. -#### Typings [#migration-typings] +#### Types [#migration-typings] -#### Typings [#migration-typings-0-8] +#### Types [#migration-typings-0-8] -#### Typings [#migration-typings-0-7] +#### Types [#migration-typings-0-7] -A [postgres function](/docs/guides/database/functions) can be configured as a hook. The function should take in a single argument -- the event of type JSONB -- and return a JSONB object. Since the postgres function runs on your database, the request does not leave your project's instance. +A [Postgres function](/docs/guides/database/functions) can be configured as a hook. The function should take in a single argument -- the event of type JSONB -- and return a JSONB object. Since the Postgres function runs on your database, the request does not leave your project's instance. @@ -59,9 +59,9 @@ Sign the payload and grant permissions selectively in order to guard the integri > -When you configure a postgres function as a hook, Supabase will automatically apply the following grants to the function for these reasons: +When you configure a Postgres function as a hook, Supabase will automatically apply the following grants to the function for these reasons: -- Allow the `supabase_auth_admin` role to execute the function. The `supabase_auth_admin` role is the postgres role that is used by Supabase Auth to make requests to your database. +- Allow the `supabase_auth_admin` role to execute the function. The `supabase_auth_admin` role is the Postgres role that is used by Supabase Auth to make requests to your database. - Revoke permissions from other roles (e.g. `anon`, `authenticated`, `public`) to ensure the function is not accessible by Supabase Data APIs. ```sql @@ -81,7 +81,7 @@ revoke execute You will need to alter your row-level security (RLS) policies to allow the `supabase_auth_admin` role to access tables that you have RLS policies on. You can read more about RLS policies [here](/docs/guides/database/postgres/row-level-security). -Alternatively, you can create your postgres function via the dashboard with the `security definer` tag. The `security definer` tag specifies that the function is to be executed with the privileges of the user that owns it. +Alternatively, you can create your Postgres function via the dashboard with the `security definer` tag. The `security definer` tag specifies that the function is to be executed with the privileges of the user that owns it. Currently, functions created via the dashboard take on the `postgres` role. Read more about the `security definer` tag [in our database guide](/docs/guides/database/functions#security-definer-vs-invoker) @@ -344,7 +344,7 @@ Outside of runtime errors, both HTTP Hooks and Postgres Hooks return timeout err ## Available Hooks -Each Hook description contains an example JSONSchema which you can use in conjunction with [JSONSchema Faker](https://json-schema-faker.js.org/) in order to generate a mock payload. For HTTP Hooks, you can also use [the Standard Webhooks Testing Tool](https://www.standardwebhooks.com/simulate) to simulate a request. +Each Hook description contains an example JSON Schema which you can use in conjunction with [JSON Schema Faker](https://json-schema-faker.js.org/) in order to generate a mock payload. For HTTP Hooks, you can also use [the Standard Webhooks Testing Tool](https://www.standardwebhooks.com/simulate) to simulate a request.
{[ diff --git a/apps/docs/content/guides/auth/auth-hooks/send-email-hook.mdx b/apps/docs/content/guides/auth/auth-hooks/send-email-hook.mdx index 8f68c3b9dd4..89a22ba9292 100644 --- a/apps/docs/content/guides/auth/auth-hooks/send-email-hook.mdx +++ b/apps/docs/content/guides/auth/auth-hooks/send-email-hook.mdx @@ -477,7 +477,7 @@ RESEND_API_KEY=your_resend_api_key SEND_EMAIL_HOOK_SECRET= ``` - + You can generate the secret in the [Auth Hooks](/dashboard/project/_/auth/hooks) section of the Supabase dashboard. Make sure to remove the `v1,whsec_` prefix! diff --git a/apps/docs/content/guides/auth/auth-hooks/send-sms-hook.mdx b/apps/docs/content/guides/auth/auth-hooks/send-sms-hook.mdx index 3a9a27cc63f..2dab295db87 100644 --- a/apps/docs/content/guides/auth/auth-hooks/send-sms-hook.mdx +++ b/apps/docs/content/guides/auth/auth-hooks/send-sms-hook.mdx @@ -8,7 +8,7 @@ Runs before a message is sent. Use the hook to: - Use a regional SMS Provider - Use alternate messaging channels such as WhatsApp -- Adjust the message body to include platform specific fields such as the [AppHash](https://developers.google.com/identity/sms-retriever/overview) +- Adjust the message body to include platform specific fields such as the [`AppHash`](https://developers.google.com/identity/sms-retriever/overview) **Inputs** diff --git a/apps/docs/content/guides/auth/auth-mfa.mdx b/apps/docs/content/guides/auth/auth-mfa.mdx index e2146375370..71dd4398b78 100644 --- a/apps/docs/content/guides/auth/auth-mfa.mdx +++ b/apps/docs/content/guides/auth/auth-mfa.mdx @@ -111,7 +111,7 @@ Below is an example that creates a new `UnenrollMFA` component that illustrates - When the component appears on screen, the `supabase.auth.mfa.listFactors()` endpoint fetches all existing factors together with their details. - The existing factors for a user are displayed in a table. -- Once the user has selected a factor to unenroll, they can type in the factorId and click **Unenroll** +- Once the user has selected a factor to unenroll, they can type in the `factorId` and click **Unenroll** which creates a confirmation modal. diff --git a/apps/docs/content/guides/auth/auth-smtp.mdx b/apps/docs/content/guides/auth/auth-smtp.mdx index cac7981f737..1d1558d3c18 100644 --- a/apps/docs/content/guides/auth/auth-smtp.mdx +++ b/apps/docs/content/guides/auth/auth-smtp.mdx @@ -63,7 +63,7 @@ They use lists of known email addresses to sign up users to your project with pr Usually the goal for this behavior is: - To negatively affect your email sending reputation, after which they might ask for a ransom promising to stop the behavior. -- To cause a short-term or even long-term Denial of Service attack on your service, by preventing new account creation, sign ins with magic links or one-time passwords, or to severely impact important security flows in your application (such as reset password or forgot password). +- To cause a short-term or even long-term Denial of Service attack on your service, by preventing new account creation, signins with magic links or one-time passwords, or to severely impact important security flows in your application (such as reset password or forgot password). - To force you to reduce the security posture of your project, such as by disabling email confirmations. At that point, they may target specific or a broad number of users by creating an account in their name. Then they can use social engineering techniques to trick them to use your application in such a way that both attacker and victim have access to the same account. Mitigation strategies: diff --git a/apps/docs/content/guides/auth/enterprise-sso/auth-sso-saml.mdx b/apps/docs/content/guides/auth/enterprise-sso/auth-sso-saml.mdx index ef9b8c8d573..e35a50a59de 100644 --- a/apps/docs/content/guides/auth/enterprise-sso/auth-sso-saml.mdx +++ b/apps/docs/content/guides/auth/enterprise-sso/auth-sso-saml.mdx @@ -5,7 +5,7 @@ description: 'Use Single Sign-On (SSO) authentication on your project with SAML video: 'https://www.youtube.com/v/em1cpOAXknM' --- - + Looking for guides on how to use Single Sign-On with the Supabase dashboard? Head on over to [Enable SSO for Your Organization](/docs/guides/platform/sso). @@ -13,7 +13,7 @@ Looking for guides on how to use Single Sign-On with the Supabase dashboard? Hea Supabase Auth supports enterprise-level Single Sign-On (SSO) for any identity providers compatible with the SAML 2.0 protocol. This is a non-exclusive list of supported identity providers: -- Google Workspaces (formerly known as GSuite) +- Google Workspaces (formerly known as G Suite) - Okta, Auth0 - Microsoft Active Directory, Azure Active Directory, Microsoft Entra - PingIdentity @@ -36,14 +36,14 @@ Please note that SAML 2.0 support is offered on plans Pro and above. Check the [ The number of SAML and SSO acronyms can often be overwhelming. Here's a glossary which you can refer back to at any time: - **Identity Provider**, **IdP**, or **IDP** - An identity provider is a service that manages user accounts at a company or organization. It can verify the identity of a user and exchange that information with your Supabase project and other applications. It acts as a single source of truth for user identities and access rights. Commonly used identity providers are: Microsoft Active Directory (Azure AD, Microsoft Entra), Okta, Google Workspaces (GSuite), PingIdentity, OneLogin, and many others. There are also self-hosted and on-prem versions of identity providers, and sometimes they are accessible only by having access to a company VPN or being in a specific building. + An identity provider is a service that manages user accounts at a company or organization. It can verify the identity of a user and exchange that information with your Supabase project and other applications. It acts as a single source of truth for user identities and access rights. Commonly used identity providers are: Microsoft Active Directory (Azure AD, Microsoft Entra), Okta, Google Workspaces (G Suite), PingIdentity, OneLogin, and many others. There are also self-hosted and on-prem versions of identity providers, and sometimes they are accessible only by having access to a company VPN or being in a specific building. - **Service Provider**, **SP** This is the software that is asking for user information from an identity provider. In Supabase, this is your project's Auth server. - **Assertion** An assertion is a statement issued by an identity provider that contains information about a user. -- **EntityID** +- **`EntityID`** A globally unique ID (usually a URL) that identifies an Identity Provider or Service Provider across the world. -- **NameID** +- **`NameID`** A unique ID (usually an email address) that identifies a user at an Identity Provider. - **Metadata** An XML document that describes the features and configuration of an Identity Provider or Service Provider. It can be as a standalone document or as a URL. Usually (but not always) the `EntityID` is the URL at which you can access the Metadata. @@ -53,7 +53,7 @@ The number of SAML and SSO acronyms can often be overwhelming. Here's a glossary This is one of the most important SAML URLs. It is the URL where Supabase Auth will accept assertions from an identity provider. Basically, once the identity provider verifies the user's identity it will redirect to this URL and the redirect request will contain the assertion. - **Binding (Redirect, POST, or Artifact)** This is a description of the way an identity provider communicates with Supabase Auth. When using the Redirect binding, the communication occurs using HTTP 301 redirects. When it's `POST`, it's using `POST` requests sent with `
` elements on a page. When using Artifact, it's using a more secure exchange over a Redirect or `POST`. -- **RelayState** +- **`RelayState`** State used by Supabase Auth to hold information about a request to verify the identity of a user. ## Important SAML 2.0 information @@ -62,12 +62,12 @@ Below is information about your project's SAML 2.0 configuration which you can s | Name | Value | | --------------------------- | ----------------------------------------------------------------------- | -| EntityID | `https://.supabase.co/auth/v1/sso/saml/metadata` | +| `EntityID` | `https://.supabase.co/auth/v1/sso/saml/metadata` | | Metadata URL | `https://.supabase.co/auth/v1/sso/saml/metadata` | | Metadata URL
(download) | `https://.supabase.co/auth/v1/sso/saml/metadata?download=true` | | ACS URL | `https://.supabase.co/auth/v1/sso/saml/acs` | | SLO URL | `https://.supabase.co/auth/v1/sso/slo` | -| NameID | Required `emailAddress` or `persistent` | +| `NameID` | Required `emailAddress` or `persistent` | Note that SLO (Single Logout) is not supported at this time with Supabase Auth as it is a rarely supported feature by identity providers. However, the URL is registered and advertised for when this does become available. @@ -155,7 +155,7 @@ Commonly used SAML 2.0 Identity Providers that support Metadata URLs: Commonly used SAML 2.0 Identity Providers that only support Metadata XML files: -- Google Workspaces (GSuite) +- Google Workspaces (G Suite) - Any self-hosted or on-prem identity provider behind a VPN Once you've obtained the SAML 2.0 Metadata XML file or URL you can [establish a connection](/docs/reference/cli/supabase-sso-add) with your project's Supabase Auth server by running: @@ -323,7 +323,7 @@ Most SAML 2.0 identity providers use Lightweight Directory Access Protocol (LDAP **Accessing the stored attributes** -The stored attributes, once mapped, show up in the access token (a JWT) of the user. If you need to look these values up in the database, you can find them in the `auth.identities` table under the `identity_data` JSON column. Identities created for SSO providers have `sso:` in the `provider` column, while `id` contains the unique NameID of the user account. +The stored attributes, once mapped, show up in the access token (a JWT) of the user. If you need to look these values up in the database, you can find them in the `auth.identities` table under the `identity_data` JSON column. Identities created for SSO providers have `sso:` in the `provider` column, while `id` contains the unique `NameID` of the user account. Furthermore, you can find the same identity data under `raw_app_meta_data` inside `auth.users`. diff --git a/apps/docs/content/guides/auth/jwts.mdx b/apps/docs/content/guides/auth/jwts.mdx index c75509646d2..bbd6857349b 100644 --- a/apps/docs/content/guides/auth/jwts.mdx +++ b/apps/docs/content/guides/auth/jwts.mdx @@ -41,7 +41,7 @@ The JSON object starts out looking something like this: Just note that the more data you store in your token, the longer the encoded string will be. -When we want to send the JWT to the user, we first encode the data using an algorithm such as `HS256`. There are many libraries (and several different algorithms) that can be used to do this encoding/decoding, such as [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken). The signing is as simple as: +When we want to send the JWT to the user, we first encode the data using an algorithm such as `HS256`. There are many libraries (and several different algorithms) that can be used to do this encoding/decoding, such as [`jsonwebtoken`](https://www.npmjs.com/package/jsonwebtoken). The signing is as simple as: ```js // from https://replit.com/@awalias/jsonwebtokens#index.js diff --git a/apps/docs/content/guides/auth/native-mobile-deep-linking.mdx b/apps/docs/content/guides/auth/native-mobile-deep-linking.mdx index ba96b451495..18d8d01a937 100644 --- a/apps/docs/content/guides/auth/native-mobile-deep-linking.mdx +++ b/apps/docs/content/guides/auth/native-mobile-deep-linking.mdx @@ -113,14 +113,14 @@ With Deep Linking, you can configure this redirect to open a specific page. This - // Currently supabase_flutter supports deep links on Android, iOS, Web, MacOS and Windows. + // Currently supabase_flutter supports deep links on Android, iOS, Web, macOS and Windows. ### Deep link config - Go to your [auth settings](https://supabase.com/dashboard/project/_/auth/url-configuration) page. - You need to enter your app redirect callback on `Additional Redirect URLs` field. - The redirect callback url should have this format `[YOUR_SCHEME]://[YOUR_HOSTNAME]`. Here, `io.supabase.flutterquickstart://login-callback` is just an example, you can choose whatever you would like for `YOUR_SCHEME` and `YOUR_HOSTNAME` as long as the scheme is unique across the user's device. For this reason, typically a reverse domain of your website is used. + The redirect callback URL should have this format `[YOUR_SCHEME]://[YOUR_HOSTNAME]`. Here, `io.supabase.flutterquickstart://login-callback` is just an example, you can choose whatever you would like for `YOUR_SCHEME` and `YOUR_HOSTNAME` as long as the scheme is unique across the user's device. For this reason, typically a reverse domain of your website is used. ![Supabase console deep link setting](/docs/img/deeplink-setting.png) @@ -269,11 +269,10 @@ With Deep Linking, you can configure this redirect to open a specific page. This You can achieve it with [url_protocol](https://pub.dev/packages/url_protocol) inside you app. - The most relevant solution is to include those registry modifications into your installer to allow - for deregistration. + The most relevant solution is to include those registry modifications into your installer to allow for deregistration. - + Add this XML chapter in your `macos/Runner/Info.plist` inside `` chapter: @@ -311,7 +310,7 @@ With Deep Linking, you can configure this redirect to open a specific page. This 1. Go to your [auth settings](https://supabase.com/dashboard/project/_/auth/url-configuration) page. 2. Enter your app redirect URL in the `Additional Redirect URLs` field. This is the URL that the user gets redirected to after clicking a magic link. - The redirect callback url should have the format `[YOUR_SCHEME]://[YOUR_HOSTNAME]`. Here, `io.supabase.user-management://login-callback` is just an example. You can choose whatever you would like for `YOUR_SCHEME` and `YOUR_HOSTNAME` as long as the scheme is unique across the user's device. For this reason, typically a reverse domain of your website is used. + The redirect callback URL should have the format `[YOUR_SCHEME]://[YOUR_HOSTNAME]`. Here, `io.supabase.user-management://login-callback` is just an example. You can choose whatever you would like for `YOUR_SCHEME` and `YOUR_HOSTNAME` as long as the scheme is unique across the user's device. For this reason, typically a reverse domain of your website is used. ![Supabase console deep link setting](/docs/img/deeplink-setting.png) @@ -349,7 +348,7 @@ With Deep Linking, you can configure this redirect to open a specific page. This 1. Go to your [auth settings](https://supabase.com/dashboard/project/_/auth/url-configuration) page. 2. Enter your app redirect URL in the `Additional Redirect URLs` field. This is the URL that the user gets redirected to after clicking a magic link. - The redirect callback url should have the format `[YOUR_SCHEME]://[YOUR_HOSTNAME]`. Here, `io.supabase.user-management://login-callback` is just an example. You can choose whatever you would like for `YOUR_SCHEME` and `YOUR_HOSTNAME` as long as the scheme is unique across the user's device. For this reason, typically a reverse domain of your website is used. + The redirect callback URL should have the format `[YOUR_SCHEME]://[YOUR_HOSTNAME]`. Here, `io.supabase.user-management://login-callback` is just an example. You can choose whatever you would like for `YOUR_SCHEME` and `YOUR_HOSTNAME` as long as the scheme is unique across the user's device. For this reason, typically a reverse domain of your website is used. Now, edit the Android manifest to make sure the app opens when the user clicks on the magic link. @@ -394,7 +393,7 @@ With Deep Linking, you can configure this redirect to open a specific page. This } ``` - The user will now be authenticated when your app receives a valid deeplink! + The user will now be authenticated when your app receives a valid deep link! diff --git a/apps/docs/content/guides/auth/passwords.mdx b/apps/docs/content/guides/auth/passwords.mdx index c7115044276..590e256a268 100644 --- a/apps/docs/content/guides/auth/passwords.mdx +++ b/apps/docs/content/guides/auth/passwords.mdx @@ -465,7 +465,7 @@ data = supabase.auth.sign_up({ > -When your user signs in, call [signInWithPassword()](/docs/reference/javascript/auth-signinwithpassword) with their email address and password: +When your user signs in, call [`signInWithPassword()`](/docs/reference/javascript/auth-signinwithpassword) with their email address and password: ```js async function signInWithEmail() { @@ -479,7 +479,7 @@ async function signInWithEmail() { -When your user signs in, call [signInWithPassword()](/docs/reference/dart/auth-signinwithpassword) with their email address and password: +When your user signs in, call [`signInWithPassword()`](/docs/reference/dart/auth-signinwithpassword) with their email address and password: ```dart Future signInWithEmail() async { diff --git a/apps/docs/content/guides/auth/phone-login.mdx b/apps/docs/content/guides/auth/phone-login.mdx index f0b72198d94..e8baaf31ab3 100644 --- a/apps/docs/content/guides/auth/phone-login.mdx +++ b/apps/docs/content/guides/auth/phone-login.mdx @@ -5,7 +5,7 @@ description: 'Learn about logging in to your platform using SMS one-time passwor Phone Login is a method of authentication that allows users to log in to a website or application without using a password. The user authenticates through a one-time password (OTP) sent via a channel (SMS or WhatsApp). - + At this time, `WhatsApp` is only supported as a channel for the Twilio and Twilio Verify Providers. diff --git a/apps/docs/content/guides/auth/server-side/creating-a-client.mdx b/apps/docs/content/guides/auth/server-side/creating-a-client.mdx index bc43bb8ba16..10a38de1292 100644 --- a/apps/docs/content/guides/auth/server-side/creating-a-client.mdx +++ b/apps/docs/content/guides/auth/server-side/creating-a-client.mdx @@ -376,7 +376,7 @@ export const handle: Handle = async ({ event, resolve }) => { -Page components can get access to the supabase client from the `data` object due to this load function. +Page components can get access to the Supabase client from the `data` object due to this load function. ```ts +layout.ts import { PUBLIC_SUPABASE_ANON_KEY, PUBLIC_SUPABASE_URL } from '$env/static/public' diff --git a/apps/docs/content/guides/auth/social-login/auth-apple.mdx b/apps/docs/content/guides/auth/social-login/auth-apple.mdx index 5463db69e7d..2d9223f0010 100644 --- a/apps/docs/content/guides/auth/social-login/auth-apple.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-apple.mdx @@ -63,7 +63,7 @@ When developing with Expo, you can test Sign in with Apple via the Expo Go app, 6. Create a signing **Key** in the [Keys](https://developer.apple.com/account/resources/authkeys/list) section of the Apple Developer Console. You can use this key to generate a secret key using the tool below, which is added to your Supabase project's Auth configuration. Make sure you safely store the `AuthKey_XXXXXXXXXX.p8` file. If you ever lose access to it, or make it public accidentally please revoke it from the Apple Developer Console and create a new one immediately. You will have to generate a new secret key using this file every 6 months, so make sure you schedule a recurring meeting in your calendar! 7. Finally, add the information you configured above to the [Apple provider configuration in the Supabase dashboard](https://supabase.com/dashboard/project/_/auth/providers). - + Use this tool to generate a new Apple client secret. No keys leave your browser! Be aware that this tool does not currently work in Safari, so please use Firefox or a Chrome-based browser instead. @@ -280,7 +280,7 @@ When developing with Expo, you can test Sign in with Apple via the Expo Go app, 6. Create a signing **Key** in the [Keys](https://developer.apple.com/account/resources/authkeys/list) section of the Apple Developer Console. You can use this key to generate a secret key using the tool below, which is added to your Supabase project's Auth configuration. Make sure you safely store the `AuthKey_XXXXXXXXXX.p8` file. If you ever lose access to it, or make it public accidentally please revoke it from the Apple Developer Console and create a new one immediately. You will have to generate a new secret key using this file every 6 months, so make sure you schedule a recurring reminder in your calendar! 7. Finally, add the information you configured above to the [Apple provider configuration in the Supabase dashboard](https://supabase.com/dashboard/project/_/auth/providers). - + Use this tool to generate a new Apple client secret. No keys leave your browser! Be aware that this tool does not currently work in Safari, so please use Firefox or a Chrome-based browser instead. @@ -348,12 +348,12 @@ When developing with Expo, you can test Sign in with Apple via the Expo Go app, - + - + ## Using native sign in with Apple in Kotlin - - When using [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform/), you can use the [compose-auth](https://supabase.com/docs/reference/kotlin/installing) plugin. On iOS it uses Native Apple Login automatically and on other platforms it uses `gotrue.signInWith(Apple)`. + + When using [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform/), you can use the [compose-auth](https://supabase.com/docs/reference/kotlin/installing) plugin. On iOS it uses Native Apple Login automatically and on other platforms it uses `gotrue.signInWith(Apple)`. **Initialize the Supabase Client** diff --git a/apps/docs/content/guides/auth/social-login/auth-azure.mdx b/apps/docs/content/guides/auth/social-login/auth-azure.mdx index 6e9161a7d7e..f31c269492a 100644 --- a/apps/docs/content/guides/auth/social-login/auth-azure.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-azure.mdx @@ -126,7 +126,7 @@ Supabase Auth requires that Azure returns a valid email address. Therefore you m -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `azure` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `azure` as the `provider`: ```js async function signInWithAzure() { @@ -142,7 +142,7 @@ async function signInWithAzure() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `azure` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `azure` as the `provider`: ```dart Future signInWithAzure() async { diff --git a/apps/docs/content/guides/auth/social-login/auth-bitbucket.mdx b/apps/docs/content/guides/auth/social-login/auth-bitbucket.mdx index 7c3d394a00c..a690d3cf9aa 100644 --- a/apps/docs/content/guides/auth/social-login/auth-bitbucket.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-bitbucket.mdx @@ -4,7 +4,7 @@ title: 'Login with Bitbucket' description: 'Add Bitbucket OAuth to your Supabase project' --- -To enable Bitbucket Auth for your project, you need to set up a BitBucket OAuth application and add the application credentials to your Supabase Dashboard. +To enable Bitbucket Auth for your project, you need to set up a Bitbucket OAuth application and add the application credentials to your Supabase Dashboard. ## Overview @@ -57,7 +57,7 @@ Setting up Bitbucket logins for your application consists of 3 parts: -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `bitbucket` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `bitbucket` as the `provider`: ```js async function signInWithBitbucket() { @@ -70,7 +70,7 @@ async function signInWithBitbucket() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `bitbucket` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `bitbucket` as the `provider`: ```dart Future signInWithBitbucket() async { diff --git a/apps/docs/content/guides/auth/social-login/auth-discord.mdx b/apps/docs/content/guides/auth/social-login/auth-discord.mdx index 6dd8161b465..9712a6c76ae 100644 --- a/apps/docs/content/guides/auth/social-login/auth-discord.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-discord.mdx @@ -56,7 +56,7 @@ Setting up Discord logins for your application consists of 3 parts: -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `discord` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `discord` as the `provider`: ```js async function signInWithDiscord() { @@ -69,7 +69,7 @@ async function signInWithDiscord() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `discord` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `discord` as the `provider`: ```dart Future signInWithDiscord() async { diff --git a/apps/docs/content/guides/auth/social-login/auth-facebook.mdx b/apps/docs/content/guides/auth/social-login/auth-facebook.mdx index 420bf7511d0..419533140e0 100644 --- a/apps/docs/content/guides/auth/social-login/auth-facebook.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-facebook.mdx @@ -73,7 +73,7 @@ Under `Build Your App`, click on `Use Cases` screen. From there, do the followin -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `facebook` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `facebook` as the `provider`: ```js async function signInWithFacebook() { @@ -86,7 +86,7 @@ async function signInWithFacebook() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `facebook` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `facebook` as the `provider`: ```dart Future signInWithFacebook() async { @@ -102,7 +102,7 @@ Future signInWithFacebook() async { -When your user signs in, call [signInWithOAuth()](/docs/reference/swift/auth-signinwithoauth) with `facebook` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/swift/auth-signinwithoauth) with `facebook` as the `provider`: ```swift func signInWithFacebook() async throws { diff --git a/apps/docs/content/guides/auth/social-login/auth-figma.mdx b/apps/docs/content/guides/auth/social-login/auth-figma.mdx index ea3f979930a..fc5b9859acc 100644 --- a/apps/docs/content/guides/auth/social-login/auth-figma.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-figma.mdx @@ -57,7 +57,7 @@ Setting up Figma logins for your application consists of 3 parts: -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `figma` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `figma` as the `provider`: ```js async function signInWithFigma() { @@ -70,7 +70,7 @@ async function signInWithFigma() { -When your user signs in, call [signInWithOAuth()](/docs/reference/flutter/auth-signinwithoauth) with `figma` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/flutter/auth-signinwithoauth) with `figma` as the `provider`: ```dart Future signInWithFigma() async { diff --git a/apps/docs/content/guides/auth/social-login/auth-github.mdx b/apps/docs/content/guides/auth/social-login/auth-github.mdx index 715b2a7b98c..8b86db5c659 100644 --- a/apps/docs/content/guides/auth/social-login/auth-github.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-github.mdx @@ -51,7 +51,7 @@ Copy your new OAuth credentials -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `github` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `github` as the `provider`: ```js async function signInWithGithub() { @@ -64,7 +64,7 @@ async function signInWithGithub() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `github` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `github` as the `provider`: ```dart Future signInWithGithub() async { @@ -80,7 +80,7 @@ Future signInWithGithub() async { -When your user signs in, call [signInWithOAuth](/docs/reference/swift/auth-signinwithoauth) with `.github` as the `Provider`: +When your user signs in, call [`signInWithOAuth`](/docs/reference/swift/auth-signinwithoauth) with `.github` as the `Provider`: ```swift func signInWithGithub() async throws { diff --git a/apps/docs/content/guides/auth/social-login/auth-gitlab.mdx b/apps/docs/content/guides/auth/social-login/auth-gitlab.mdx index 067bbaeab92..7b68d6a8b84 100644 --- a/apps/docs/content/guides/auth/social-login/auth-gitlab.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-gitlab.mdx @@ -54,7 +54,7 @@ Setting up GitLab logins for your application consists of 3 parts: -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `gitlab` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `gitlab` as the `provider`: ```js async function signInWithGitLab() { @@ -67,7 +67,7 @@ async function signInWithGitLab() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `gitlab` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `gitlab` as the `provider`: ```dart Future signInWithGitLab() async { diff --git a/apps/docs/content/guides/auth/social-login/auth-google.mdx b/apps/docs/content/guides/auth/social-login/auth-google.mdx index f9c814c232a..ca2f562edef 100644 --- a/apps/docs/content/guides/auth/social-login/auth-google.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-google.mdx @@ -27,7 +27,7 @@ To support Sign In with Google, you need to configure the Google provider for yo For web applications, you can set up your signin button two different ways: - Use your own [application code](#application-code) for the button. -- Use [Google's pre-built sign-in or OneTap flows](#google-pre-built). +- Use [Google's pre-built sign-in or One Tap flows](#google-pre-built). ### Application code configuration @@ -78,7 +78,7 @@ To use Google's pre-built signin buttons: 1. Configure OAuth credentials for your Google Cloud project in the [Credentials](https://console.cloud.google.com/apis/credentials) page of the console. When creating a new OAuth client ID, choose _Android_ or _iOS_ depending on the mobile operating system your app is built for. - For Android, use the instructions on screen to provide the SHA-1 certificate fingerprint used to sign your Android app. - You will have a different set of SHA-1 certificate fingerprint for testing locally and going to production. Make sure to add both to the Google Cloud Console. and add all of the Client IDs to Supabase dashboard. - - For iOS, use the instructions on screen to provide the app Bundle ID, and App Store ID and Team ID if the app is already published on the Apple AppStore. + - For iOS, use the instructions on screen to provide the app Bundle ID, and App Store ID and Team ID if the app is already published on the Apple App Store. 2. Configure the [OAuth Consent Screen](https://console.cloud.google.com/apis/credentials/consent). This information is shown to the user when giving consent to your app. In particular, make sure you have set up links to your app's privacy policy and terms of service. 3. Finally, add the client ID from step 1 in the [Google provider on the Supabase Dashboard](https://supabase.com/dashboard/project/_/auth/providers), under _Client IDs_. @@ -94,7 +94,7 @@ To use Google's pre-built signin buttons: - For both Android and iOS, you will need to create a Web client ID in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials). - For Android, use the instructions on screen to provide the SHA-1 certificate fingerprint used to sign your Android app. - You will have a different set of SHA-1 certificate fingerprint for testing locally and going to production. Make sure to add both to the Google Cloud Console. and add all of the Client IDs to Supabase dashboard. - - For iOS, use the instructions on screen to provide the app Bundle ID, and App Store ID and Team ID if the app is already published on the Apple AppStore. + - For iOS, use the instructions on screen to provide the app Bundle ID, and App Store ID and Team ID if the app is already published on the Apple App Store. 2. Configure the [OAuth Consent Screen](https://console.cloud.google.com/apis/credentials/consent). This information is shown to the user when giving consent to your app. In particular, make sure you have set up links to your app's privacy policy and terms of service. 3. Add only the web client ID from step 1 in the [Google provider on the Supabase Dashboard](https://supabase.com/dashboard/project/_/auth/providers), under _Client IDs_. If you need iOS support, enable the `Skip nonce check` option. 4. For iOS, add the `CFBundleURLTypes` attributes below into the `/ios/Runner/Info.plist` file. @@ -129,7 +129,7 @@ To use Google's pre-built signin buttons: - Google sign-in with Supabase is done through the [GoogleSignIn-iOS](https://github.com/google/GoogleSignIn-iOS) package. + Google sign-in with Supabase is done through the [`GoogleSignIn-iOS`](https://github.com/google/GoogleSignIn-iOS) package. When the user provides consent, Google issues an identity token (commonly abbreviated as ID token) that is then sent to your project's Supabase Auth server. When valid, a new user session is started by issuing an access and refresh token from Supabase Auth. @@ -187,7 +187,7 @@ To use Google's pre-built signin buttons: 1. Configure OAuth credentials for your Google Cloud project in the [Credentials](https://console.cloud.google.com/apis/credentials) page of the console. When creating a new OAuth client ID, choose _Android_ or _iOS_ depending on the mobile operating system your app is built for. - For Android, use the instructions on screen to provide the SHA-1 certificate fingerprint used to sign your Android app. - - For iOS, use the instructions on screen to provide the app Bundle ID, and App Store ID and Team ID if the app is already published on the Apple AppStore. + - For iOS, use the instructions on screen to provide the app Bundle ID, and App Store ID and Team ID if the app is already published on the Apple App Store. 2. Configure the [OAuth Consent Screen](https://console.cloud.google.com/apis/credentials/consent). This information is shown to the user when giving consent to your app. In particular, make sure you have set up links to your app's privacy policy and terms of service. 3. Finally, add the client ID from step 1 in the [Google provider on the Supabase Dashboard](https://supabase.com/dashboard/project/_/auth/providers), under _Client IDs_. @@ -548,7 +548,7 @@ Future _nativeGoogleSignIn() async { ### Web, macOS, Windows, and Linux -Google sign-in with Supabase on Web, macOS, Windows, and Linux is done through the [signInWithOAuth](docs/reference/dart/auth-signinwithoauth) method. +Google sign-in with Supabase on Web, macOS, Windows, and Linux is done through the [`signInWithOAuth`](docs/reference/dart/auth-signinwithoauth) method. This method of signing in is web based, and will open a browser window to perform the sign in. For non-web platforms, the user is brought back to the app via [deep linking](/docs/guides/auth/native-mobile-deep-linking?platform=flutter). @@ -595,7 +595,7 @@ implementation ("com.google.android.libraries.identity.googleid:googleid:") ``` -Add the following proguard rules to your `proguard-rules.pro` file: +Add the following ProGuard rules to your `proguard-rules.pro` file: ```proguard -if class androidx.credentials.CredentialManager diff --git a/apps/docs/content/guides/auth/social-login/auth-kakao.mdx b/apps/docs/content/guides/auth/social-login/auth-kakao.mdx index ca54ed737dc..9b678996d95 100644 --- a/apps/docs/content/guides/auth/social-login/auth-kakao.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-kakao.mdx @@ -52,7 +52,7 @@ This will serve as the `client_id` when you make API calls to authenticate the u - Go to `Product settings` > `Kakao Login` > `Security`. - Click on the `Kakao Login` switch to enable Kakao Login. -- Click on `generate code` at the bottom to generate the `Client secret code` -- this will serve as a `client_secret` for your supabase project. +- Click on `generate code` at the bottom to generate the `Client secret code` -- this will serve as a `client_secret` for your Supabase project. - Make sure you enabled `Client secret code` by selecting `enable` from the `Activation state` section. ## Additional configurations on Kakao Developers portal @@ -79,7 +79,7 @@ This will serve as the `client_id` when you make API calls to authenticate the u -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `kakao` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `kakao` as the `provider`: ```js async function signInWithKakao() { @@ -92,7 +92,7 @@ async function signInWithKakao() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `kakao` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `kakao` as the `provider`: ```dart Future signInWithKakao() async { diff --git a/apps/docs/content/guides/auth/social-login/auth-keycloak.mdx b/apps/docs/content/guides/auth/social-login/auth-keycloak.mdx index 06750243cb2..43b21bac65e 100644 --- a/apps/docs/content/guides/auth/social-login/auth-keycloak.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-keycloak.mdx @@ -10,16 +10,16 @@ To enable Keycloak Auth for your project, you need to set up an Keycloak OAuth a To get started with Keycloak, you can run it in a docker container with: `docker run -p 8080:8080 -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin quay.io/keycloak/keycloak:latest start-dev` -This guide will be assuming that you are running keycloak in a docker container as described in the command above. +This guide will be assuming that you are running Keycloak in a docker container as described in the command above. Keycloak OAuth consists of five broad steps: -- Create a new client in your specified keycloak realm. +- Create a new client in your specified Keycloak realm. - Obtain the `issuer` from the "OpenID Endpoint Configuration". This will be used as the `Keycloak URL`. -- Ensure that the new client has the "Client Protocol" set to "openid-connect" and the "Access Type" is set to "confidential". +- Ensure that the new client has the "Client Protocol" set to `openid-connect` and the "Access Type" is set to "confidential". - The `Client ID` of the client created will be used as the `client id`. - Obtain the `Secret` from the credentials tab which will be used as the `client secret`. -- Add the callback url of your application to your allowlist. +- Add the callback URL of your application to your allowlist. ## Access your Keycloak admin console @@ -43,7 +43,7 @@ The "Client ID" of the created client will serve as the `client_id` when you mak After you've created the client successfully, ensure that you set the following settings: -1. The "Client Protocol" should be set to "openid-connect". +1. The "Client Protocol" should be set to `openid-connect`. 2. The "Access Type" should be set to "confidential". 3. The "Valid Redirect URIs" should be set to: `https://.supabase.co/auth/v1/callback`. @@ -72,7 +72,7 @@ Since Keycloak version 22, the `openid` scope must be passed. Add this to the [` -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `keycloak` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `keycloak` as the `provider`: ```js async function signInWithKeycloak() { @@ -88,7 +88,7 @@ async function signInWithKeycloak() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `keycloak` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `keycloak` as the `provider`: ```dart Future signInWithKeycloak() async { @@ -163,5 +163,5 @@ suspend fun signOut() { ## Resources -- You can find the keycloak openid endpoint configuration under the realm settings. +- You can find the Keycloak OpenID endpoint configuration under the realm settings. ![Keycloak OpenID Endpoint Configuration](/docs/img/guides/auth-keycloak/keycloak-openid-endpoint-config.png) diff --git a/apps/docs/content/guides/auth/social-login/auth-linkedin.mdx b/apps/docs/content/guides/auth/social-login/auth-linkedin.mdx index d581605f2ef..0aa636294e1 100644 --- a/apps/docs/content/guides/auth/social-login/auth-linkedin.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-linkedin.mdx @@ -59,7 +59,7 @@ Ensure that the appropriate scopes have been added under OAuth 2.0 Scopes at the -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `linkedin_oidc` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `linkedin_oidc` as the `provider`: ```js async function signInWithLinkedIn() { @@ -72,7 +72,7 @@ async function signInWithLinkedIn() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `linkedin_oidc` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `linkedin_oidc` as the `provider`: ```dart Future signInWithLinkedIn() async { diff --git a/apps/docs/content/guides/auth/social-login/auth-notion.mdx b/apps/docs/content/guides/auth/social-login/auth-notion.mdx index 91674a09e1a..c542db2e633 100644 --- a/apps/docs/content/guides/auth/social-login/auth-notion.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-notion.mdx @@ -23,7 +23,7 @@ Setting up Notion logins for your application consists of 3 parts: - Once logged in, go to [notion.so/my-integrations](https://notion.so/my-integrations) and create a new integration. - When creating your integration, ensure that you select "Public integration" under "Integration type" and "Read user information including email addresses" under "Capabilities". -- You will need to add a redirect uri, see [Add the redirect uri](#add-the-redirect-uri) +- You will need to add a redirect URI, see [Add the redirect URI](#add-the-redirect-uri) - Once you've filled in the necessary fields, click "Submit" to finish creating the integration. ![notion.so](/docs/img/guides/auth-notion/notion-developer.png) @@ -57,7 +57,7 @@ Setting up Notion logins for your application consists of 3 parts: -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `notion` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `notion` as the `provider`: ```js async function signInWithNotion() { @@ -70,7 +70,7 @@ async function signInWithNotion() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `notion` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `notion` as the `provider`: ```dart Future signInWithNotion() async { diff --git a/apps/docs/content/guides/auth/social-login/auth-slack.mdx b/apps/docs/content/guides/auth/social-login/auth-slack.mdx index ea858493257..40d4bdce6ed 100644 --- a/apps/docs/content/guides/auth/social-login/auth-slack.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-slack.mdx @@ -75,7 +75,7 @@ Under `Scopes`: -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `slack_oidc` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `slack_oidc` as the `provider`: ```js async function signInWithSlack() { @@ -88,7 +88,7 @@ async function signInWithSlack() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `slack` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `slack` as the `provider`: ```dart Future signInWithSlack() async { diff --git a/apps/docs/content/guides/auth/social-login/auth-spotify.mdx b/apps/docs/content/guides/auth/social-login/auth-spotify.mdx index 987492dde18..fe0df251278 100644 --- a/apps/docs/content/guides/auth/social-login/auth-spotify.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-spotify.mdx @@ -69,7 +69,7 @@ The following outlines the steps to sign in using Spotify with Supabase Auth. -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `spotify` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `spotify` as the `provider`: ```js async function signInWithSpotify() { @@ -82,7 +82,7 @@ async function signInWithSpotify() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `spotify` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `spotify` as the `provider`: ```dart Future signInWithSpotify() async { diff --git a/apps/docs/content/guides/auth/social-login/auth-twitch.mdx b/apps/docs/content/guides/auth/social-login/auth-twitch.mdx index 97f17026a45..a1c2590143b 100644 --- a/apps/docs/content/guides/auth/social-login/auth-twitch.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-twitch.mdx @@ -41,7 +41,7 @@ Setting up Twitch logins for your application consists of 3 parts: - Enter the name of your application. - Type or paste your `OAuth Redirect URL` (the callback URL from the previous step.) - Select a category for your app. -- Check the Captcha box and click `Create`. +- Check the CAPTCHA box and click `Create`. ## Retrieve your Twitch OAuth client ID and client secret @@ -72,7 +72,7 @@ Setting up Twitch logins for your application consists of 3 parts: -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `twitch` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `twitch` as the `provider`: ```js async function signInWithTwitch() { @@ -85,7 +85,7 @@ async function signInWithTwitch() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `twitch` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `twitch` as the `provider`: ```dart Future signInWithTwitch() async { diff --git a/apps/docs/content/guides/auth/social-login/auth-twitter.mdx b/apps/docs/content/guides/auth/social-login/auth-twitter.mdx index 0cd3fe30edb..cf8e34c7531 100644 --- a/apps/docs/content/guides/auth/social-login/auth-twitter.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-twitter.mdx @@ -63,7 +63,7 @@ Setting up Twitter logins for your application consists of 3 parts: -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `twitter` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `twitter` as the `provider`: ```js async function signInWithTwitter() { @@ -76,7 +76,7 @@ async function signInWithTwitter() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `twitter` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `twitter` as the `provider`: ```dart Future signInWithTwitter() async { diff --git a/apps/docs/content/guides/auth/social-login/auth-workos.mdx b/apps/docs/content/guides/auth/social-login/auth-workos.mdx index 5e75b3c3e94..1abd6df0c0b 100644 --- a/apps/docs/content/guides/auth/social-login/auth-workos.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-workos.mdx @@ -50,7 +50,7 @@ On the redirects page, enter your Supabase project's `Callback URL (for OAuth)` ## Step 5. Add login code to your client app -When a user signs in, call signInWithOAuth with `workos` as the provider. +When a user signs in, call `signInWithOAuth` with `workos` as the provider. ```javascript async function signInWithWorkOS() { diff --git a/apps/docs/content/guides/auth/social-login/auth-zoom.mdx b/apps/docs/content/guides/auth/social-login/auth-zoom.mdx index e10102550cc..6c3b9f33531 100644 --- a/apps/docs/content/guides/auth/social-login/auth-zoom.mdx +++ b/apps/docs/content/guides/auth/social-login/auth-zoom.mdx @@ -70,7 +70,7 @@ Under `Scopes` -When your user signs in, call [signInWithOAuth()](/docs/reference/javascript/auth-signinwithoauth) with `zoom` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/javascript/auth-signinwithoauth) with `zoom` as the `provider`: ```js async function signInWithZoom() { @@ -83,7 +83,7 @@ async function signInWithZoom() { -When your user signs in, call [signInWithOAuth()](/docs/reference/dart/auth-signinwithoauth) with `zoom` as the `provider`: +When your user signs in, call [`signInWithOAuth()`](/docs/reference/dart/auth-signinwithoauth) with `zoom` as the `provider`: ```dart Future signInWithZoom() async { diff --git a/apps/docs/content/guides/auth/third-party/overview.mdx b/apps/docs/content/guides/auth/third-party/overview.mdx index 041be2090b4..568e5c1c314 100644 --- a/apps/docs/content/guides/auth/third-party/overview.mdx +++ b/apps/docs/content/guides/auth/third-party/overview.mdx @@ -12,7 +12,7 @@ Supabase has first-class support for these third-party authentication providers: You can use these providers alongside Supabase Auth, or on their own, to access the [Data API (REST and GraphQL)](/docs/guides/database), [Storage](/docs/guides/storage), [Realtime](/docs/guides/storage) and [Functions](/docs/guides/functions) from your existing apps. -If you already have production apps using one of these authentication providers, and would like to use a Supabase feature, you no longer need to migrate your users to Supabase Auth or use work-arounds like translating JWTs into the Supabase Auth format and using your project's signing secret. +If you already have production apps using one of these authentication providers, and would like to use a Supabase feature, you no longer need to migrate your users to Supabase Auth or use workarounds like translating JWTs into the Supabase Auth format and using your project's signing secret. ## How does it work? diff --git a/apps/docs/content/guides/auth/users.mdx b/apps/docs/content/guides/auth/users.mdx index 98786de022f..2b537566047 100644 --- a/apps/docs/content/guides/auth/users.mdx +++ b/apps/docs/content/guides/auth/users.mdx @@ -50,7 +50,7 @@ An identity describes the authentication method that a user can use to sign in. -A user with an email or phone identity will be able to sign in with either a password or passwordless method (e.g. use a one-time password (OTP) or magiclink). By default, a user with an unverified email or phone number will not be able to sign in. +A user with an email or phone identity will be able to sign in with either a password or passwordless method (e.g. use a one-time password (OTP) or magic link). By default, a user with an unverified email or phone number will not be able to sign in. diff --git a/apps/docs/content/guides/cron/install.mdx b/apps/docs/content/guides/cron/install.mdx index 736b8870c28..478bf9eec70 100644 --- a/apps/docs/content/guides/cron/install.mdx +++ b/apps/docs/content/guides/cron/install.mdx @@ -37,7 +37,7 @@ Uninstall Supabase Cron by disabling the `pg_cron` extension: drop extension if exists pg_cron; ``` - + Disabling the `pg_cron` extension will permanently delete all Jobs. diff --git a/apps/docs/content/guides/cron/quickstart.mdx b/apps/docs/content/guides/cron/quickstart.mdx index 782303b9d57..0ea18729a6a 100644 --- a/apps/docs/content/guides/cron/quickstart.mdx +++ b/apps/docs/content/guides/cron/quickstart.mdx @@ -204,7 +204,7 @@ select cron.alter_job( select cron.unschedule('permanent-cron-job-name'); ``` - + Unscheduling a Job will permanently delete the Job from `cron.job` table but its run history remain in `cron.job_run_details` table. @@ -246,7 +246,7 @@ order by start_time desc limit 10; ``` - + The records in the `cron.job_run_details` table are not cleaned up automatically. They are also not removed when jobs are unscheduled, which will take up disk space in your database. diff --git a/apps/docs/content/guides/database/arrays.mdx b/apps/docs/content/guides/database/arrays.mdx index a3b87c9248d..2fc92f3f019 100644 --- a/apps/docs/content/guides/database/arrays.mdx +++ b/apps/docs/content/guides/database/arrays.mdx @@ -132,9 +132,11 @@ supabase.from_('arraytest').insert( You should see: +``` | id | textarray | | --- | ----------------------- | | 1 | ["Harry","Larry","Moe"] | +``` @@ -145,9 +147,11 @@ select * from arraytest; You should see: +``` | id | textarray | | --- | ----------------------- | | 1 | ["Harry","Larry","Moe"] | +``` @@ -173,9 +177,11 @@ SELECT textarray[1], array_length(textarray, 1) FROM arraytest; returns: +``` | textarray | array_length | | --------- | ------------ | | Harry | 3 | +``` diff --git a/apps/docs/content/guides/database/connecting-to-postgres.mdx b/apps/docs/content/guides/database/connecting-to-postgres.mdx index 0dbb2ec3fd6..f0e14491f93 100644 --- a/apps/docs/content/guides/database/connecting-to-postgres.mdx +++ b/apps/docs/content/guides/database/connecting-to-postgres.mdx @@ -66,7 +66,7 @@ The direct connection string connects directly to your Postgres instance. It is -Direct connections use IPv6 by default. If your environment doesn't support IPv6, use [Supavisor session mode](#supavisor-session-mode) or get the [IPv4 addon](/docs/guides/platform/ipv4-address). +Direct connections use IPv6 by default. If your environment doesn't support IPv6, use [Supavisor session mode](#supavisor-session-mode) or get the [IPv4 add-on](/docs/guides/platform/ipv4-address). diff --git a/apps/docs/content/guides/database/connection-management.mdx b/apps/docs/content/guides/database/connection-management.mdx index 720f87700f3..099f934ba23 100644 --- a/apps/docs/content/guides/database/connection-management.mdx +++ b/apps/docs/content/guides/database/connection-management.mdx @@ -53,27 +53,27 @@ ON pg_stat_ssl.pid = pg_stat_activity.pid; Interpreting the query: -| Column | Description | -| ---------------- | ------------------------------------------------- | -| connection_id | connection id | -| ssl | Indicates if SSL is in use | -| database | Name of the connected database (usually postgres) | -| usename | Role of the connected user | -| application_name | Name of the connecting application | -| client_addr | IP address of the connecting server | -| query | Last query executed by the connection | -| query_start | Time when the last query was executed | -| state | Querying state: active or idle | -| backend_start | Timestamp of the connection's establishment | +| Column | Description | +| ------------------ | --------------------------------------------------- | +| `connection_id` | connection id | +| `ssl` | Indicates if SSL is in use | +| `database` | Name of the connected database (usually `postgres`) | +| `usename` | Role of the connected user | +| `application_name` | Name of the connecting application | +| `client_addr` | IP address of the connecting server | +| `query` | Last query executed by the connection | +| `query_start` | Time when the last query was executed | +| `state` | Querying state: active or idle | +| `backend_start` | Timestamp of the connection's establishment | -The usename can be used to identify the source: +The username can be used to identify the source: | Role | API/Tool | | ---------------------------- | ------------------------------------------------------------------------- | -| supabase_admin | Used by Supabase for monitoring and by Realtime | -| authenticator | Data API (PostgREST) | -| supabase_auth_admin | Auth | -| supabase_storage_admin | Storage | -| supabase_replication_admin | Synchronizes Read Replicas | -| postgres | Supabase Dashboard and External Tools (e.g., Prisma, SQLAlchemy, PSQL...) | +| `supabase_admin` | Used by Supabase for monitoring and by Realtime | +| `authenticator` | Data API (PostgREST) | +| `supabase_auth_admin` | Auth | +| `supabase_storage_admin` | Storage | +| `supabase_replication_admin` | Synchronizes Read Replicas | +| `postgres` | Supabase Dashboard and External Tools (e.g., Prisma, SQLAlchemy, PSQL...) | | Custom roles defined by user | External Tools (e.g., Prisma, SQLAlchemy, PSQL...) | diff --git a/apps/docs/content/guides/database/custom-postgres-config.mdx b/apps/docs/content/guides/database/custom-postgres-config.mdx index b5137339fd2..a4d84b971e1 100644 --- a/apps/docs/content/guides/database/custom-postgres-config.mdx +++ b/apps/docs/content/guides/database/custom-postgres-config.mdx @@ -61,7 +61,7 @@ Some settings can only be modified by a superuser. Supabase pre-enables the [`su | `session_replication_role` | Sets the session's behavior for triggers and rewrite rules. | | `track_io_timing` | Collects timing statistics for database I/O activity. | -For example, to enable `log_nested_statements` for the postgres role, execute: +For example, to enable `log_nested_statements` for the `postgres` role, execute: ```sql alter role "postgres" set "auto_explain.log_nested_statements" to 'on'; diff --git a/apps/docs/content/guides/database/extensions/http.mdx b/apps/docs/content/guides/database/extensions/http.mdx index e3a1e510cd7..0ee06be4321 100644 --- a/apps/docs/content/guides/database/extensions/http.mdx +++ b/apps/docs/content/guides/database/extensions/http.mdx @@ -46,7 +46,7 @@ You can use the `http` extension to make these network requests from Postgres. 1. Go to the [Database](https://supabase.com/dashboard/project/_/database/tables) page in the Dashboard. 2. Click on **Extensions** in the sidebar. -3. Search for "http" and enable the extension. +3. Search for `http` and enable the extension. diff --git a/apps/docs/content/guides/database/extensions/pg_hashids.mdx b/apps/docs/content/guides/database/extensions/pg_hashids.mdx index e53700420e1..07383d98c83 100644 --- a/apps/docs/content/guides/database/extensions/pg_hashids.mdx +++ b/apps/docs/content/guides/database/extensions/pg_hashids.mdx @@ -4,7 +4,7 @@ title: 'pg_hashids: Short UIDs' description: 'Generate Short UIDs from Numbers' --- -[pg_hashids](https://github.com/iCyberon/pg_hashids) provides a secure way to generate short, unique, non-sequential ids from numbers. The hashes are intended to be small, easy-to-remember identifiers that can be used to obfuscate data (optionally) with a password, alphabet, and salt. For example, you may wish to hide data like user IDs, order numbers, or tracking codes in favor of `pg_hashid`'s unique identifers. +[pg_hashids](https://github.com/iCyberon/pg_hashids) provides a secure way to generate short, unique, non-sequential ids from numbers. The hashes are intended to be small, easy-to-remember identifiers that can be used to obfuscate data (optionally) with a password, alphabet, and salt. For example, you may wish to hide data like user IDs, order numbers, or tracking codes in favor of `pg_hashid`'s unique identifiers. ## Enable the extension @@ -43,7 +43,7 @@ It's good practice to create the extension within a separate schema (like `exten ## Usage -Suppose we have a table that stores order information, and we want to give customers a unique identifer without exposing the sequential `id` column. To do this, we can use `pg_hashid`'s `id_encode` function. +Suppose we have a table that stores order information, and we want to give customers a unique identifier without exposing the sequential `id` column. To do this, we can use `pg_hashid`'s `id_encode` function. ```sql create table orders ( diff --git a/apps/docs/content/guides/database/extensions/pg_net.mdx b/apps/docs/content/guides/database/extensions/pg_net.mdx index 8855704fe94..bd477e4cdbf 100644 --- a/apps/docs/content/guides/database/extensions/pg_net.mdx +++ b/apps/docs/content/guides/database/extensions/pg_net.mdx @@ -435,7 +435,7 @@ More examples can be seen on the [Extension's GitHub page](https://github.com/su - Can only make POST requests with JSON data. No other data formats are supported - Intended to handle at most 200 requests per second. Increasing the rate can introduce instability - Does not have support for PATCH/PUT requests -- Can only work with one database at a time. It defaults to the postgres database. +- Can only work with one database at a time. It defaults to the `postgres` database. ## Resources diff --git a/apps/docs/content/guides/database/extensions/pg_stat_monitor.mdx b/apps/docs/content/guides/database/extensions/pg_stat_monitor.mdx index 843a7332e8e..015fd123142 100644 --- a/apps/docs/content/guides/database/extensions/pg_stat_monitor.mdx +++ b/apps/docs/content/guides/database/extensions/pg_stat_monitor.mdx @@ -56,21 +56,21 @@ select * from extensions.pg_stat_monitor; The following table shows a subset of available columns: -| Column Type | Description | -| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| bucket bigint | Data collection unit. The number shows what bucket in a chain a record belongs to | -| bucket_start_time timestampz | The start time of the bucket | -| userid oid (references pg_authid.oid) | OID of user who executed the statement | -| dbid oid (references pg_database.oid) | OID of database in which the statement was executed | -| toplevel bool | True if the query was executed as a top-level statement (always true if pg_stat_statements.track is set to top) | -| client_ip inet | The IP address of a client that ran the query | -| queryid bigint | Hash code to identify identical normalized queries. | -| planid text | An internally generated ID of a query plan | -| query_plan text | The sequence of steps used to execute a query. This parameter is only available when pgsm_enable_query_plan is enabled | -| query text | Text of a representative statement | -| plans bigint | Number of times the statement was planned (if pg_stat_statements.track_planning is enabled, otherwise zero) | -| total_plan_time double precision | Total time spent planning the statement, in milliseconds (if pg_stat_statements.track_planning is enabled, otherwise zero) | -| min_plan_time double precision | Minimum time spent planning the statement, in milliseconds (if pg_stat_statements.track_planning is enabled, otherwise zero) | +| Column Type | Description | +| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `bucket` `bigint` | Data collection unit. The number shows what bucket in a chain a record belongs to | +| `bucket_start_time` `timestampz` | The start time of the bucket | +| `userid` `oid` (references `pg_authid.oid`) | OID of user who executed the statement | +| `dbid` `oid` (references `pg_database.oid`) | OID of database in which the statement was executed | +| `toplevel` `bool` | True if the query was executed as a top-level statement (always true if pg_stat_statements.track is set to top) | +| `client_ip` `inet` | The IP address of a client that ran the query | +| `queryid` `bigint` | Hash code to identify identical normalized queries. | +| `planid` `text` | An internally generated ID of a query plan | +| `query_plan` `text` | The sequence of steps used to execute a query. This parameter is only available when pgsm_enable_query_plan is enabled | +| `query` `text` | Text of a representative statement | +| `plans` `bigint` | Number of times the statement was planned (if pg_stat_statements.track_planning is enabled, otherwise zero) | +| `total_plan_time` `double precision` | Total time spent planning the statement, in milliseconds (if pg_stat_statements.track_planning is enabled, otherwise zero) | +| `min_plan_time` `double precision` | Minimum time spent planning the statement, in milliseconds (if pg_stat_statements.track_planning is enabled, otherwise zero) | A full list of statistics is available in the [pg_stat_monitor docs](https://docs.percona.com/pg-stat-monitor/reference.html#postgresql-15). diff --git a/apps/docs/content/guides/database/extensions/pg_stat_statements.mdx b/apps/docs/content/guides/database/extensions/pg_stat_statements.mdx index 7c724c3199d..2259a0e62a5 100644 --- a/apps/docs/content/guides/database/extensions/pg_stat_statements.mdx +++ b/apps/docs/content/guides/database/extensions/pg_stat_statements.mdx @@ -6,16 +6,16 @@ description: 'Track planning and execution statistics of all SQL statements exec `pg_stat_statements` is a database extension that exposes a view, of the same name, to track statistics about SQL statements executed on the database. The following table shows some of the available statistics and metadata: -| Column Name | Column Type | Description | -| --------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| userid | oid (references pg_authid.oid) | OID of user who executed the statement | -| dbid | oid (references pg_database.oid) | OID of database in which the statement was executed | -| toplevel | bool | True if the query was executed as a top-level statement (always true if pg_stat_statements.track is set to top) | -| queryid | bigint | Hash code to identify identical normalized queries. | -| query | text | Text of a representative statement | -| plans | bigint | Number of times the statement was planned (if pg_stat_statements.track_planning is enabled, otherwise zero) | -| total_plan_time | double precision | Total time spent planning the statement, in milliseconds (if pg_stat_statements.track_planning is enabled, otherwise zero) | -| min_plan_time | double precision | Minimum time spent planning the statement, in milliseconds (if pg_stat_statements.track_planning is enabled, otherwise zero) | +| Column Name | Column Type | Description | +| ----------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| `userid` | `oid` (references `pg_authid.oid`) | OID of user who executed the statement | +| `dbid` | `oid` (references `pg_database.oid`) | OID of database in which the statement was executed | +| `toplevel` | `bool` | True if the query was executed as a top-level statement (always true if pg_stat_statements.track is set to top) | +| `queryid` | `bigint` | Hash code to identify identical normalized queries. | +| `query` | `text` | Text of a representative statement | +| `plans` | `bigint` | Number of times the statement was planned (if pg_stat_statements.track_planning is enabled, otherwise zero) | +| `total_plan_time` | `double precision` | Total time spent planning the statement, in milliseconds (if pg_stat_statements.track_planning is enabled, otherwise zero) | +| `min_plan_time` | `double precision` | Minimum time spent planning the statement, in milliseconds (if pg_stat_statements.track_planning is enabled, otherwise zero) | A full list of statistics is available in the [pg_stat_statements docs](https://www.postgresql.org/docs/current/pgstatstatements.html). diff --git a/apps/docs/content/guides/database/extensions/pgaudit.mdx b/apps/docs/content/guides/database/extensions/pgaudit.mdx index 50d890eabbf..6ea6bf78f9f 100644 --- a/apps/docs/content/guides/database/extensions/pgaudit.mdx +++ b/apps/docs/content/guides/database/extensions/pgaudit.mdx @@ -48,7 +48,7 @@ PGAudit can be configured with different levels of precision. **PGAudit logging precision:** - **[Session](#session-logging):** Logs activity within a connection, such as a [psql](https://supabase.com/docs/guides/database/connecting-to-postgres#connecting-with-psql) connection. -- **[User](#user-logging):** Logs activity by a particular database user (for example, anon or postgres). +- **[User](#user-logging):** Logs activity by a particular database user (for example, `anon` or `postgres`). - **[Global](#global-logging):** Logs activity across the entire database. - **[Object](#object-logging):** Logs events related to specific database objects (for example, the auth.users table). @@ -58,15 +58,15 @@ Although Session, User, and Global modes differ in their precision, they're all These modes can monitor predefined categories of database operations: -| Category | What it Logs | Description | -| -------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| read | Data retrieval (SELECT, COPY) | Tracks what data is being accessed. | -| write | Data modification (INSERT, DELETE, UPDATE, TRUNCATE, COPY) | Tracks changes made to your database. | -| function | FUNCTION, PROCEDURE, and DO/END block executions | Tracks routine/function executions | -| role | User management actions (CREATE, DROP, ALTER on users and privileges) | Tracks changes to user permissions and access. | -| ddl | Schema changes (CREATE, DROP, ALTER statements) | Monitors modifications to your database structure (tables, indexes, etc.). | -| misc | Less common commands (FETCH, CHECKPOINT) | Captures obscure actions for deeper analysis if needed. | -| all | Everything above | Comprehensive logging for complete audit trails. | +| Category | What it Logs | Description | +| ---------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `read` | Data retrieval (SELECT, COPY) | Tracks what data is being accessed. | +| `write` | Data modification (INSERT, DELETE, UPDATE, TRUNCATE, COPY) | Tracks changes made to your database. | +| `function` | FUNCTION, PROCEDURE, and DO/END block executions | Tracks routine/function executions | +| `role` | User management actions (CREATE, DROP, ALTER on users and privileges) | Tracks changes to user permissions and access. | +| `ddl` | Schema changes (CREATE, DROP, ALTER statements) | Monitors modifications to your database structure (tables, indexes, etc.). | +| `misc` | Less common commands (FETCH, CHECKPOINT) | Captures obscure actions for deeper analysis if needed. | +| `all` | Everything above | Comprehensive logging for complete audit trails. | Below is a limited example of how to assign PGAudit to monitor specific categories. @@ -148,13 +148,13 @@ Use global logging cautiously. It can generate many logs and make it difficult t -The below SQL configures PGAudit to record all events associated with the "postgres" role. Since it has extensive privileges, this effectively monitors all database activity. +The below SQL configures PGAudit to record all events associated with the `postgres` role. Since it has extensive privileges, this effectively monitors all database activity. ```sql alter role "postgres" set pgaudit.log to 'all'; ``` -To check if the postgres role is auditing, execute the following command: +To check if the `postgres` role is auditing, execute the following command: ```sql select @@ -279,7 +279,7 @@ API requests are already recorded in the [API Edge Network](https://supabase.com -To monitor all writes initiated by the Postgrest API roles: +To monitor all writes initiated by the PostgREST API roles: ```sql alter role "authenticator" set pgaudit.log to 'write'; @@ -383,7 +383,7 @@ PGAudit allows settings to be applied to 3 different database scopes: | Database | Specific database | ALTER DATABASE commands | | Role | Specific user/role | ALTER ROLE commands | -Supabase limits full privileges for file system and database variables, meaning PGAudit modifications can only occur at the role level. Assigning PGAudit to the 'postgres' role grants it nearly complete visibility into the database, making role-level adjustments a practical alternative to configuring at the database or system level. +Supabase limits full privileges for file system and database variables, meaning PGAudit modifications can only occur at the role level. Assigning PGAudit to the `postgres` role grants it nearly complete visibility into the database, making role-level adjustments a practical alternative to configuring at the database or system level. PGAudit's [official documentation](https://www.pgaudit.org) focuses on system and database level configs, but its docs officially supports role level configs, too. diff --git a/apps/docs/content/guides/database/extensions/postgis.mdx b/apps/docs/content/guides/database/extensions/postgis.mdx index d83e1066472..40da5901fe3 100644 --- a/apps/docs/content/guides/database/extensions/postgis.mdx +++ b/apps/docs/content/guides/database/extensions/postgis.mdx @@ -11,7 +11,7 @@ tocVideo: 'agFsGDJxjwA' While you may be able to store simple lat/long geographic coordinates as a set of decimals, it does not scale very well when you try to query through a large data set. PostGIS comes with special data types that are efficient, and indexable for high scalability. -The additional data types that PostGIS provides include [Point](https://postgis.net/docs/using_postgis_dbmanagement.html#Point), [Polygon](https://postgis.net/docs/using_postgis_dbmanagement.html#Polygon), [Linestring](https://postgis.net/docs/using_postgis_dbmanagement.html#LineString), and many more to represent different types of geographical data. In this guide, we will mainly focus on how to interact with `Point` type, which represents a single set of latitude and longitude. If you are interested in digging deeper, you can learn more about different data types on the [data management section of PostGIS docs](https://postgis.net/docs/using_postgis_dbmanagement.html). +The additional data types that PostGIS provides include [Point](https://postgis.net/docs/using_postgis_dbmanagement.html#Point), [Polygon](https://postgis.net/docs/using_postgis_dbmanagement.html#Polygon), [LineString](https://postgis.net/docs/using_postgis_dbmanagement.html#LineString), and many more to represent different types of geographical data. In this guide, we will mainly focus on how to interact with `Point` type, which represents a single set of latitude and longitude. If you are interested in digging deeper, you can learn more about different data types on the [data management section of PostGIS docs](https://postgis.net/docs/using_postgis_dbmanagement.html). ## Enable the extension @@ -28,7 +28,7 @@ You can get started with PostGIS by enabling the PostGIS extension in your Supab 1. Go to the [Database](https://supabase.com/dashboard/project/_/database/tables) page in the Dashboard. 2. Click on **Extensions** in the sidebar. -3. Search for "postgis" and enable the extension. +3. Search for `postgis` and enable the extension. 4. In the confirmation prompt select "Create a new schema" and name it `gis` for example. @@ -85,12 +85,16 @@ You can insert geographical data through SQL or through our API.

Restaurants

+{/* supa-mdx-lint-disable Rule003Spelling */} + | id | name | location | | --- | ----------- | -------------------------------- | | 1 | Supa Burger | lat: 40.807416, long: -73.946823 | | 2 | Supa Pizza | lat: 40.807475, long: -73.94581 | | 3 | Supa Taco | lat: 40.80629, long: -73.945826 | +{/* supa-mdx-lint-enable Rule003Spelling */} + @@ -438,7 +442,7 @@ The [official PostGIS documentation](https://postgis.net/documentation/tips/tip- -As of PostGIS 2.3 or newer, the PostGIS extension is no longer relocatable from one schema to another. If you need to move it from one schema to another for any reason (Eg. from the public schema to the extensions schema for security reasons), you would normally run a ALTER EXTENSION to relocate the schema. However, you will now to do the following steps: +As of PostGIS 2.3 or newer, the PostGIS extension is no longer relocatable from one schema to another. If you need to move it from one schema to another for any reason (e.g. from the public schema to the extensions schema for security reasons), you would normally run a ALTER EXTENSION to relocate the schema. However, you will now to do the following steps: 1. Backup your Database to prevent data loss - You can do this through the [CLI](https://supabase.com/docs/reference/cli/supabase-db-dump) or Postgres backup tools such as [pg_dumpall](https://www.postgresql.org/docs/current/backup-dump.html#BACKUP-DUMP-ALL) diff --git a/apps/docs/content/guides/database/extensions/rum.mdx b/apps/docs/content/guides/database/extensions/rum.mdx index c95943e0202..4185efebd3b 100644 --- a/apps/docs/content/guides/database/extensions/rum.mdx +++ b/apps/docs/content/guides/database/extensions/rum.mdx @@ -4,7 +4,7 @@ title: 'RUM: improved inverted index for full-text search based on GIN index' description: 'A GIN-like index with additional tree-organized data for each index entry' --- -[RUM](https://github.com/postgrespro/rum) is an extension which adds a RUM index to Postgresql. +[RUM](https://github.com/postgrespro/rum) is an extension which adds a RUM index to Postgres. RUM index is based on GIN that stores additional per-entry information in a posting tree. For example, positional information of lexemes or timestamps. In comparison to GIN it can use this information to make faster index-only scans for: @@ -18,10 +18,10 @@ combinations or phrases. Main operators for ordering are: -tsvector `<=>` tsquery | float4 | Distance between tsvector and tsquery. -value `<=>` value | float8 | Distance between two values. +`tsvector` `<=>` `tsquery` | `float4` | Distance between `tsvector` and `tsquery`. +value `<=>` value | `float8` | Distance between two values. -Where value is timestamp, timestamptz, int2, int4, int8, float4, float8, money and oid +Where value is `timestamp`, `timestamptz`, `int2`, `int4`, `int8`, `float4`, `float8`, `money` and `oid` ## Usage @@ -120,7 +120,7 @@ SELECT id, d, d `<=>` '2016-05-16 14:21:25' FROM tsts WHERE t @@ 'wr&qh' ORDER B `rum_anyarray_ops` -This operator class stores anyarray elements with length of the array. It supports operators `&&`, `@>`, `<@`, `=`, `%` operators. It also supports ordering by `<=>` operator. +This operator class stores `anyarray` elements with length of the array. It supports operators `&&`, `@>`, `<@`, `=`, `%` operators. It also supports ordering by `<=>` operator. ```sql CREATE TABLE test_array (i int2[]); @@ -143,7 +143,7 @@ SELECT * FROM test_array WHERE i && '{1}' ORDER BY i `<=>` '{1}' ASC; `rum_anyarray_addon_ops` -The does the same with anyarray index as `rum_tsvector_addon_ops` i.e. allows to order select results using distance +The does the same with `anyarray` index as `rum_tsvector_addon_ops` i.e. allows to order select results using distance operator by attached column. ## Limitations diff --git a/apps/docs/content/guides/database/extensions/timescaledb.mdx b/apps/docs/content/guides/database/extensions/timescaledb.mdx index a97dd8260af..53277248488 100644 --- a/apps/docs/content/guides/database/extensions/timescaledb.mdx +++ b/apps/docs/content/guides/database/extensions/timescaledb.mdx @@ -4,7 +4,7 @@ title: 'timescaledb: Time-Series data' description: 'Scalable time-series data storage and analysis' --- -[timescaledb](https://docs.timescale.com/timescaledb/latest/) is a PostgreSQL extension designed for improved handling of time-series data. It provides a scalable, high-performance solution for storing and querying time-series data on top of a standard PostgreSQL database. +[`timescaledb`](https://docs.timescale.com/timescaledb/latest/) is a PostgreSQL extension designed for improved handling of time-series data. It provides a scalable, high-performance solution for storing and querying time-series data on top of a standard PostgreSQL database. `timescaledb` uses a time-series-aware storage model and indexing techniques to improve performance of PostgreSQL in working with time-series data. The extension divides data into chunks based on time intervals, allowing it to scale efficiently, especially for large data sets. The data is then compressed, optimized for write-heavy workloads, and partitioned for parallel processing. `timescaledb` also includes a set of functions, operators, and indexes that work with time-series data to reduce query times, and make data easier to work with. @@ -27,7 +27,7 @@ Supabase projects come with [TimescaleDB Apache 2 Edition](https://docs.timescal 1. Go to the [Database](https://supabase.com/dashboard/project/_/database/tables) page in the Dashboard. 2. Click on **Extensions** in the sidebar. -3. Search for "timescaledb" and enable the extension. +3. Search for `timescaledb` and enable the extension. diff --git a/apps/docs/content/guides/database/extensions/uuid-ossp.mdx b/apps/docs/content/guides/database/extensions/uuid-ossp.mdx index 4fd6e9e3495..48e8ce2945e 100644 --- a/apps/docs/content/guides/database/extensions/uuid-ossp.mdx +++ b/apps/docs/content/guides/database/extensions/uuid-ossp.mdx @@ -27,7 +27,7 @@ Currently `uuid-ossp` extension is enabled by default and cannot be disabled. 1. Go to the [Database](https://supabase.com/dashboard/project/_/database/tables) page in the Dashboard. 2. Click on **Extensions** in the sidebar. -3. Search for "uuid-ossp" and enable the extension. +3. Search for `uuid-ossp` and enable the extension. diff --git a/apps/docs/content/guides/database/full-text-search.mdx b/apps/docs/content/guides/database/full-text-search.mdx index 0975aa2fe04..004d8fe9b1f 100644 --- a/apps/docs/content/guides/database/full-text-search.mdx +++ b/apps/docs/content/guides/database/full-text-search.mdx @@ -30,7 +30,7 @@ For this guide we'll use the following example data: > -{/* */} +{/* supa-mdx-lint-disable Rule003Spelling */} | id | title | author | description | | --- | ----------------------------------- | ---------------------- | ------------------------------------------------------------------ | @@ -40,7 +40,7 @@ For this guide we'll use the following example data: | 4 | Green Eggs and Ham | Dr. Seuss | Sam has changing food preferences and eats unusually colored food. | | 5 | Harry Potter and the Goblet of Fire | J.K. Rowling | Fourth year of school starts, big drama ensues. | -{/* */} +{/* supa-mdx-lint-enable Rule003Spelling */} @@ -301,14 +301,14 @@ data = supabase.from_('books').select().text_search('description', "'big'").exec -{/* */} +{/* supa-mdx-lint-disable Rule003Spelling */} | id | title | author | description | | --- | ----------------------------------- | ----------------- | ----------------------------------------------- | | 3 | Tootle | Gertrude Crampton | Little toy train has big dreams. | | 5 | Harry Potter and the Goblet of Fire | J.K. Rowling | Fourth year of school starts, big drama ensues. | -{/* */} +{/* supa-mdx-lint-enable Rule003Spelling */} @@ -420,14 +420,14 @@ data = supabase.from_('books').select().text_search('title_description', "little -{/* */} +{/* supa-mdx-lint-disable Rule003Spelling */} | id | title | author | description | | --- | --------------------- | ---------------------- | ------------------------------------------- | | 1 | The Poky Little Puppy | Janette Sebring Lowrey | Puppy is slower than other, bigger animals. | | 3 | Tootle | Gertrude Crampton | Little toy train has big dreams. | -{/* */} +{/* supa-mdx-lint-enable Rule003Spelling */} @@ -507,13 +507,13 @@ data = supabase.from_('books').select().text_search('description', "'little' & ' -{/* */} +{/* supa-mdx-lint-disable Rule003Spelling */} | id | title | author | description | | --- | ------ | ----------------- | -------------------------------- | | 3 | Tootle | Gertrude Crampton | Little toy train has big dreams. | -{/* */} +{/* supa-mdx-lint-enable Rule003Spelling */} @@ -593,14 +593,14 @@ response = client.from_('books').select().text_search('description', "'little' | -{/* */} +{/* supa-mdx-lint-disable Rule003Spelling */} | id | title | author | description | | --- | --------------------- | ---------------------- | ------------------------------------------- | | 1 | The Poky Little Puppy | Janette Sebring Lowrey | Puppy is slower than other, bigger animals. | | 3 | Tootle | Gertrude Crampton | Little toy train has big dreams. | -{/* */} +{/* supa-mdx-lint-enable Rule003Spelling */} @@ -699,7 +699,7 @@ select * from search_books_by_title_prefix('Little+Puppy'); ## Creating indexes -Now that we have Full Text Search working, let's create an `index`. This will allow Postgres to "build" the documents pre-emptively so that they +Now that we have Full Text Search working, let's create an `index`. This will allow Postgres to "build" the documents preemptively so that they don't need to be created at the time we execute the query. This will make our queries much faster. ### Searchable columns @@ -734,8 +734,7 @@ from books; -{/* */} - +``` | id | fts | | --- | --------------------------------------------------------------------------------------------------------------- | | 1 | 'anim':7 'bigger':6 'littl':10 'poki':9 'puppi':1,11 'slower':3 | @@ -743,8 +742,7 @@ from books; | 3 | 'big':5 'dream':6 'littl':1 'tootl':7 'toy':2 'train':3 | | 4 | 'chang':3 'color':9 'eat':7 'egg':12 'food':4,10 'green':11 'ham':14 'prefer':5 'sam':1 'unus':8 | | 5 | 'big':6 'drama':7 'ensu':8 'fire':15 'fourth':1 'goblet':13 'harri':9 'potter':10 'school':4 'start':5 'year':2 | - -{/* */} +``` @@ -820,13 +818,13 @@ data = client.from_('books').select().text_search('fts', "'little' & 'big'").exe -{/* */} +{/* supa-mdx-lint-disable Rule003Spelling */} | id | title | author | description | fts | | --- | ------ | ----------------- | -------------------------------- | ------------------------------------------------------- | | 3 | Tootle | Gertrude Crampton | Little toy train has big dreams. | 'big':5 'dream':6 'littl':1 'tootl':7 'toy':2 'train':3 | -{/* */} +{/* supa-mdx-lint-enable Rule003Spelling */} diff --git a/apps/docs/content/guides/database/functions.mdx b/apps/docs/content/guides/database/functions.mdx index eb2b1a6b84e..58883b17e81 100644 --- a/apps/docs/content/guides/database/functions.mdx +++ b/apps/docs/content/guides/database/functions.mdx @@ -82,7 +82,7 @@ select hello_world(); const { data, error } = await supabase.rpc('hello_world') ``` -Reference: [rpc()](../../reference/javascript/rpc) +Reference: [`rpc()`](../../reference/javascript/rpc) @@ -92,7 +92,7 @@ final data = await supabase .rpc('hello_world'); ``` -Reference: [rpc()](../../reference/dart/rpc) +Reference: [`rpc()`](../../reference/dart/rpc) @@ -101,7 +101,7 @@ Reference: [rpc()](../../reference/dart/rpc) try await supabase.rpc("hello_world").execute() ``` -Reference: [rpc()](../../reference/swift/rpc) +Reference: [`rpc()`](../../reference/swift/rpc) @@ -110,7 +110,7 @@ Reference: [rpc()](../../reference/swift/rpc) val data = supabase.postgrest.rpc("hello_world") ``` -Reference: [rpc()](../../reference/kotlin/rpc) +Reference: [`rpc()`](../../reference/kotlin/rpc) @@ -119,7 +119,7 @@ Reference: [rpc()](../../reference/kotlin/rpc) data = supabase.rpc('hello_world').execute() ``` -Reference: [rpc()](../../reference/python/rpc) +Reference: [`rpc()`](../../reference/python/rpc) @@ -141,20 +141,24 @@ For example, if we had a database with some Star Wars data inside:

Planets

+``` | id | name | | --- | -------- | | 1 | Tatooine | | 2 | Alderaan | | 3 | Kashyyyk | +```

People

+``` | id | name | planet_id | | --- | ---------------- | --------- | | 1 | Anakin Skywalker | 1 | | 2 | Luke Skywalker | 1 | | 3 | Princess Leia | 2 | | 4 | Chewbacca | 3 | +``` diff --git a/apps/docs/content/guides/database/inspect.mdx b/apps/docs/content/guides/database/inspect.mdx index 4552a1697e5..7ac90292f7a 100644 --- a/apps/docs/content/guides/database/inspect.mdx +++ b/apps/docs/content/guides/database/inspect.mdx @@ -49,7 +49,7 @@ Then the CLI will automatically connect to your Supabase project whenever you ar ## Inspection commands -Below are the db inspection commands provided, grouped by different use cases. +Below are the `db` inspection commands provided, grouped by different use cases. @@ -99,4 +99,4 @@ Learn more about pg_stats [here](https://supabase.com/docs/guides/database/exten ## Acknowledgements -Supabase CLI's inspect commands are heavily inspired by the pg-extras tools. +Supabase CLI's inspect commands are heavily inspired by the `pg-extras` tools. diff --git a/apps/docs/content/guides/database/json.mdx b/apps/docs/content/guides/database/json.mdx index a1195bfe912..5a067043f46 100644 --- a/apps/docs/content/guides/database/json.mdx +++ b/apps/docs/content/guides/database/json.mdx @@ -117,6 +117,8 @@ values 2. Select the `books` table in the sidebar. 3. Click **+ Insert row** and add 5 rows with the following properties: +{/* supa-mdx-lint-disable Rule003Spelling */} + | id | title | author | metadata | | --- | ----------------------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------- | | 1 | The Poky Little Puppy | Janette Sebring Lowrey | `json {"ages":[3,6],"price":5.95,"description":"Puppy is slower than other, bigger animals."}` | @@ -125,6 +127,8 @@ values | 4 | Green Eggs and Ham | Dr. Seuss | `json {"ages":[4,8],"price":7.49,"description":"Sam has changing food preferences and eats unusually colored food."}` | | 5 | Harry Potter and the Goblet of Fire | J.K. Rowling | `json {"ages":[10,99],"price":24.95,"description":"Fourth year of school starts, big drama ensues."}` | +{/* supa-mdx-lint-enable Rule003Spelling */} + diff --git a/apps/docs/content/guides/database/orioledb.mdx b/apps/docs/content/guides/database/orioledb.mdx index ba8e3279502..a83faabf945 100644 --- a/apps/docs/content/guides/database/orioledb.mdx +++ b/apps/docs/content/guides/database/orioledb.mdx @@ -15,7 +15,7 @@ OrioleDB addresses PostgreSQL's scalability limitations by removing bottlenecks zoomable /> - + OrioleDB is in active development and currently has [certain limitations](https://www.orioledb.com/docs/usage/getting-started#current-limitations). Currently, only B-tree indexes are supported, so features like pg_vector's HNSW indexes are not yet available. An Index Access Method bridge to unlock support for all index types used with heap storage is under active development. In the Supabase OrioleDB image the default storage method has been updated to use OrioleDB, granting better performance out of the box. @@ -78,7 +78,7 @@ create table blog_post ( OrioleDB tables always have a primary key. If it wasn't defined explicitly, a hidden primary key is created using the `ctid` column. Additionally you can create secondary indexes. - + Currently, only B-tree indexes are supported, so features like pg_vector's HNSW indexes are not yet available. diff --git a/apps/docs/content/guides/database/pgadmin.mdx b/apps/docs/content/guides/database/pgadmin.mdx index 99297520d89..7608ad02112 100644 --- a/apps/docs/content/guides/database/pgadmin.mdx +++ b/apps/docs/content/guides/database/pgadmin.mdx @@ -70,7 +70,7 @@ hideToc: true Download your SSL certificate from Dashboard's [`Database Settings`](https://supabase.com/dashboard/project/_/settings/database). - In pgAdmin, navigate to the Parameters tab and select connection parameter as Root Certificate. Next navigate to the Root certificate input, it will open up a file-picker modal. Select the certificate you downloaded earlier and save the server details. PgAdmin should now be able to connect to your Postgres via SSL. + In pgAdmin, navigate to the Parameters tab and select connection parameter as Root Certificate. Next navigate to the Root certificate input, it will open up a file-picker modal. Select the certificate you downloaded earlier and save the server details. pgAdmin should now be able to connect to your Postgres via SSL. diff --git a/apps/docs/content/guides/database/postgres/custom-claims-and-role-based-access-control-rbac.mdx b/apps/docs/content/guides/database/postgres/custom-claims-and-role-based-access-control-rbac.mdx index a63886037f3..e5ff8ea539b 100644 --- a/apps/docs/content/guides/database/postgres/custom-claims-and-role-based-access-control-rbac.mdx +++ b/apps/docs/content/guides/database/postgres/custom-claims-and-role-based-access-control-rbac.mdx @@ -267,7 +267,7 @@ const { subscription: authListener } = supabase.auth.onAuthStateChange(async (ev }) ``` -For server-side logic you can use packages like [express-jwt](https://github.com/auth0/express-jwt), [koa-jwt](https://github.com/stiang/koa-jwt), [PyJWT](https://github.com/jpadilla/pyjwt), [dart_jsonwebtoken](https://pub.dev/packages/dart_jsonwebtoken), [Microsoft.AspNetCore.Authentication.JwtBearer](https://www.nuget.org/packages/Microsoft.AspNetCore.Authentication.JwtBearer), etc. +For server-side logic you can use packages like [`express-jwt`](https://github.com/auth0/express-jwt), [`koa-jwt`](https://github.com/stiang/koa-jwt), [`PyJWT`](https://github.com/jpadilla/pyjwt), [dart_jsonwebtoken](https://pub.dev/packages/dart_jsonwebtoken), [Microsoft.AspNetCore.Authentication.JwtBearer](https://www.nuget.org/packages/Microsoft.AspNetCore.Authentication.JwtBearer), etc. ## Conclusion diff --git a/apps/docs/content/guides/database/postgres/indexes.mdx b/apps/docs/content/guides/database/postgres/indexes.mdx index c8d96b6cbb9..acbbff3daf4 100644 --- a/apps/docs/content/guides/database/postgres/indexes.mdx +++ b/apps/docs/content/guides/database/postgres/indexes.mdx @@ -26,7 +26,7 @@ create table persons ( ); ``` - + All the queries in this guide can be run using the [SQL Editor](https://supabase.com/dashboard/project/_/sql) in the Supabase Dashboard, or via `psql` if you're [connecting directly to the database](/docs/guides/database/connecting-to-postgres#direct-connections). diff --git a/apps/docs/content/guides/database/postgres/roles.mdx b/apps/docs/content/guides/database/postgres/roles.mdx index 7a36f2761d7..39b160e17e0 100644 --- a/apps/docs/content/guides/database/postgres/roles.mdx +++ b/apps/docs/content/guides/database/postgres/roles.mdx @@ -38,13 +38,13 @@ Your Postgres database is the core of your Supabase project, so it's important t ### Special symbols in passwords -If you use special symbols in your postgres password, you must remember to [percent-encode](https://en.wikipedia.org/wiki/Percent-encoding) your password later if using the postgres connection string, for example, `postgresql://postgres.projectref:p%3Dword@aws-0-us-east-1.pooler.supabase.com:6543/postgres` +If you use special symbols in your Postgres password, you must remember to [percent-encode](https://en.wikipedia.org/wiki/Percent-encoding) your password later if using the Postgres connection string, for example, `postgresql://postgres.projectref:p%3Dword@aws-0-us-east-1.pooler.supabase.com:6543/postgres` ### Changing your project password When you created your project you were also asked to enter a password. This is actually the password for the `postgres` role in your database. You can update this from the Dashboard under the [database settings](https://supabase.com/dashboard/project/_/settings/database) page. You should _never_ give this to third-party service unless you absolutely trust them. Instead, we recommend that you create a new user for every service that you want to give access too. This will also help you with debugging - you can see every query that each role is executing in your database within `pg_stat_statements`. -Changing the password does not result in any downtime. All connected services, such as postgrest, pgbouncer, and other Supabase managed services, are automatically updated to use the latest password to ensure availability. However, if you have any external services connecting to the Supabase database using hardcoded username/password credentials, a manual update will be required. +Changing the password does not result in any downtime. All connected services, such as PostgREST, PgBouncer, and other Supabase managed services, are automatically updated to use the latest password to ensure availability. However, if you have any external services connecting to the Supabase database using hardcoded username/password credentials, a manual update will be required. ## Granting permissions @@ -72,7 +72,7 @@ create role "child_role_name" inherit "parent_role_name"; ### Preventing inheritance -In some cases, you might want to prevent a role from having a child relationship (typically superuser roles). You can prevent inheritance relations using NOINHERIT: +In some cases, you might want to prevent a role from having a child relationship (typically superuser roles). You can prevent inheritance relations using `NOINHERIT`: ```sql alter role "child_role_name" noinherit; diff --git a/apps/docs/content/guides/database/postgres/row-level-security.mdx b/apps/docs/content/guides/database/postgres/row-level-security.mdx index 26ced6b8455..683fc7e1e5f 100644 --- a/apps/docs/content/guides/database/postgres/row-level-security.mdx +++ b/apps/docs/content/guides/database/postgres/row-level-security.mdx @@ -13,7 +13,7 @@ RLS is incredibly powerful and flexible, allowing you to write complex SQL rules RLS is a Postgres primitive and can provide "[defense in depth]()" to protect your data from malicious actors even when accessed through third-party tooling. - + You should _always_ enable RLS on tables created in a public schema. This is done for you when you create a table with the Table Editor. If you create one in raw SQL or with the SQL Editor, remember to enable RLS yourself. diff --git a/apps/docs/content/guides/database/postgres/setup-replication-external.mdx b/apps/docs/content/guides/database/postgres/setup-replication-external.mdx index 5418c47051a..8621755ff4f 100644 --- a/apps/docs/content/guides/database/postgres/setup-replication-external.mdx +++ b/apps/docs/content/guides/database/postgres/setup-replication-external.mdx @@ -25,7 +25,7 @@ select pg_create_logical_replication_slot('example_slot', 'pgoutput'); 3. Now we will connect to our **external database** and subscribe to our `publication` Note: ): - + This will need a direct connection to your database and you can find the connection info in the [Dashboard](https://supabase.com/dashboard/project/_/settings/database). @@ -42,7 +42,7 @@ PUBLICATION example_pub WITH (copy_data = true, create_slot=false, slot_name=example_slot); ``` - + `create_slot` is set to `false` because `slot_name` is provided and the slot was already created in Step 2. To copy data from before the slot was created, set `copy_data` to `true`. diff --git a/apps/docs/content/guides/database/postgres/timeouts.mdx b/apps/docs/content/guides/database/postgres/timeouts.mdx index 9033debd47f..88d7fdc359a 100644 --- a/apps/docs/content/guides/database/postgres/timeouts.mdx +++ b/apps/docs/content/guides/database/postgres/timeouts.mdx @@ -71,8 +71,7 @@ alter role example_role set statement_timeout = '10min'; -- could also use secon ``` - If you are changing the timeout for the Supabase Client API calls, you will need to reload - postgREST to reflect the timeout changes by running the following script: + If you are changing the timeout for the Supabase Client API calls, you will need to reload PostgREST to reflect the timeout changes by running the following script: ```sql NOTIFY pgrst, 'reload config'; @@ -161,16 +160,16 @@ Go to the [Query Performance page](/dashboard/project/_/advisors/query-performan Each API server uses a designated user for connecting to the database: -| Role | API/Tool | -| -------------------------- | ------------------------------------------------------------------------- | -| supabase_admin | Used by Supabase to configure projects and for monitoring | -| authenticator | PostgREST | -| supabase_auth_admin | Auth | -| supabase_storage_admin | Storage | -| supabase_realtime_admin | Realtime | -| supabase_replication_admin | Synchronizes Read Replicas | -| postgres | Supabase Dashboard and External Tools (e.g., Prisma, SQLAlchemy, PSQL...) | -| Custom roles | External Tools (e.g., Prisma, SQLAlchemy, PSQL...) | +| Role | API/Tool | +| ---------------------------- | ------------------------------------------------------------------------- | +| `supabase_admin` | Used by Supabase to configure projects and for monitoring | +| `authenticator` | PostgREST | +| `supabase_auth_admin` | Auth | +| `supabase_storage_admin` | Storage | +| `supabase_realtime_admin` | Realtime | +| `supabase_replication_admin` | Synchronizes Read Replicas | +| `postgres` | Supabase Dashboard and External Tools (e.g., Prisma, SQLAlchemy, PSQL...) | +| Custom roles | External Tools (e.g., Prisma, SQLAlchemy, PSQL...) | Filter by the `parsed.user_name` field to only retrieve logs made by specific users: diff --git a/apps/docs/content/guides/database/prisma.mdx b/apps/docs/content/guides/database/prisma.mdx index 2f95850a507..737ce4f6e01 100644 --- a/apps/docs/content/guides/database/prisma.mdx +++ b/apps/docs/content/guides/database/prisma.mdx @@ -17,7 +17,7 @@ If you plan to solely use Prisma instead of the Supabase Data API (PostgREST), t - - In the [SQL Editor](https://supabase.com/dashboard/project/_/sql/new), create a Prisma db-user with full privileges on the public schema. + - In the [SQL Editor](https://supabase.com/dashboard/project/_/sql/new), create a Prisma DB user with full privileges on the public schema. - This gives you better control over Prisma's access and makes it easier to monitor using Supabase tools like the [Query Performance Dashboard](https://supabase.com/dashboard/project/_/advisors/query-performance) and [Log Explorer](https://supabase.com/dashboard/project/_/logs/explorer). @@ -56,7 +56,7 @@ If you plan to solely use Prisma instead of the Supabase Data API (PostgREST), t - Create a new prisma Project on your computer + Create a new Prisma Project on your computer @@ -166,7 +166,7 @@ If you plan to solely use Prisma instead of the Supabase Data API (PostgREST), t postgres://prisma.[PROJECT-REF]... ``` - In your schema.prisma file, edit your datasource db configs to reference your DIRECT_URL + In your schema.prisma file, edit your `datasource db` configs to reference your DIRECT_URL ```text schema.prisma datasource db { provider = "postgresql" @@ -269,7 +269,7 @@ If you plan to solely use Prisma instead of the Supabase Data API (PostgREST), t npx prisma db pull ``` - Create a migraton file + Create a migration file ```bash mkdir -p prisma/migrations/0_init_supabase ``` @@ -295,7 +295,7 @@ If you plan to solely use Prisma instead of the Supabase Data API (PostgREST), t pnpx prisma db pull ``` - Create a migraton file + Create a migration file ```bash mkdir -p prisma/migrations/0_init_supabase ``` @@ -321,7 +321,7 @@ If you plan to solely use Prisma instead of the Supabase Data API (PostgREST), t yarn dlx prisma db pull ``` - Create a migraton file + Create a migration file ```bash mkdir -p prisma/migrations/0_init_supabase ``` @@ -347,7 +347,7 @@ If you plan to solely use Prisma instead of the Supabase Data API (PostgREST), t bunx prisma db pull ``` - Create a migraton file + Create a migration file ```bash mkdir -p prisma/migrations/0_init_supabase ``` @@ -378,7 +378,7 @@ If you plan to solely use Prisma instead of the Supabase Data API (PostgREST), t - Install the prisma client and generate its model + Install the Prisma client and generate its model diff --git a/apps/docs/content/guides/database/supavisor.mdx b/apps/docs/content/guides/database/supavisor.mdx index 007e57e7dcf..1ee0aedd6df 100644 --- a/apps/docs/content/guides/database/supavisor.mdx +++ b/apps/docs/content/guides/database/supavisor.mdx @@ -5,13 +5,13 @@ subtitle: Troubleshooting Supavisor errors Supavisor logs are available under [Pooler Logs](/dashboard/project/_/logs/pooler-logs) in the Dashboard. The following are common errors and their solutions: -| Error Type | Description | Resolution Link | -| ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| Max client connections reached | This error happens when the number of connections to Supavisor is more than [the allowed limit of your compute add-on](https://supabase.com/docs/guides/platform/compute-add-ons). | Follow this [guide](https://github.com/orgs/supabase/discussions/22305) to resolve. | -| Connection failed \{:error, :eaddrnotavail} to 'db.xxx.supabase.co':5432 | Supavisor cannot connect to the customer database. This is usually caused if the target database is unable to respond. | N/A | -| Connection failed \{:error, :nxdomain} to 'db.xxx.supabase.co':5432 | Supavisor cannot connect to the customer database. This is usually caused if the target database is unable to respond. | N/A | -| Connection closed when state was authentication | This error happens when either the database doesn’t exist or if the user doesn't have the right credentials. | N/A | -| Subscribe error: \{:error, :worker_not_found} | This log event is emitted when the client tries to connect to the database, but Supavisor does not have the necessary information to route the connection. Try reconnecting to the database as it can take some time for the project information to propagate to Supavisor. | N/A | -| Subscribe error: \{:error, \{:badrpc, \{:error, \{:erpc, :timeout}}}} | This is a timeout error when the communication between different Supavisor nodes takes longer than expected. Try reconnecting to the database. | N/A | -| Terminating with reason :client_termination when state was :busy | This error happens when the client terminates the connection before the connection with the database is completed. | N/A | -| Error: received invalid response to GSSAPI negotiation: S | This error happens due to "gssencmode" parameter not set to disabled. | Follow this [guide](https://github.com/orgs/supabase/discussions/30173) to resolve. | +| Error Type | Description | Resolution Link | +| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| Max client connections reached | This error happens when the number of connections to Supavisor is more than [the allowed limit of your compute add-on](https://supabase.com/docs/guides/platform/compute-add-ons). | Follow this [guide](https://github.com/orgs/supabase/discussions/22305) to resolve. | +| Connection failed `{:error, :eaddrnotavail}` to 'db.xxx.supabase.co':5432 | Supavisor cannot connect to the customer database. This is usually caused if the target database is unable to respond. | N/A | +| Connection failed `{:error, :nxdomain}` to 'db.xxx.supabase.co':5432 | Supavisor cannot connect to the customer database. This is usually caused if the target database is unable to respond. | N/A | +| Connection closed when state was authentication | This error happens when either the database doesn’t exist or if the user doesn't have the right credentials. | N/A | +| Subscribe error: `{:error, :worker_not_found}` | This log event is emitted when the client tries to connect to the database, but Supavisor does not have the necessary information to route the connection. Try reconnecting to the database as it can take some time for the project information to propagate to Supavisor. | N/A | +| Subscribe error: `{:error, {:badrpc, {:error, {:erpc, :timeout}}}}` | This is a timeout error when the communication between different Supavisor nodes takes longer than expected. Try reconnecting to the database. | N/A | +| Terminating with reason :client_termination when state was :busy | This error happens when the client terminates the connection before the connection with the database is completed. | N/A | +| Error: received invalid response to GSSAPI negotiation: S | This error happens due to `gssencmode` parameter not set to disabled. | Follow this [guide](https://github.com/orgs/supabase/discussions/30173) to resolve. | diff --git a/apps/docs/content/guides/database/tables.mdx b/apps/docs/content/guides/database/tables.mdx index 71a2d2c8fcd..285e33feceb 100644 --- a/apps/docs/content/guides/database/tables.mdx +++ b/apps/docs/content/guides/database/tables.mdx @@ -10,6 +10,8 @@ Tables are where you store your data. Tables are similar to excel spreadsheets. They contain columns and rows. For example, this table has 3 "columns" (`id`, `name`, `description`) and 4 "rows" of data: +{/* supa-mdx-lint-disable Rule003Spelling */} + | `id` | `name` | `description` | | ---- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 1 | The Phantom Menace | Two Jedi escape a hostile blockade to find allies and come across a young boy who may bring balance to the Force. | @@ -17,6 +19,8 @@ For example, this table has 3 "columns" (`id`, `name`, `description`) and 4 "row | 3 | Revenge of the Sith | As Obi-Wan pursues a new threat, Anakin acts as a double agent between the Jedi Council and Palpatine and is lured into a sinister plan to rule the galaxy. | | 4 | Star Wars | Luke Skywalker joins forces with a Jedi Knight, a cocky pilot, a Wookiee and two droids to save the galaxy from the Empire's world-destroying battle station. | +{/* supa-mdx-lint-enable Rule003Spelling */} + There are a few important differences from a spreadsheet, but it's a good starting point if you're new to Relational databases. ## Creating tables @@ -91,51 +95,51 @@ Every column is a predefined type. PostgreSQL provides many [default types](http
Show/Hide default data types -| `Name` | `Aliases` | `Description` | -| --------------------------------- | ----------- | ---------------------------------------------------------------- | -| bigint | int8 | signed eight-byte integer | -| bigserial | serial8 | autoincrementing eight-byte integer | -| bit | | fixed-length bit string | -| bit varying | varbit | variable-length bit string | -| boolean | bool | logical Boolean (true/false) | -| box | | rectangular box on a plane | -| bytea | | binary data (“byte array”) | -| character | char | fixed-length character string | -| character varying | varchar | variable-length character string | -| cidr | | IPv4 or IPv6 network address | -| circle | | circle on a plane | -| date | | calendar date (year, month, day) | -| double precision | float8 | double precision floating-point number (8 bytes) | -| inet | | IPv4 or IPv6 host address | -| integer | int, int4 | signed four-byte integer | -| interval \[ fields \] | | time span | -| json | | textual JSON data | -| jsonb | | binary JSON data, decomposed | -| line | | infinite line on a plane | -| lseg | | line segment on a plane | -| macaddr | | MAC (Media Access Control) address | -| macaddr8 | | MAC (Media Access Control) address (EUI-64 format) | -| money | | currency amount | -| numeric | decimal | exact numeric of selectable precision | -| path | | geometric path on a plane | -| pg_lsn | | PostgreSQL Log Sequence Number | -| pg_snapshot | | user-level transaction ID snapshot | -| point | | geometric point on a plane | -| polygon | | closed geometric path on a plane | -| real | float4 | single precision floating-point number (4 bytes) | -| smallint | int2 | signed two-byte integer | -| smallserial | serial2 | autoincrementing two-byte integer | -| serial | serial4 | autoincrementing four-byte integer | -| text | | variable-length character string | -| time \[ without time zone \] | | time of day (no time zone) | -| time with time zone | timetz | time of day, including time zone | -| timestamp \[ without time zone \] | | date and time (no time zone) | -| timestamp with time zone | timestamptz | date and time, including time zone | -| tsquery | | text search query | -| tsvector | | text search document | -| txid_snapshot | | user-level transaction ID snapshot (deprecated; see pg_snapshot) | -| uuid | | universally unique identifier | -| xml | | XML data | +| `Name` | `Aliases` | `Description` | +| --------------------------------- | ------------- | ---------------------------------------------------------------- | +| `bigint` | `int8` | signed eight-byte integer | +| `bigserial` | `serial8` | autoincrementing eight-byte integer | +| `bit` | | fixed-length bit string | +| `bit varying` | `varbit` | variable-length bit string | +| `boolean` | `bool` | logical Boolean (true/false) | +| `box` | | rectangular box on a plane | +| `bytea` | | binary data (“byte array”) | +| `character` | `char` | fixed-length character string | +| `character varying` | `varchar` | variable-length character string | +| `cidr` | | IPv4 or IPv6 network address | +| `circle` | | circle on a plane | +| `date` | | calendar date (year, month, day) | +| `double precision` | `float8` | double precision floating-point number (8 bytes) | +| `inet` | | IPv4 or IPv6 host address | +| `integer` | `int`, `int4` | signed four-byte integer | +| `interval [ fields ]` | | time span | +| `json` | | textual JSON data | +| `jsonb` | | binary JSON data, decomposed | +| `line` | | infinite line on a plane | +| `lseg` | | line segment on a plane | +| `macaddr` | | MAC (Media Access Control) address | +| `macaddr8` | | MAC (Media Access Control) address (EUI-64 format) | +| `money` | | currency amount | +| `numeric` | `decimal` | exact numeric of selectable precision | +| `path` | | geometric path on a plane | +| `pg_lsn` | | PostgreSQL Log Sequence Number | +| `pg_snapshot` | | user-level transaction ID snapshot | +| `point` | | geometric point on a plane | +| `polygon` | | closed geometric path on a plane | +| `real` | `float4` | single precision floating-point number (4 bytes) | +| `smallint` | `int2` | signed two-byte integer | +| `smallserial` | `serial2` | autoincrementing two-byte integer | +| `serial` | `serial4` | autoincrementing four-byte integer | +| `text` | | variable-length character string | +| `time [ without time zone ]` | | time of day (no time zone) | +| `time with time zone` | `timetz` | time of day, including time zone | +| `timestamp [ without time zone ]` | | date and time (no time zone) | +| `timestamp with time zone` | `timestamptz` | date and time, including time zone | +| `tsquery` | | text search query | +| `tsvector` | | text search document | +| `txid_snapshot` | | user-level transaction ID snapshot (deprecated; see pg_snapshot) | +| `uuid` | | universally unique identifier | +| `xml` | | XML data |
@@ -300,7 +304,7 @@ supabase ### Bulk data loading When inserting large data sets it's best to use PostgreSQL's [COPY](https://www.postgresql.org/docs/current/sql-copy.html) command. -This loads data directly from a file into a table. There are several file formats available for copying data: text, csv, binary, JSON, etc. +This loads data directly from a file into a table. There are several file formats available for copying data: text, CSV, binary, JSON, etc. For example, if you wanted to load a CSV file into your movies table: @@ -442,12 +446,16 @@ Say we have the following tables from a database of a university: **`students`** +{/* supa-mdx-lint-disable Rule003Spelling */} + | id | name | type | | --- | ---------------- | ------------- | | 1 | Princess Leia | undergraduate | | 2 | Yoda | graduate | | 3 | Anakin Skywalker | graduate | +{/* supa-mdx-lint-enable Rule003Spelling */} + **`courses`** | id | title | code | diff --git a/apps/docs/content/guides/database/testing.mdx b/apps/docs/content/guides/database/testing.mdx index be1a9a06696..8054ecc2b7f 100644 --- a/apps/docs/content/guides/database/testing.mdx +++ b/apps/docs/content/guides/database/testing.mdx @@ -18,7 +18,7 @@ You can use the Supabase CLI to test your database. The minimum required version ## Creating a test -Create a tests folder inside the supabase folder: +Create a tests folder inside the `supabase` folder: ```bash mkdir -p ./supabase/tests/database diff --git a/apps/docs/content/guides/deployment/branching.mdx b/apps/docs/content/guides/deployment/branching.mdx index 1eec46d5754..7f9555d4651 100644 --- a/apps/docs/content/guides/deployment/branching.mdx +++ b/apps/docs/content/guides/deployment/branching.mdx @@ -50,7 +50,7 @@ Preview Branch instances contain no data by default. You must include a seed fil ## Git providers -To manage code changes, your Supabase project must be connected to a Git repository. At this stage, we only support [GitHub](#branching-with-github). If you are interested in other Git providers, join the [discussion](https://github.com/orgs/supabase/discussions/18936) for GitLab, BitBucket, and non-Git based Branching. +To manage code changes, your Supabase project must be connected to a Git repository. At this stage, we only support [GitHub](#branching-with-github). If you are interested in other Git providers, join the [discussion](https://github.com/orgs/supabase/discussions/18936) for GitLab, Bitbucket, and non-Git based Branching. ### Branching with GitHub @@ -337,7 +337,7 @@ The Supabase CLI provides two options: [manual migrations](https://supabase.com/ - Start supabase locally: + Start Supabase locally: diff --git a/apps/docs/content/guides/deployment/database-migrations.mdx b/apps/docs/content/guides/deployment/database-migrations.mdx index 11059b17bd8..2502d360ae2 100644 --- a/apps/docs/content/guides/deployment/database-migrations.mdx +++ b/apps/docs/content/guides/deployment/database-migrations.mdx @@ -135,7 +135,7 @@ supabase migration up Finally, you should see the `department` column added to your `employees` table in the local Dashboard. - + View the [complete code](https://github.com/supabase/supabase/tree/master/examples/database/employees) for this example on GitHub. diff --git a/apps/docs/content/guides/deployment/going-into-prod.mdx b/apps/docs/content/guides/deployment/going-into-prod.mdx index dba01cb4e90..97d8ea94fb3 100644 --- a/apps/docs/content/guides/deployment/going-into-prod.mdx +++ b/apps/docs/content/guides/deployment/going-into-prod.mdx @@ -42,7 +42,7 @@ After developing your project and deciding it's Production Ready, you should run - Tools like [k6](https://k6.io/) can simulate traffic from many different users. - Upgrade your database if you require more resources. If you need anything beyond what is listed, contact enterprise@supabase.io. - If you are expecting a surge in traffic (for a big launch) and are on a Team or Enterprise Plan, [contact support](https://supabase.com/dashboard/support/new) with more details about your launch and we'll help keep an eye on your project. -- If you expect your database size to be > 4 GB, [enable](https://supabase.com/dashboard/project/_/settings/addons?panel=pitr) the Point in Time Recovery (PITR) addon. Daily backups can take up resources from your database when the backup is in progress. PITR is more resource efficient, since only the changes to the database are backed up. +- If you expect your database size to be > 4 GB, [enable](https://supabase.com/dashboard/project/_/settings/addons?panel=pitr) the Point in Time Recovery (PITR) add-on. Daily backups can take up resources from your database when the backup is in progress. PITR is more resource efficient, since only the changes to the database are backed up. - Check and review issues in your database using [Performance Advisor](https://supabase.com/dashboard/project/_/database/performance-advisor). ## Availability @@ -75,7 +75,7 @@ After developing your project and deciding it's Production Ready, you should run | ------------------------------------------------ | -------------------------------------------------------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | All endpoints that send emails | `/auth/v1/signup` `/auth/v1/recover` `/auth/v1/user`[^1] | Sum of combined requests | As of 3 Sep 2024, this has been updated to auth.rate_limits.email.inbuilt_smtp_per_hour.value emails per hour. You can only change this with your own [custom SMTP setup](/docs/guides/auth/auth-smtp). | | All endpoints that send One-Time-Passwords (OTP) | `/auth/v1/otp` | Sum of combined requests | Defaults to 360 OTPs per hour. Is customizable. | -| Send OTPs or magiclinks | `/auth/v1/otp` | Last request | Defaults to 60 seconds window before a new request is allowed. Is customizable. | +| Send OTPs or magic links | `/auth/v1/otp` | Last request | Defaults to 60 seconds window before a new request is allowed. Is customizable. | | Signup confirmation request | `/auth/v1/signup` | Last request | Defaults to 60 seconds window before a new request is allowed. Is customizable. | | Password Reset Request | `/auth/v1/recover` | Last request | Defaults to 60 seconds window before a new request is allowed. Is customizable. | | Verification requests | `/auth/v1/verify` | IP Address | 360 requests per hour (with bursts up to 30 requests) | @@ -97,7 +97,7 @@ After developing your project and deciding it's Production Ready, you should run - When working with enterprise systems, email scanners may scan and make a `GET` request to the reset password link or sign up link in your email. Since links in Supabase Auth are single use, a user who opens an email post-scan to click on a link will receive an error. To get around this problem, consider altering the email template to replace the original magic link with a link to a domain you control. The domain can present the user with a "Sign-in" button which redirect the user to the original magic link URL when clicked. -- When using a custom SMTP service, some services might have link tracking enabled which may overwrite or malform the email confirmation links sent by Supabase Auth. To prevent this from happening, we recommend that you disable link tracking when using a custom SMTP service. +- When using a custom SMTP service, some services might have link tracking enabled which may overwrite or disform the email confirmation links sent by Supabase Auth. To prevent this from happening, we recommend that you disable link tracking when using a custom SMTP service. ## Next steps diff --git a/apps/docs/content/guides/deployment/managing-environments.mdx b/apps/docs/content/guides/deployment/managing-environments.mdx index bde4fefce16..b4b90e37676 100644 --- a/apps/docs/content/guides/deployment/managing-environments.mdx +++ b/apps/docs/content/guides/deployment/managing-environments.mdx @@ -146,7 +146,7 @@ Commit the new migration script to git and you are ready to deploy. -Alternatively, you may pass in the `--use-migra` experimental flag to generate a more concise migration using [migra](https://github.com/djrobstep/migra). +Alternatively, you may pass in the `--use-migra` experimental flag to generate a more concise migration using [`migra`](https://github.com/djrobstep/migra). Without the `-f` file flag, the output is written to stdout by default. @@ -360,7 +360,7 @@ Once pushed, check that the migration version is up to date for both local and r supabase migration list ``` -### Permission denied on db pull +### Permission denied on `db pull` If you have been using Supabase hosted projects for a long time, you might encounter the following permission error when executing `db pull`. @@ -378,7 +378,7 @@ grant all on all functions in schema graphql to postgres, anon, authenticated, s grant all on all sequences in schema graphql to postgres, anon, authenticated, service_role; ``` -### Permission denied on db push +### Permission denied on `db push` If you created a table through Supabase dashboard, and your new migration script contains `ALTER TABLE` statements, you might run into permission error when applying them on staging or production databases. diff --git a/apps/docs/content/guides/deployment/shared-responsibility-model.mdx b/apps/docs/content/guides/deployment/shared-responsibility-model.mdx index 1e57ad99edf..a4d8ed0fb54 100644 --- a/apps/docs/content/guides/deployment/shared-responsibility-model.mdx +++ b/apps/docs/content/guides/deployment/shared-responsibility-model.mdx @@ -61,7 +61,7 @@ Supabase offers a lot of opportunities for flexibly integrating with third-party - Calls to external APIs within Postgres functions or triggers - Calls to external APIs within Edge Functions -You are free to use and integrate with any service, but you're also responsible for ensuring that the performance, availability, and security of the services you use match up with your application's requirements. We do not monitor for outages or performance issues within integrations with third-party services. Depending on the implementation, an issue with such an integration could also result in performance degradataion or an outage for your Supabase project. +You are free to use and integrate with any service, but you're also responsible for ensuring that the performance, availability, and security of the services you use match up with your application's requirements. We do not monitor for outages or performance issues within integrations with third-party services. Depending on the implementation, an issue with such an integration could also result in performance degradation or an outage for your Supabase project. If your application architecture relies on such integrations, you should monitor the relevant logs and metrics to ensure optimal performance. diff --git a/apps/docs/content/guides/functions/ai-models.mdx b/apps/docs/content/guides/functions/ai-models.mdx index 60b9df79bcd..dcf300e1d04 100644 --- a/apps/docs/content/guides/functions/ai-models.mdx +++ b/apps/docs/content/guides/functions/ai-models.mdx @@ -165,7 +165,7 @@ curl --get "http://localhost:54321/functions/v1/ollama-test" \ -Follow the [Llamafile Quickstart](https://github.com/Mozilla-Ocho/llamafile?tab=readme-ov-file#quickstart) to download an run a llamafile locally on your machine. +Follow the [Llamafile Quickstart](https://github.com/Mozilla-Ocho/llamafile?tab=readme-ov-file#quickstart) to download an run a Llamafile locally on your machine. Since Llamafile provides an OpenAI API compatible server, you can either use it with `@supabase/functions-js` or with the official OpenAI Deno SDK. @@ -190,7 +190,7 @@ Create a new function with the following code supabase functions new llamafile-test ``` - + Note that the model parameter doesn't have any effect here! The model depends on which Llamafile is currently running! @@ -246,7 +246,7 @@ Create a new function with the following code supabase functions new llamafile-test ``` - + Note that the model parameter doesn't have any effect here! The model depends on which Llamafile is currently running! diff --git a/apps/docs/content/guides/functions/compression.mdx b/apps/docs/content/guides/functions/compression.mdx index 77964769461..c735106fb99 100644 --- a/apps/docs/content/guides/functions/compression.mdx +++ b/apps/docs/content/guides/functions/compression.mdx @@ -43,7 +43,7 @@ Deno.serve(async (req) => { }) ``` - + Edge functions have a runtime memory limit of 150MB. Overly large compressed payloads may result in an out-of-memory error. diff --git a/apps/docs/content/guides/functions/dependencies.mdx b/apps/docs/content/guides/functions/dependencies.mdx index b9abf701bf6..d13bd7fa187 100644 --- a/apps/docs/content/guides/functions/dependencies.mdx +++ b/apps/docs/content/guides/functions/dependencies.mdx @@ -34,7 +34,7 @@ Learn more about npm specifiers and Node built-in APIs in [Deno's documentation] ### JSR -You can import JS modules published to [JSR](https://jsr.io/) (eg: Deno's standard library), using the `jsr:` specifier: +You can import JS modules published to [JSR](https://jsr.io/) (e.g.: Deno's standard library), using the `jsr:` specifier: ```ts import path from 'jsr:@std/path@1.0.8' @@ -57,7 +57,7 @@ There are two ways to manage your dependencies in Supabase Edge Functions: ### Using deno.json (recommended) - + This feature requires Supabase CLI version 1.215.0 or higher. diff --git a/apps/docs/content/guides/functions/ephemeral-storage.mdx b/apps/docs/content/guides/functions/ephemeral-storage.mdx index 55bc58780ec..4d567230977 100644 --- a/apps/docs/content/guides/functions/ephemeral-storage.mdx +++ b/apps/docs/content/guides/functions/ephemeral-storage.mdx @@ -14,7 +14,7 @@ Ephemeral storage will reset on each function invocation. This means the files y Here are some use cases where ephemeral storage can be useful: - Unzip an archive of CSVs and then add them as records to the DB -- Custom image manipulation workflows (using [MagickWasm](https://supabase.com/docs/guides/functions/examples/image-manipulation)) +- Custom image manipulation workflows (using [`magick-wasm`](https://supabase.com/docs/guides/functions/examples/image-manipulation)) You can use [Background Tasks](https://supabase.com/docs/guides/functions/background-tasks) to handle slow file processing outside of a request. @@ -45,9 +45,9 @@ Deno.serve(async (req) => { ### Unavailable APIs -Currently, the synchronous APIs (eg: `Deno.writeFileSync` or `Deno.mkdirSync`) for creating or writing files are not supported. +Currently, the synchronous APIs (e.g. `Deno.writeFileSync` or `Deno.mkdirSync`) for creating or writing files are not supported. -You can use sync variations of read APIs (eg: `Deno.readFileSync`). +You can use sync variations of read APIs (e.g. `Deno.readFileSync`). ### Limits diff --git a/apps/docs/content/guides/functions/examples/auth-send-email-hook-react-email-resend.mdx b/apps/docs/content/guides/functions/examples/auth-send-email-hook-react-email-resend.mdx index f7c7ef537bf..3ea96f95d88 100644 --- a/apps/docs/content/guides/functions/examples/auth-send-email-hook-react-email-resend.mdx +++ b/apps/docs/content/guides/functions/examples/auth-send-email-hook-react-email-resend.mdx @@ -6,7 +6,7 @@ tocVideo: 'tlA7BomSCgU' Use the [send email hook](/docs/guides/auth/auth-hooks/send-email-hook?queryGroups=language&language=http) to send custom auth emails with [React Email](https://react.email/) and [Resend](https://resend.com/) in Supabase Edge Functions. - + Prefer to jump straight to the code? [Check out the example on GitHub](https://github.com/supabase/supabase/tree/master/examples/edge-functions/supabase/functions/auth-hook-react-email-resend). @@ -251,7 +251,7 @@ const code = { } ``` - + You can find a selection of React Email templates in the [React Email Examples](https://react.email/examples). @@ -282,7 +282,7 @@ RESEND_API_KEY=your_resend_api_key SEND_EMAIL_HOOK_SECRET= ``` - + You can generate the secret in the [Auth Hooks](/dashboard/project/_/auth/hooks) section of the Supabase dashboard. Make sure to remove the `v1,whsec_` prefix! diff --git a/apps/docs/content/guides/functions/examples/image-manipulation.mdx b/apps/docs/content/guides/functions/examples/image-manipulation.mdx index 0c9ac6c99bf..551da2e9d81 100644 --- a/apps/docs/content/guides/functions/examples/image-manipulation.mdx +++ b/apps/docs/content/guides/functions/examples/image-manipulation.mdx @@ -6,9 +6,9 @@ description: 'How to optimize and transform images using Edge Functions.' Supabase Storage has [out-of-the-box support](https://supabase.com/docs/guides/storage/serving/image-transformations?queryGroups=language&language=js) for the most common image transformations and optimizations you need. If you need to do anything custom beyond what Supabase Storage provides, you can use Edge Functions to write custom image manipulation scripts. -In this example, we will use [magick-wasm](https://github.com/dlemstra/magick-wasm) to perform image manipulations. `magick-wasm` is the WebAssembly port of the popular ImageMagick library and supports processing over 100 file formats. +In this example, we will use [`magick-wasm`](https://github.com/dlemstra/magick-wasm) to perform image manipulations. `magick-wasm` is the WebAssembly port of the popular ImageMagick library and supports processing over 100 file formats. - + Edge Functions currently doesn't support image processing libraries such as `Sharp`, which depend on native libraries. Only WASM-based libraries are supported. @@ -69,7 +69,7 @@ supabase functions deploy image-blur ``` - + Hosted Edge Functions have [limits](https://supabase.com/docs/guides/functions/limits) on memory and CPU usage. diff --git a/apps/docs/content/guides/functions/examples/push-notifications.mdx b/apps/docs/content/guides/functions/examples/push-notifications.mdx index 994c7e4267d..cb157e8230f 100644 --- a/apps/docs/content/guides/functions/examples/push-notifications.mdx +++ b/apps/docs/content/guides/functions/examples/push-notifications.mdx @@ -22,7 +22,7 @@ Push notifications are an important part of any mobile app. They allow you to se - [Create a new Supabase project](https://database.new). - Link your project: `supabase link --project-ref your-supabase-project-ref` - - Start supabase locally: `supabase start` + - Start Supabase locally: `supabase start` - Push up the schema: `supabase db push` (schema is defined in [supabase/migrations](https://github.com/supabase/supabase/blob/master/examples/user-management/expo-push-notifications/supabase/migrations/)) ## Expo setup @@ -123,7 +123,7 @@ Push notifications are an important part of any mobile app. They allow you to se Firebase Cloud Messaging (FCM) is a push notification service offered by Google that allows you to send push notifications to your users' devices on iOS, Android, and Web. - + This guide will show you how to send push notifications to your app when a new row is inserted into a table using FCM, Supabase Edge Functions, and database web hooks. ## Supabase setup diff --git a/apps/docs/content/guides/functions/examples/screenshots.mdx b/apps/docs/content/guides/functions/examples/screenshots.mdx index 6fb9f4e0d2a..2e346f9ec9e 100644 --- a/apps/docs/content/guides/functions/examples/screenshots.mdx +++ b/apps/docs/content/guides/functions/examples/screenshots.mdx @@ -12,6 +12,6 @@ description: 'Take screenshots in Edge Functions with Puppeteer and Browserless. >
-[Puppeteer](https://pptr.dev/) is a handy tool to programmatically take screenshots and generate PDFs. However, trying to do so in Edge Functions can be challenging due to the size restrictions. Luckily there is a [serverless browser offering available](https://www.browserless.io/) that we can connect to via websockets. +[Puppeteer](https://pptr.dev/) is a handy tool to programmatically take screenshots and generate PDFs. However, trying to do so in Edge Functions can be challenging due to the size restrictions. Luckily there is a [serverless browser offering available](https://www.browserless.io/) that we can connect to via WebSockets. Find the code on [GitHub](https://github.com/supabase/supabase/tree/master/examples/edge-functions/supabase/functions/puppeteer). diff --git a/apps/docs/content/guides/functions/examples/semantic-search.mdx b/apps/docs/content/guides/functions/examples/semantic-search.mdx index 7534d6bafae..21e88052359 100644 --- a/apps/docs/content/guides/functions/examples/semantic-search.mdx +++ b/apps/docs/content/guides/functions/examples/semantic-search.mdx @@ -13,7 +13,7 @@ Since Supabase Edge Runtime [v1.36.0](https://github.com/supabase/edge-runtime/r In this tutorial you're implementing three parts: 1. A [`generate-embedding`](https://github.com/supabase/supabase/tree/master/examples/ai/edge-functions/supabase/functions/generate-embedding/index.ts) database webhook edge function which generates embeddings when a content row is added (or updated) in the [`public.embeddings`](https://github.com/supabase/supabase/tree/master/examples/ai/edge-functions/supabase/migrations/20240408072601_embeddings.sql) table. -2. A [`query_embeddings` Postgres function](https://github.com/supabase/supabase/tree/master/examples/ai/edge-functions/supabase/migrations/20240410031515_vector-search.sql) which allows us to perform similarity search from an egde function via [Remote Procedure Call (RPC)](https://supabase.com/docs/guides/database/functions?language=js). +2. A [`query_embeddings` Postgres function](https://github.com/supabase/supabase/tree/master/examples/ai/edge-functions/supabase/migrations/20240410031515_vector-search.sql) which allows us to perform similarity search from an Edge Function via [Remote Procedure Call (RPC)](https://supabase.com/docs/guides/database/functions?language=js). 3. A [`search` edge function](https://github.com/supabase/supabase/tree/master/examples/ai/edge-functions/supabase/functions/search/index.ts) which generates the embedding for the search term, performs the similarity search via RPC function call, and returns the result. You can find the complete example code on [GitHub](https://github.com/supabase/supabase/tree/master/examples/ai/edge-functions) diff --git a/apps/docs/content/guides/functions/examples/send-emails.mdx b/apps/docs/content/guides/functions/examples/send-emails.mdx index 4a28a8285ef..8dc64ae0683 100644 --- a/apps/docs/content/guides/functions/examples/send-emails.mdx +++ b/apps/docs/content/guides/functions/examples/send-emails.mdx @@ -77,7 +77,7 @@ Deploy function to Supabase: supabase functions deploy resend --no-verify-jwt ``` - + When you deploy to Supabase, make sure that your `RESEND_API_KEY` is set in [Edge Function Secrets Management](https://supabase.com/dashboard/project/_/settings/functions) diff --git a/apps/docs/content/guides/functions/limits.mdx b/apps/docs/content/guides/functions/limits.mdx index 9a41065188b..829482dd7ef 100644 --- a/apps/docs/content/guides/functions/limits.mdx +++ b/apps/docs/content/guides/functions/limits.mdx @@ -23,4 +23,4 @@ subtitle: "Limits applied Edge Functions in Supabase's hosted platform." - Outgoing connections to ports `25` and `587` are not allowed. - Serving of HTML content is only supported with [custom domains](/docs/reference/cli/supabase-domains) (Otherwise `GET` requests that return `text/html` will be rewritten to `text/plain`). - Web Worker API (or Node `vm` API) are not available. -- Node Libraries that require multithreading are not supported. Examples: [libvips](https://github.com/libvips/libvips), [sharp](https://github.com/lovell/sharp). +- Node Libraries that require multithreading are not supported. Examples: [`libvips`](https://github.com/libvips/libvips), [sharp](https://github.com/lovell/sharp). diff --git a/apps/docs/content/guides/functions/local-development.mdx b/apps/docs/content/guides/functions/local-development.mdx index 1da210dd2b6..8b8a12f9e96 100644 --- a/apps/docs/content/guides/functions/local-development.mdx +++ b/apps/docs/content/guides/functions/local-development.mdx @@ -13,7 +13,7 @@ You can follow the [Deno guide](https://deno.com/manual@v1.32.5/getting_started/ ## Deno with Visual Studio Code -When using VSCode, you should install both the Deno CLI and the the Deno language server [via this link](vscode:extension/denoland.vscode-deno) or by browsing the extensions in vscode and choosing to install the _Deno_ extension. +When using VSCode, you should install both the Deno CLI and the the Deno language server [via this link](vscode:extension/denoland.vscode-deno) or by browsing the extensions in VSCode and choosing to install the _Deno_ extension. diff --git a/apps/docs/content/guides/functions/quickstart.mdx b/apps/docs/content/guides/functions/quickstart.mdx index 19aedd7811c..a7ef88b6e70 100644 --- a/apps/docs/content/guides/functions/quickstart.mdx +++ b/apps/docs/content/guides/functions/quickstart.mdx @@ -30,7 +30,7 @@ If you're using VS code you can have the CLI automatically create helpful Deno s -If you're using an Intellj IDEA editor such as WebStorm, you can use the `--with-intellij-settings` flag with `supabase init` to create an auto generated deno cofig. +If you're using an IntelliJ IDEA editor such as WebStorm, you can use the `--with-intellij-settings` flag with `supabase init` to create an auto generated Deno config. @@ -190,9 +190,9 @@ import_map = './import_map.json' When you create a new Edge Function, it will use TypeScript by default. However, it is possible to write and deploy Edge Functions using pure JavaScript. -Save your Function as a JavaScript file (eg: `index.js`) and then update the `supabase/config.toml` as follows: +Save your Function as a JavaScript file (e.g. `index.js`) and then update the `supabase/config.toml` as follows: - + `entrypoint` is available only in Supabase CLI version 1.215.0 or higher. diff --git a/apps/docs/content/guides/functions/routing.mdx b/apps/docs/content/guides/functions/routing.mdx index 2944dacf500..023e284739f 100644 --- a/apps/docs/content/guides/functions/routing.mdx +++ b/apps/docs/content/guides/functions/routing.mdx @@ -5,8 +5,8 @@ description: 'How to handle custom routing within Edge Functions.' subtitle: 'How to handle custom routing within Edge Functions.' --- -Usually, an Edge Function is written to perform a single action (eg: write a record to the database). However, if your app's logic is split into multiple Edge Functions requests to each action may seem slower. -This is because each Edge Function needs to be booted before serving a request (known as cold starts). If an action is performed less frequently (eg: deleting a record), there is a high-chance of that function experiencing a cold-start. +Usually, an Edge Function is written to perform a single action (e.g. write a record to the database). However, if your app's logic is split into multiple Edge Functions requests to each action may seem slower. +This is because each Edge Function needs to be booted before serving a request (known as cold starts). If an action is performed less frequently (e.g. deleting a record), there is a high-chance of that function experiencing a cold-start. One way to reduce the cold starts and increase performance of your app is to combine multiple actions into a single Edge Function. This way only one instance of the Edge Function needs to be booted and it can handle multiple requests to different actions. For example, we can use a single Edge Function to create a typical CRUD API (create, read, update, delete records). @@ -160,10 +160,10 @@ We should see a response printing `Hello Foo!`. ## Using route parameters -We can use route parameters to capture values at specific URL segments (eg: `/tasks/:taskId/notes/:noteId`). +We can use route parameters to capture values at specific URL segments (e.g. `/tasks/:taskId/notes/:noteId`). Here's an example Edge Function implemented using the Framework for managing tasks using route parameters. -Keep in mind paths must be prefixed by function name (ie. `tasks` in this example). Route parameters can only be used after the function name prefix. +Keep in mind paths must be prefixed by function name (i.e. `tasks` in this example). Route parameters can only be used after the function name prefix. { ## URL patterns API -If you prefer not to use a web framework, you can directly use [URLPattern API](https://developer.mozilla.org/en-US/docs/Web/API/URL_Pattern_API) within your Edge Functions to implement routing. +If you prefer not to use a web framework, you can directly use [URL Pattern API](https://developer.mozilla.org/en-US/docs/Web/API/URL_Pattern_API) within your Edge Functions to implement routing. This is ideal for small apps with only couple of routes and you want to have a custom matching algorithm. Here is an example Edge Function using URL Patterns API: https://github.com/supabase/supabase/blob/master/examples/edge-functions/supabase/functions/restful-tasks/index.ts diff --git a/apps/docs/content/guides/functions/status-codes.mdx b/apps/docs/content/guides/functions/status-codes.mdx index 5925a2ad3bb..dfe712f6d3d 100644 --- a/apps/docs/content/guides/functions/status-codes.mdx +++ b/apps/docs/content/guides/functions/status-codes.mdx @@ -33,7 +33,7 @@ Edge Functions only support these HTTP methods: 'POST', 'GET', 'PUT', 'PATCH', ' ### 500 Internal Server Error -Edge Function throwed an uncaught exception (`WORKER_ERROR`). Check Edge Function logs to find the cause. +Edge Function threw an uncaught exception (`WORKER_ERROR`). Check Edge Function logs to find the cause. ### 503 Service Unavailable diff --git a/apps/docs/content/guides/functions/unit-test.mdx b/apps/docs/content/guides/functions/unit-test.mdx index 5dc3e942fb2..d36ac8f5549 100644 --- a/apps/docs/content/guides/functions/unit-test.mdx +++ b/apps/docs/content/guides/functions/unit-test.mdx @@ -105,7 +105,7 @@ This test case consists of two parts. The first part tests the client library an - The `testHelloWorld` function tests the "Hello-world" Edge Function by invoking it using the Supabase client's `functions.invoke` method. It checks if the response message matches the expected greeting. - We run the tests using the `Deno.test` function, providing a descriptive name for each test case and the corresponding test function. - + Please make sure to replace the placeholders (`supabaseUrl`, `supabaseKey`, `my_table`) with the actual values relevant to your Supabase setup. diff --git a/apps/docs/content/guides/functions/wasm.mdx b/apps/docs/content/guides/functions/wasm.mdx index af0bf32a0f5..b1c26e34de2 100644 --- a/apps/docs/content/guides/functions/wasm.mdx +++ b/apps/docs/content/guides/functions/wasm.mdx @@ -7,7 +7,7 @@ subtitle: 'How to use WebAssembly in Edge Functions.' Edge Functions supports running [WebAssembly (Wasm)](https://developer.mozilla.org/en-US/docs/WebAssembly) modules. WebAssembly is useful if you want to optimize code that's slower to run in JavaScript or require low-level manipulation. -It also gives you the option to port existing libraries written in other languages to be used with JavaScript. For example, [MagickWasm](https://supabase.com/docs/guides/functions/examples/image-manipulation), which does image manipulation and transforms, is a port of an existing C library to WebAssembly. +It also gives you the option to port existing libraries written in other languages to be used with JavaScript. For example, [magick-wasm](https://supabase.com/docs/guides/functions/examples/image-manipulation), which does image manipulation and transforms, is a port of an existing C library to WebAssembly. ### Writing a Wasm module @@ -62,7 +62,7 @@ lines={[[1, -1]]} meta="index.ts" /> - + Supabase Edge Functions currently use Deno 1.46. From [Deno 2.1, importing Wasm modules](https://deno.com/blog/v2.1) will require even less boilerplate code. @@ -71,7 +71,7 @@ meta="index.ts" Before deploying the Edge Function, we need to ensure it bundles the Wasm module with it. We can do this by defining it in the `static_files` for the function in `superbase/config.toml`. - + You will need update Supabase CLI to 2.7.0 or higher for the `static_files` support. diff --git a/apps/docs/content/guides/functions/websockets.mdx b/apps/docs/content/guides/functions/websockets.mdx index 0c0c82201e8..c1c1c214319 100644 --- a/apps/docs/content/guides/functions/websockets.mdx +++ b/apps/docs/content/guides/functions/websockets.mdx @@ -1,5 +1,5 @@ --- -id: 'function-websockets' +id: 'function-WebSockets' title: 'Handling WebSockets' description: 'How to handle WebSocket connections in Edge Functions' subtitle: 'How to handle WebSocket connections in Edge Functions' @@ -25,8 +25,8 @@ Here are some basic examples of setting up WebSocket servers using Deno and Node Deno.serve(req => { const upgrade = req.headers.get("upgrade") || ""; - if (upgrade.toLowerCase() != "websocket") { - return new Response("request isn't trying to upgrade to websocket.", { status: 400 }); + if (upgrade.toLowerCase() != "WebSocket") { + return new Response("request isn't trying to upgrade to WebSocket.", { status: 400 }); } const { socket, response } = Deno.upgradeWebSocket(req); @@ -130,8 +130,8 @@ Deno.env.get("SUPABASE_SERVICE_ROLE_KEY"), Deno.serve(req => { const upgrade = req.headers.get("upgrade") || ""; - if (upgrade.toLowerCase() != "websocket") { - return new Response("request isn't trying to upgrade to websocket.", { status: 400 }); + if (upgrade.toLowerCase() != "WebSocket") { + return new Response("request isn't trying to upgrade to WebSocket.", { status: 400 }); } // Please be aware query params may be logged in some logging systems. @@ -179,8 +179,8 @@ const supabase = createClient( Deno.serve(req => { const upgrade = req.headers.get("upgrade") || ""; - if (upgrade.toLowerCase() != "websocket") { - return new Response("request isn't trying to upgrade to websocket.", { status: 400 }); + if (upgrade.toLowerCase() != "WebSocket") { + return new Response("request isn't trying to upgrade to WebSocket.", { status: 400 }); } // Sec-WebScoket-Protocol may return multiple protocol values `jwt-TOKEN, value1, value 2` diff --git a/apps/docs/content/guides/getting-started.mdx b/apps/docs/content/guides/getting-started.mdx index 0586275ec12..3e50b8ff57b 100644 --- a/apps/docs/content/guides/getting-started.mdx +++ b/apps/docs/content/guides/getting-started.mdx @@ -111,10 +111,10 @@ hideToc: true hasLightIcon: true, }, { - title: 'NuxtJS', + title: 'Nuxt', href: '/guides/getting-started/quickstarts/nuxtjs', description: - 'Learn how to create a Supabase project, add some sample data to your database, and query the data from a NuxtJS app.', + 'Learn how to create a Supabase project, add some sample data to your database, and query the data from a Nuxt app.', icon: '/docs/img/icons/nuxt-icon', }, { diff --git a/apps/docs/content/guides/getting-started/architecture.mdx b/apps/docs/content/guides/getting-started/architecture.mdx index 531cce08e21..f2da781b4de 100644 --- a/apps/docs/content/guides/getting-started/architecture.mdx +++ b/apps/docs/content/guides/getting-started/architecture.mdx @@ -66,7 +66,7 @@ We use this with our [`pg_graphql`](https://github.com/supabase/pg_graphql) exte ### Realtime (API & multiplayer) -A scalable websocket engine for managing user Presence, broadcasting messages, and streaming database changes. +A scalable WebSocket engine for managing user Presence, broadcasting messages, and streaming database changes. - Official Docs: [Supabase Realtime docs](/docs/guides/realtime) - Source code: [github.com/supabase/realtime](https://github.com/supabase/realtime) @@ -80,7 +80,7 @@ An S3-compatible object storage service that stores metadata in Postgres. - Official Docs: [Supabase Storage reference docs](/docs/reference/storage) - Source code: [github.com/supabase/storage-api](https://github.com/supabase/storage-api) - License: [Apache 2.0](https://github.com/supabase/storage-api/blob/master/LICENSE) -- Language: NodeJS / TypeScript +- Language: Node.js / TypeScript ### Deno (Edge Functions) @@ -98,7 +98,7 @@ A RESTful API for managing your Postgres. Fetch tables, add roles, and run queri - Official Docs: [supabase.github.io/postgres-meta](https://supabase.github.io/postgres-meta/) - Source code: [github.com/supabase/postgres-meta](https://github.com/supabase/postgres-meta) - License: [Apache 2.0](https://github.com/supabase/postgres-meta/blob/master/LICENSE) -- Language: NodeJS / TypeScript +- Language: Node.js / TypeScript ### Supavisor diff --git a/apps/docs/content/guides/getting-started/features.mdx b/apps/docs/content/guides/getting-started/features.mdx index d9861810518..80a3a939245 100644 --- a/apps/docs/content/guides/getting-started/features.mdx +++ b/apps/docs/content/guides/getting-started/features.mdx @@ -78,11 +78,11 @@ Login to the Supabase dashboard via SSO. [Docs](/docs/guides/platform/sso). ### Postgres changes -Receive your database changes through websockets. [Docs](/docs/guides/realtime/postgres-changes). +Receive your database changes through WebSockets. [Docs](/docs/guides/realtime/postgres-changes). ### Broadcast -Send messages between connected users through websockets. [Docs](/docs/guides/realtime/broadcast). +Send messages between connected users through WebSockets. [Docs](/docs/guides/realtime/broadcast). ### Presence @@ -110,9 +110,9 @@ Build passwordless logins via magic links for your application or website. [Docs Control the data each user can access with Postgres Policies. [Docs](/docs/guides/database/postgres/row-level-security). -### Captcha protection +### CAPTCHA protection -Add Captcha to your sign-in, sign-up, and password reset forms. [Docs](/docs/guides/auth/auth-captcha). +Add CAPTCHA to your sign-in, sign-up, and password reset forms. [Docs](/docs/guides/auth/auth-captcha). ### Server-Side Auth @@ -235,7 +235,7 @@ In addition to the Beta requirements, features in GA are covered by the [uptime | Auth | Passwordless login | `GA` | ✅ | | Auth | SSO with SAML | `GA` | ✅ | | Auth | Authorization via RLS | `GA` | ✅ | -| Auth | Captcha protection | `GA` | ✅ | +| Auth | CAPTCHA protection | `GA` | ✅ | | Auth | Server-side Auth | `beta` | ✅ | | CLI | | `GA` | ✅ Works with self-hosted | | Management API | | `GA` | N/A | diff --git a/apps/docs/content/guides/getting-started/quickstarts/flutter.mdx b/apps/docs/content/guides/getting-started/quickstarts/flutter.mdx index 6863daee724..29211b1338e 100644 --- a/apps/docs/content/guides/getting-started/quickstarts/flutter.mdx +++ b/apps/docs/content/guides/getting-started/quickstarts/flutter.mdx @@ -8,7 +8,7 @@ hideToc: true - + @@ -155,7 +155,7 @@ hideToc: true Run your app on a platform of your choosing! By default an app should launch in your web browser. Note that `supabase_flutter` is compatible with web, iOS, Android, macOS, and Windows apps. - Running the app on MacOS requires additional configuration to [set the entitlements](https://docs.flutter.dev/development/platform-integration/macos/building#setting-up-entitlements). + Running the app on macOS requires additional configuration to [set the entitlements](https://docs.flutter.dev/development/platform-integration/macos/building#setting-up-entitlements). diff --git a/apps/docs/content/guides/getting-started/quickstarts/hono.mdx b/apps/docs/content/guides/getting-started/quickstarts/hono.mdx index 3a818e69f83..be46310e9b3 100644 --- a/apps/docs/content/guides/getting-started/quickstarts/hono.mdx +++ b/apps/docs/content/guides/getting-started/quickstarts/hono.mdx @@ -11,7 +11,7 @@ hideToc: true - Boostrap the Hono example app from the Supabase Samples using the CLI. + Bootstrap the Hono example app from the Supabase Samples using the CLI. diff --git a/apps/docs/content/guides/getting-started/quickstarts/ios-swiftui.mdx b/apps/docs/content/guides/getting-started/quickstarts/ios-swiftui.mdx index 4889133195e..40b6e910092 100644 --- a/apps/docs/content/guides/getting-started/quickstarts/ios-swiftui.mdx +++ b/apps/docs/content/guides/getting-started/quickstarts/ios-swiftui.mdx @@ -8,7 +8,7 @@ hideToc: true - + @@ -39,7 +39,7 @@ hideToc: true - Create a new `Supabase.swift` file add a new supabase instance using your project URL and public API (anon) key: + Create a new `Supabase.swift` file add a new Supabase instance using your project URL and public API (anon) key: diff --git a/apps/docs/content/guides/getting-started/quickstarts/laravel.mdx b/apps/docs/content/guides/getting-started/quickstarts/laravel.mdx index 011d956bac5..cf2afe249aa 100644 --- a/apps/docs/content/guides/getting-started/quickstarts/laravel.mdx +++ b/apps/docs/content/guides/getting-started/quickstarts/laravel.mdx @@ -73,7 +73,7 @@ hideToc: true - By default Laravel uses the `public` schema. We recommend changing this as supabase exposes the `public` schema as a [data API](/docs/guides/api). + By default Laravel uses the `public` schema. We recommend changing this as Supabase exposes the `public` schema as a [data API](/docs/guides/api). You can change the schema of your Laravel application by modifying the `search_path` variable `app/config/database.php`. diff --git a/apps/docs/content/guides/getting-started/quickstarts/nuxtjs.mdx b/apps/docs/content/guides/getting-started/quickstarts/nuxtjs.mdx index 4ba45b41a18..6e39dff869d 100644 --- a/apps/docs/content/guides/getting-started/quickstarts/nuxtjs.mdx +++ b/apps/docs/content/guides/getting-started/quickstarts/nuxtjs.mdx @@ -1,6 +1,6 @@ --- -title: 'Use Supabase with NuxtJS' -subtitle: 'Learn how to create a Supabase project, add some sample data to your database, and query the data from a NuxtJS app.' +title: 'Use Supabase with Nuxt' +subtitle: 'Learn how to create a Supabase project, add some sample data to your database, and query the data from a Nuxt app.' breadcrumb: 'Framework Quickstarts' hideToc: true --- @@ -8,16 +8,16 @@ hideToc: true - + - + - Create a Nuxt.js app using the `npx nuxi` command. + Create a Nuxt app using the `npx nuxi` command. @@ -34,9 +34,9 @@ hideToc: true - The fastest way to get started is to use the `supabase-js` client library which provides a convenient interface for working with Supabase from a NuxtJS app. + The fastest way to get started is to use the `supabase-js` client library which provides a convenient interface for working with Supabase from a Nuxt app. - Navigate to the NuxtJS app and install `supabase-js`. + Navigate to the Nuxt app and install `supabase-js`. diff --git a/apps/docs/content/guides/getting-started/quickstarts/redwoodjs.mdx b/apps/docs/content/guides/getting-started/quickstarts/redwoodjs.mdx index 2ca3ceee5a9..5bae8cd6a65 100644 --- a/apps/docs/content/guides/getting-started/quickstarts/redwoodjs.mdx +++ b/apps/docs/content/guides/getting-started/quickstarts/redwoodjs.mdx @@ -11,7 +11,7 @@ hideToc: true [Create a new project](https://supabase.com/dashboard) in the Supabase Dashboard. - + Be sure to make note of the Database Password you used as you will need this later to connect to your database. diff --git a/apps/docs/content/guides/getting-started/quickstarts/refine.mdx b/apps/docs/content/guides/getting-started/quickstarts/refine.mdx index c061ecf8156..f85b656d936 100644 --- a/apps/docs/content/guides/getting-started/quickstarts/refine.mdx +++ b/apps/docs/content/guides/getting-started/quickstarts/refine.mdx @@ -140,7 +140,7 @@ hideToc: true Add routes for the `list`, `create`, `show`, and `edit` pages. - + You should remove the `index` route for the Welcome page presented with the `` component. diff --git a/apps/docs/content/guides/getting-started/tutorials/with-angular.mdx b/apps/docs/content/guides/getting-started/tutorials/with-angular.mdx index da7aa2b7d1c..1fc7ee77539 100644 --- a/apps/docs/content/guides/getting-started/tutorials/with-angular.mdx +++ b/apps/docs/content/guides/getting-started/tutorials/with-angular.mdx @@ -47,7 +47,7 @@ export const environment = { } ``` -Now that we have the API credentials in place, let's create a **SupabaseService** with `ng g s supabase` to initialize the Supabase client and implement functions to communicate with the Supabase API. +Now that we have the API credentials in place, let's create a `SupabaseService` with `ng g s supabase` to initialize the Supabase client and implement functions to communicate with the Supabase API. ```ts src/app/supabase.service.ts import { Injectable } from '@angular/core' @@ -130,7 +130,7 @@ Optionally, update [src/styles.css](https://raw.githubusercontent.com/supabase/s ### Set up a login component Let's set up an Angular component to manage logins and sign ups. We'll use Magic Links, so users can sign in with their email without using passwords. -Create an **AuthComponent** with `ng g c auth` Angular CLI command. +Create an `AuthComponent` with `ng g c auth` Angular CLI command. ```ts src/app/auth/auth.component.ts import { Component } from '@angular/core' @@ -202,7 +202,7 @@ export class AuthComponent { ### Account page Users also need a way to edit their profile details and manage their accounts after signing in. -Create an **AccountComponent** with the `ng g c account` Angular CLI command. +Create an `AccountComponent` with the `ng g c account` Angular CLI command. ```ts src/app/account/account.component.ts import { Component, Input, OnInit } from '@angular/core' @@ -326,7 +326,7 @@ export class AccountComponent implements OnInit { ### Launch! -Now that we have all the components in place, let's update **AppComponent**: +Now that we have all the components in place, let's update `AppComponent`: ```ts src/app/app.component.ts import { Component, OnInit } from '@angular/core' @@ -397,7 +397,7 @@ Every Supabase project is configured with [Storage](/docs/guides/storage) for ma ### Create an upload widget Let's create an avatar for the user so that they can upload a profile photo. -Create an **AvatarComponent** with `ng g c avatar` Angular CLI command. +Create an `AvatarComponent` with `ng g c avatar` Angular CLI command. ```ts src/app/avatar/avatar.component.ts import { Component, EventEmitter, Input, Output } from '@angular/core' @@ -492,7 +492,7 @@ export class AvatarComponent { ### Add the new widget -And then we can add the widget on top of the **AccountComponent** HTML template: +And then we can add the widget on top of the `AccountComponent` HTML template: ```html src/app/account.component.html @@ -501,7 +501,7 @@ And then we can add the widget on top of the **AccountComponent** HTML template: ``` -And add an `updateAvatar` function along with an `avatarUrl` getter to the **AccountComponent** typescript file: +And add an `updateAvatar` function along with an `avatarUrl` getter to the `AccountComponent` typescript file: ```ts src/app/account.component.ts @Component({ diff --git a/apps/docs/content/guides/getting-started/tutorials/with-flutter.mdx b/apps/docs/content/guides/getting-started/tutorials/with-flutter.mdx index 64b1e2e1a06..3bedc966dc8 100644 --- a/apps/docs/content/guides/getting-started/tutorials/with-flutter.mdx +++ b/apps/docs/content/guides/getting-started/tutorials/with-flutter.mdx @@ -63,7 +63,7 @@ That is it on Supabase's end and the rest are platform specific settings: Edit the `ios/Runner/Info.plist` file. -Add CFBundleURLTypes to enable deep linking: +Add `CFBundleURLTypes` to enable deep linking: ```xml ios/Runner/Info.plist" diff --git a/apps/docs/content/guides/getting-started/tutorials/with-ionic-angular.mdx b/apps/docs/content/guides/getting-started/tutorials/with-ionic-angular.mdx index b22f2f867d3..09c3b87a039 100644 --- a/apps/docs/content/guides/getting-started/tutorials/with-ionic-angular.mdx +++ b/apps/docs/content/guides/getting-started/tutorials/with-ionic-angular.mdx @@ -48,7 +48,7 @@ export const environment = { } ``` -Now that we have the API credentials in place, let's create a **SupabaseService** with `ionic g s supabase` to initialize the Supabase client and implement functions to communicate with the Supabase API. +Now that we have the API credentials in place, let's create a `SupabaseService` with `ionic g s supabase` to initialize the Supabase client and implement functions to communicate with the Supabase API. ```ts src/app/supabase.service.ts import { Injectable } from '@angular/core' @@ -136,7 +136,7 @@ export class SupabaseService { ### Set up a login route Let's set up a route to manage logins and signups. We'll use Magic Links so users can sign in with their email without using passwords. -Create a **LoginPage** with the `ionic g page login` Ionic CLI command. +Create a `LoginPage` with the `ionic g page login` Ionic CLI command. @@ -204,7 +204,7 @@ export class LoginPage { ### Account page After a user is signed in, we can allow them to edit their profile details and manage their account. -Create an **AccountComponent** with `ionic g page account` Ionic CLI command. +Create an `AccountComponent` with `ionic g page account` Ionic CLI command. ```ts src/app/account.page.ts import { Component, OnInit } from '@angular/core' @@ -310,7 +310,7 @@ export class AccountPage implements OnInit { ### Launch! -Now that we have all the components in place, let's update **AppComponent**: +Now that we have all the components in place, let's update `AppComponent`: ```ts src/app/app.component.ts import { Component } from '@angular/core' @@ -341,7 +341,7 @@ export class AppComponent { } ``` -Then update the **AppRoutingModule** +Then update the `AppRoutingModule` ```ts src/app/app-routing.module.ts" import { NgModule } from '@angular/core' @@ -393,7 +393,7 @@ First, install two packages in order to interact with the user's camera. npm install @ionic/pwa-elements @capacitor/camera ``` -[CapacitorJS](https://capacitorjs.com) is a cross-platform native runtime from Ionic that enables web apps to be deployed through the app store and provides access to native device API. +[Capacitor](https://capacitorjs.com) is a cross-platform native runtime from Ionic that enables web apps to be deployed through the app store and provides access to native device API. Ionic PWA elements is a companion package that will polyfill certain browser APIs that provide no user interface with custom Ionic UI. @@ -417,7 +417,7 @@ platformBrowserDynamic() .catch((err) => console.log(err)) ``` -Then create an **AvatarComponent** with this Ionic CLI command: +Then create an `AvatarComponent` with this Ionic CLI command: ```bash ionic g component avatar --module=/src/app/account/account.module.ts --create-module @@ -536,7 +536,7 @@ export class AvatarComponent { ### Add the new widget -And then, we can add the widget on top of the **AccountComponent** HTML template: +And then, we can add the widget on top of the `AccountComponent` HTML template: ```ts src/app/account.component.ts template: ` diff --git a/apps/docs/content/guides/getting-started/tutorials/with-ionic-react.mdx b/apps/docs/content/guides/getting-started/tutorials/with-ionic-react.mdx index cbfc4db3f49..5ad2106479f 100644 --- a/apps/docs/content/guides/getting-started/tutorials/with-ionic-react.mdx +++ b/apps/docs/content/guides/getting-started/tutorials/with-ionic-react.mdx @@ -363,7 +363,7 @@ First install two packages in order to interact with the user's camera. npm install @ionic/pwa-elements @capacitor/camera ``` -[CapacitorJS](https://capacitorjs.com) is a cross platform native runtime from Ionic that enables web apps to be deployed through the app store and provides access to native device API. +[Capacitor](https://capacitorjs.com) is a cross platform native runtime from Ionic that enables web apps to be deployed through the app store and provides access to native device API. Ionic PWA elements is a companion package that will polyfill certain browser APIs that provide no user interface with custom Ionic UI. @@ -390,7 +390,7 @@ serviceWorkerRegistration.unregister() reportWebVitals() ``` -Then create an **AvatarComponent**. +Then create an `AvatarComponent`. ```jsx src/components/Avatar.tsx import { IonIcon } from '@ionic/react'; diff --git a/apps/docs/content/guides/getting-started/tutorials/with-ionic-vue.mdx b/apps/docs/content/guides/getting-started/tutorials/with-ionic-vue.mdx index 00b85b6aa6f..58388b7796c 100644 --- a/apps/docs/content/guides/getting-started/tutorials/with-ionic-vue.mdx +++ b/apps/docs/content/guides/getting-started/tutorials/with-ionic-vue.mdx @@ -396,7 +396,7 @@ First install two packages in order to interact with the user's camera. npm install @ionic/pwa-elements @capacitor/camera ``` -[CapacitorJS](https://capacitorjs.com) is a cross platform native runtime from Ionic that enables web apps to be deployed through the app store and provides access to native device API. +[Capacitor](https://capacitorjs.com) is a cross-platform native runtime from Ionic that enables web apps to be deployed through the app store and provides access to native device API. Ionic PWA elements is a companion package that will polyfill certain browser APIs that provide no user interface with custom Ionic UI. @@ -423,7 +423,7 @@ router.isReady().then(() => { }) ``` -Then create an **AvatarComponent**. +Then create an `AvatarComponent`. ```html src/components/Avatar.vue