Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

studio: add SafeSql foundation utilities (1/7) (#45897)

Charis2d2cc95caa9e
diff --git a/apps/studio/components/ui/SafeSqlInput.tsx b/apps/studio/components/ui/SafeSqlInput.tsx
new file mode 100644
index 00000000000..1dbb6631051
--- /dev/null
+++ b/apps/studio/components/ui/SafeSqlInput.tsx
@@ -0,0 +1,15 @@
+import { rawSql, type SafeSqlFragment } from '@supabase/pg-meta'
+import type { ChangeEvent, ComponentProps } from 'react'
+import { Input } from 'ui-patterns/DataInputs/Input'
+
+type InputProps = ComponentProps<typeof Input>
+
+export type SafeSqlInputProps = Omit<InputProps, 'placeholder' | 'value' | 'onChange'> & {
+ placeholder?: SafeSqlFragment
+ value: SafeSqlFragment
+ onChange?: (event: ChangeEvent<HTMLInputElement>, value: SafeSqlFragment) => void
+}
+
+export const SafeSqlInput = ({ onChange, ...props }: SafeSqlInputProps) => (
+ <Input {...props} onChange={(event) => onChange?.(event, rawSql(event.target.value))} />
+)
diff --git a/apps/studio/lib/postgres-types.ts b/apps/studio/lib/postgres-types.ts
new file mode 100644
index 00000000000..50a5c01572a
--- /dev/null
+++ b/apps/studio/lib/postgres-types.ts
@@ -0,0 +1,12 @@
+import type { PGColumn, PGTable, SafeSqlFragment } from '@supabase/pg-meta'
+
+export type SafePostgresColumn = PGColumn & {
+ check: SafeSqlFragment | null
+ // Present when sourced from pg-meta's SQL queries (e.g. `pgMeta.tables.retrieve`), absent
+ // from the legacy `/platform/pg-meta/{ref}/tables` REST endpoint.
+ format_schema?: string
+}
+
+export type SafePostgresTable = Omit<PGTable, 'columns'> & {
+ columns?: SafePostgresColumn[] | undefined
+}
diff --git a/apps/studio/lib/sql.ts b/apps/studio/lib/sql.ts
new file mode 100644
index 00000000000..45a76ac9778
--- /dev/null
+++ b/apps/studio/lib/sql.ts
@@ -0,0 +1,13 @@
+import type { SafeSqlFragment } from '@supabase/pg-meta'
+
+export function trimSafeSqlFragment(fragment: SafeSqlFragment): SafeSqlFragment
+export function trimSafeSqlFragment(fragment: SafeSqlFragment | null): SafeSqlFragment | null
+export function trimSafeSqlFragment(
+ fragment: SafeSqlFragment | undefined
+): SafeSqlFragment | undefined
+export function trimSafeSqlFragment(
+ fragment: SafeSqlFragment | null | undefined
+): SafeSqlFragment | null | undefined {
+ if (fragment == null) return fragment
+ return fragment.trim() as SafeSqlFragment
+}
diff --git a/apps/studio/lib/type-helpers.ts b/apps/studio/lib/type-helpers.ts
index 02b486eac21..a7310684875 100644
--- a/apps/studio/lib/type-helpers.ts
+++ b/apps/studio/lib/type-helpers.ts
@@ -2,8 +2,12 @@ export type PlainObject<Value = unknown> = Record<string | number | symbol, Valu
export type Prettify<T> = { [K in keyof T]: T[K] } & {}
-export type DeepReadonly<T> = T extends (infer R)[]
- ? ReadonlyArray<DeepReadonly<R>>
- : T extends Object
- ? { readonly [K in keyof T]: DeepReadonly<T[K]> }
- : T
+type Primitive = string | number | bigint | boolean | symbol | null | undefined
+
+export type DeepReadonly<T> = T extends Primitive
+ ? T
+ : T extends (infer R)[]
+ ? ReadonlyArray<DeepReadonly<R>>
+ : T extends object
+ ? { readonly [K in keyof T]: DeepReadonly<T[K]> }
+ : T