| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156 |
- // @ts-nocheck
- import { PermissionAction } from '@supabase/shared-types/out/constants'
- import { useParams } from 'common'
- import { Copy } from 'lucide-react'
- import { useEffect, useState } from 'react'
- import { Button, copyToClipboard } from 'ui'
- import { Input } from 'ui-patterns/DataInputs/Input'
- import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
- import ContentSnippet from '../ContentSnippet'
- import { DOCS_CONTENT } from '../ProjectAPIDocs.constants'
- import type { ContentProps } from './Content.types'
- import { getKeys, useAPIKeysQuery } from '@/data/api-keys/api-keys-query'
- import { useProjectSettingsV2Query } from '@/data/config/project-settings-v2-query'
- import { useSendEventMutation } from '@/data/telemetry/send-event-mutation'
- import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
- import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
- export const Introduction = ({ showKeys, language, apikey, endpoint }: ContentProps) => {
- const { ref } = useParams()
- const { can: canReadAPIKeys } = useAsyncCheckPermissions(PermissionAction.SECRETS_READ, '*')
- const { data: apiKeys } = useAPIKeysQuery({ projectRef: ref }, { enabled: canReadAPIKeys })
- useProjectSettingsV2Query({ projectRef: ref })
- const { data: org } = useSelectedOrganizationQuery()
- const { mutate: sendEvent } = useSendEventMutation()
- const [copied, setCopied] = useState<'anon' | 'service'>()
- useEffect(() => {
- if (copied !== undefined) setTimeout(() => setCopied(undefined), 2000)
- }, [copied])
- const { anonKey, serviceKey } = getKeys(apiKeys)
- const anonApiKey = anonKey?.api_key
- const serviceApiKey = serviceKey?.api_key ?? 'BRIVEN_CLIENT_SERVICE_KEY'
- return (
- <>
- <ContentSnippet
- selectedLanguage={language}
- apikey={apikey}
- endpoint={endpoint}
- snippet={DOCS_CONTENT.init}
- >
- <div className="px-4 space-y-6">
- <div className="flex flex-col space-x-4 mt-8">
- <FormItemLayout isReactForm={false} layout="horizontal" label="Project URL">
- <Input disabled readOnly copy size="small" value={endpoint} className="w-full" />
- </FormItemLayout>
- </div>
- <div className="flex flex-col space-x-4">
- <FormItemLayout
- isReactForm={false}
- layout="horizontal"
- label="Client API key"
- description="This key is safe to use in a browser if you have enabled Row Level Security (RLS) for your tables and configured policies."
- >
- <Input
- disabled
- readOnly
- size="small"
- value={showKeys ? apikey : 'Reveal API keys via dropdown in the header'}
- actions={[
- <Button
- key="copy"
- type="default"
- icon={<Copy />}
- onClick={() => {
- setCopied('anon')
- copyToClipboard(anonApiKey ?? 'BRIVEN_CLIENT_ANON_KEY')
- sendEvent({
- action: 'api_docs_code_copy_button_clicked',
- properties: {
- title: 'Client API key',
- selectedLanguage: language,
- },
- groups: {
- project: ref ?? 'Unknown',
- organization: org?.slug ?? 'Unknown',
- },
- })
- }}
- >
- {copied === 'anon' ? 'Copied' : 'Copy'}
- </Button>,
- ]}
- />
- </FormItemLayout>
- </div>
- <div className="flex flex-col space-x-4">
- <FormItemLayout
- isReactForm={false}
- layout="horizontal"
- label="Service key"
- description={
- <p>
- This key has the ability to bypass Row Level Security.{' '}
- <span className="text-amber-900">Never share it publicly.</span>
- </p>
- }
- >
- <Input
- disabled
- readOnly
- size="small"
- value={
- showKeys
- ? (serviceApiKey ?? 'BRIVEN_CLIENT_SERVICE_KEY')
- : 'Reveal API keys via dropdown in the header'
- }
- actions={[
- <Button
- key="copy"
- type="default"
- icon={<Copy />}
- onClick={() => {
- setCopied('service')
- copyToClipboard(serviceApiKey)
- sendEvent({
- action: 'api_docs_code_copy_button_clicked',
- properties: {
- title: 'Service key',
- selectedLanguage: language,
- },
- groups: {
- project: ref ?? 'Unknown',
- organization: org?.slug ?? 'Unknown',
- },
- })
- }}
- >
- {copied === 'service' ? 'Copied' : 'Copy'}
- </Button>,
- ]}
- />
- </FormItemLayout>
- </div>
- </div>
- </ContentSnippet>
- <ContentSnippet
- selectedLanguage={language}
- apikey={apikey}
- endpoint={endpoint}
- snippet={DOCS_CONTENT.clientApiKeys}
- />
- <ContentSnippet
- selectedLanguage={language}
- apikey={showKeys ? serviceApiKey : 'BRIVEN_CLIENT_SERVICE_KEY'}
- endpoint={endpoint}
- snippet={DOCS_CONTENT.serviceApiKeys}
- />
- </>
- )
- }
|