Files
supabase/studio/components/interfaces/ProjectAPIDocs/Content/Entity.tsx
T
8057309e51 chore: upgrade next 13 + react 18 (#17839)
* update deps + image codemod (studio)

* update next links (studio)

* update deps

* update links (ui)

* remove next-transpile-modules

* move next-themes dependency

* chore: update ConfirmDialog

* chore: remove old ConfirmModal js file. migrated to TS

* dependency wrangling

* remove empty page

* update next links (www)

* First run bump react-data-grid-v7 beta 4

* fix package-lock.json

* more deps wrangling

* update recharts

* update sentry options

* fix some broken things in www

* studio fixes

* fix graphiql

* fix studio build

* fix menu hydration

* small build error

* update turbo

* fix www typescript errors

* docs image codemod

* links codemod docs

* fix docs typescript errors

* move useConsent to ui to prevent circular deps

* Fix links

* Fix homepage

* Fix links

* move studio/ to apps/

* Revert "move studio/ to apps/"

This reverts commit 1b0a985fcb.

* disable outputFileTracingRoot

* remove outputFileTracingRoot

* fix homepage product cards

* fix PrivacySettings links

* Fix links

* Fix the build for www.

* Minor fixes for JWTGenerator.

* Fix the docs and ui tests.

* Revert codehike back to 0.8.3

* remove ConfirmAlert()

* reenable babel because mobx hates me

* fix blog image and comparison page avatar

* Fix svg errors

* update image synthax

* Fix code hike

* Move the button in a div so that it doesn't inherit its parent height and make the button look weird.

* When components are defined in a component, they get recreated on each render. This makes them unstable in certain cases and causes infinite rerenders.

* Replace the next/head usage with next/script.

* Chore/upgrade next 13 fix table editor (#18431)

* fix table editor styling and fix row deletion logic

* Fix deleting selected rows from header, and fix checkboxes not clearing up

* Fix deleting all rows when filter applied, and fix deleting all rows

* Fix grid size styling issue

* Fix TS error

* Hydration errors

* studio org pages fixes

* fix more studio links

* audit logs fixes

* dropdown icon styling fixes

* fix some images in www

* upgrade to next 14

* try new sentry wrapper for api

* see if this is even invoked

* Revert "see if this is even invoked"

This reverts commit 86c3973ffa.

* Revert "try new sentry wrapper for api"

This reverts commit f67623ebad.

* Revert "upgrade to next 14"

This reverts commit a24dd6131e.

* chore: allow node version 19/20

* Try to fix the LogTable so that it renders with the newer "react-data-grid" version.

* Fix type errors in the log renderer code.

* Fix the replication screen.

* Add the CSS for the GraphiQL.

* Fix SQL editor results rendering

* Lint

* Fix SQL editor results height issue

* Fix auth RLS not invalidating RQ when toggling RLS

* Fix database tables new/edit column regressed

* Fix migrations page empty state if migrations schema not yet created

* Fix API side panel docs temp remove postgrest text for column description PK and FK

* Fix + improve timeout handling in SQL editor

---------

Co-authored-by: Jonathan Summers-Muir <MildTomato@users.noreply.github.com>
Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
Co-authored-by: Francesco Sansalvadore <f.sansalvadore@gmail.com>
Co-authored-by: Terry Sutton <saltcod@gmail.com>
Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
Co-authored-by: Kevin Grüneberg <k.grueneberg1994@gmail.com>
2023-10-31 05:51:46 +00:00

139 lines
4.3 KiB
TypeScript

import { useParams } from 'common'
import Table from 'components/to-be-cleaned/Table'
import { useProjectJsonSchemaQuery } from 'data/docs/project-json-schema-query'
import { useAppStateSnapshot } from 'state/app-state'
import { DOCS_RESOURCE_CONTENT } from '../ProjectAPIDocs.constants'
import ResourceContent from '../ResourceContent'
import { ContentProps } from './Content.types'
import { tempRemovePostgrestText } from './Content.utils'
function getColumnType(type: string, format: string) {
// json and jsonb both have type=undefined, so check format instead
if (type === undefined && (format === 'jsonb' || format === 'json')) return 'json'
switch (type) {
case 'string':
return 'string'
case 'integer':
return 'number'
case 'json':
return 'json'
case 'number':
return 'number'
case 'boolean':
return 'boolean'
default:
return type
}
}
const Entity = ({ language, apikey = '', endpoint = '' }: ContentProps) => {
const { ref } = useParams()
const snap = useAppStateSnapshot()
const resource = snap.activeDocsSection[1]
const { data: jsonSchema } = useProjectJsonSchemaQuery({ projectRef: ref })
const definition = jsonSchema?.definitions?.[resource]
const columns =
definition !== undefined
? Object.entries(definition.properties).map(([id, val]: any) => ({
...val,
id,
required: definition.required.includes(id),
}))
: []
if (resource === undefined) return null
return (
<div className="divide-y">
<div className="space-y-1 px-4 py-6">
<h2 className="text-xl">{resource}</h2>
<p className="text-sm text-foreground-light">
{definition?.description ?? 'No description available'}
</p>
</div>
<div className="space-y-2 px-4 py-4">
<p className="text-sm text-foreground-light">Columns</p>
<Table
head={[
<Table.th key="name">Name</Table.th>,
<Table.th key="format">Format</Table.th>,
<Table.th key="type">Type</Table.th>,
<Table.th key="description">Description</Table.th>,
]}
body={columns.map((column) => {
const formattedColumnType = getColumnType(column.type, column.format)
return (
<Table.tr key={column.id}>
<Table.td title={column.id}>{column.id}</Table.td>
<Table.td title={column.format}>
<p className="truncate">{column.format}</p>
</Table.td>
<Table.td title={formattedColumnType}>{formattedColumnType}</Table.td>
<Table.td title={column.description}>
{tempRemovePostgrestText(column.description ?? '').trim()}
</Table.td>
</Table.tr>
)
})}
/>
</div>
<ResourceContent
selectedLanguage={language}
snippet={DOCS_RESOURCE_CONTENT.readRows}
codeSnippets={DOCS_RESOURCE_CONTENT.readRows.code({
resourceId: resource,
endpoint,
apikey,
})}
/>
<ResourceContent
selectedLanguage={language}
snippet={DOCS_RESOURCE_CONTENT.filtering}
codeSnippets={DOCS_RESOURCE_CONTENT.filtering.code({
resourceId: resource,
endpoint,
apikey,
})}
/>
<ResourceContent
selectedLanguage={language}
snippet={DOCS_RESOURCE_CONTENT.insertRows}
codeSnippets={DOCS_RESOURCE_CONTENT.insertRows.code({
resourceId: resource,
endpoint,
apikey,
})}
/>
<ResourceContent
selectedLanguage={language}
snippet={DOCS_RESOURCE_CONTENT.updateRows}
codeSnippets={DOCS_RESOURCE_CONTENT.updateRows.code({
resourceId: resource,
endpoint,
apikey,
})}
/>
<ResourceContent
selectedLanguage={language}
snippet={DOCS_RESOURCE_CONTENT.deleteRows}
codeSnippets={DOCS_RESOURCE_CONTENT.deleteRows.code({
resourceId: resource,
endpoint,
apikey,
})}
/>
<ResourceContent
selectedLanguage={language}
snippet={DOCS_RESOURCE_CONTENT.subscribeChanges}
codeSnippets={DOCS_RESOURCE_CONTENT.subscribeChanges.code({ resourceId: resource })}
/>
</div>
)
}
export default Entity