Files
supabase/apps/studio/data/content/content-infinite-query.ts
T
Charis 7798e42435 feat(studio): notebook read tools (#48908)
## Summary
- Adds `list_notebooks` (cursor-paginated) and `get_notebook` AI tools
in `lib/ai/tools/notebook-tools.ts`, modeled directly on
`report-tools.ts`: server-side `getContent`/`getNotebook` with the
`authorization` header forwarded, zod-validated input.
- `get_notebook` resolves every cell and exposes `unchecked_sql` as a
plain `sql` field for the agent to read — display only, per the
`safe-sql-execution` skill; nothing here executes SQL.
- Registers both tools in `lib/ai/tools/index.ts` (same platform branch
as reports) and in `lib/ai/tool-filter.ts`'s `toolSetValidationSchema` +
`TOOL_CATEGORY_MAP` (`SCHEMA` tier).
- Adds an optional `headers` param to `content-infinite-query.ts`'s
`getContent`, mirroring the sibling `content-query.ts`, so the
cursor-paginated fetch can carry the `Authorization` header from a
server context.
- New tools are behind the Explorer feature flag.

Stacked on #48907 (1.4 — notebook query and mutation hooks), per the
Notebooks implementation plan (stack 2.1).

Resolves FE-4081
Resolves FE-4080

## Test plan
- [x] `pnpm exec tsc --noEmit` — no new errors
- [x] `pnpm exec vitest run lib/ai/tools/notebook-tools.test.ts
lib/ai/tools/index.test.ts lib/ai/tools/report-tools.test.ts
data/content/notebooks` — 36/36 passing
- [x] `pnpm --filter studio run lint` — no new warnings
- [x] `pnpm exec prettier --check` on changed files — clean

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
  * Added AI tools to list project notebooks with pagination.
* Added AI support for retrieving notebook markdown and resolved SQL
cell content.
  * Notebook tools now respect project and authorization context.
* Notebook features are available only when Explorer access is enabled.
  * Content requests can forward custom request headers.

* **Tests**
* Added coverage for notebook tools, Explorer access, feature flags,
authorization, pagination, and error handling.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-11 08:40:51 -04:00

79 lines
2.2 KiB
TypeScript

import { InfiniteData, useInfiniteQuery } from '@tanstack/react-query'
import { Content, ContentType } from './content-query'
import { remapSqlContentFields } from './content-remap'
import { contentKeys } from './keys'
import { get, handleError } from '@/data/fetchers'
import { UseCustomInfiniteQueryOptions } from '@/types'
interface GetContentVariables {
projectRef?: string
cursor?: string | undefined
type: ContentType
name?: string
limit?: number
sort?: 'name' | 'inserted_at'
}
export async function getContent(
{ projectRef, type, name, limit = 10, sort, cursor }: GetContentVariables,
signal?: AbortSignal,
headers?: HeadersInit
) {
if (typeof projectRef === 'undefined') {
throw new Error('projectRef is required for getContent')
}
const { data, error } = await get('/platform/projects/{ref}/content', {
params: {
path: { ref: projectRef },
query: {
// TODO — Charis 2026-08-06
// Cast until the generated query param type picks up 'notebook' (see ContentBase in
// content-query.ts)
type: type as 'sql' | 'report' | 'log_sql',
name,
sort_by: sort,
limit: limit.toString(),
cursor,
},
},
headers,
signal,
})
if (error) handleError(error)
return {
cursor: data.cursor,
content: remapSqlContentFields(data.data as unknown as Content[]),
}
}
export type ContentData = Awaited<ReturnType<typeof getContent>>
export type ContentError = unknown
export const useContentInfiniteQuery = <TData = ContentData>(
{ projectRef, type, name, limit, sort }: GetContentVariables,
{
enabled = true,
...options
}: UseCustomInfiniteQueryOptions<
ContentData,
ContentError,
InfiniteData<TData>,
readonly unknown[],
string | undefined
> = {}
) => {
return useInfiniteQuery({
queryKey: contentKeys.infiniteList(projectRef, { type, name, limit, sort }),
queryFn: ({ signal, pageParam }) =>
getContent({ projectRef, type, name, limit, sort, cursor: pageParam }, signal),
enabled: enabled && typeof projectRef !== 'undefined',
initialPageParam: undefined,
getNextPageParam: (lastPage) => lastPage.cursor,
...options,
})
}