feat: add role schema

Author: fuergaosi233

src/lib/PostgresMetaRoles.ts

@@ -1,13 +1,7 @@
 import { ident, literal } from 'pg-format'
 import { DEFAULT_ROLES } from './constants'
 import { rolesSql } from './sql'
-import { PostgresMetaResult, PostgresRole } from './types'
-export interface PostgresMetaRoleConfig {
-  // https://www.rfc-editor.org/rfc/rfc6902
-  op: 'remove' | 'add' | 'replace'
-  path: string
-  value?: string
-}
+import { PostgresMetaResult, PostgresRole, PostgresRoleCreate, PostgresRoleUpdate } from './types'
 export function changeRoleConfig2Object(config: string[]) {
   if (!config) {
     return null
@@ -115,23 +109,7 @@ WHERE
     members,
     admins,
     config,
-  }: {
-    name: string
-    is_superuser?: boolean
-    can_create_db?: boolean
-    can_create_role?: boolean
-    inherit_role?: boolean
-    can_login?: boolean
-    is_replication_role?: boolean
-    can_bypass_rls?: boolean
-    connection_limit?: number
-    password?: string
-    valid_until?: string
-    member_of?: string[]
-    members?: string[]
-    admins?: string[]
-    config?: Record<string, string>
-  }): Promise<PostgresMetaResult<PostgresRole>> {
+  }: PostgresRoleCreate): Promise<PostgresMetaResult<PostgresRole>> {
     const isSuperuserClause = is_superuser ? 'SUPERUSER' : 'NOSUPERUSER'
     const canCreateDbClause = can_create_db ? 'CREATEDB' : 'NOCREATEDB'
     const canCreateRoleClause = can_create_role ? 'CREATEROLE' : 'NOCREATEROLE'
@@ -198,20 +176,7 @@ COMMIT;`
       password,
       valid_until,
       config,
-    }: {
-      name?: string
-      is_superuser?: boolean
-      can_create_db?: boolean
-      can_create_role?: boolean
-      inherit_role?: boolean
-      can_login?: boolean
-      is_replication_role?: boolean
-      can_bypass_rls?: boolean
-      connection_limit?: number
-      password?: string
-      valid_until?: string
-      config?: PostgresMetaRoleConfig[]
-    }
+    }: PostgresRoleUpdate
   ): Promise<PostgresMetaResult<PostgresRole>> {
     const { data: old, error } = await this.retrieve({ id })
     if (error) {

src/lib/types.ts

@@ -184,6 +184,13 @@ export const postgresRelationshipSchema = Type.Object({
 })
 export type PostgresRelationship = Static<typeof postgresRelationshipSchema>
 
+export const PostgresMetaRoleConfigSchema = Type.Object({
+  op: Type.Union([Type.Literal('remove'), Type.Literal('add'), Type.Literal('replace')]),
+  path: Type.String(),
+  value: Type.Optional(Type.String()),
+})
+export type PostgresMetaRoleConfig = Static<typeof PostgresMetaRoleConfigSchema>
+
 export const postgresRoleSchema = Type.Object({
   id: Type.Integer(),
   name: Type.String(),
@@ -198,14 +205,45 @@ export const postgresRoleSchema = Type.Object({
   connection_limit: Type.Integer(),
   password: Type.String(),
   valid_until: Type.Union([Type.String(), Type.Null()]),
-  config: Type.Union([
-    Type.String(),
-    Type.Null(),
-    Type.Record(Type.String(), Type.Union([Type.String()])),
-  ]),
+  config: Type.Union([Type.String(), Type.Null(), Type.Record(Type.String(), Type.String())]),
 })
 export type PostgresRole = Static<typeof postgresRoleSchema>
 
+export const postgresRoleCreateSchema = Type.Object({
+  name: Type.String(),
+  password: Type.Optional(Type.String()),
+  inherit_role: Type.Optional(Type.Boolean()),
+  can_login: Type.Optional(Type.Boolean()),
+  is_superuser: Type.Optional(Type.Boolean()),
+  can_create_db: Type.Optional(Type.Boolean()),
+  can_create_role: Type.Optional(Type.Boolean()),
+  is_replication_role: Type.Optional(Type.Boolean()),
+  can_bypass_rls: Type.Optional(Type.Boolean()),
+  connection_limit: Type.Optional(Type.Integer()),
+  member_of: Type.Optional(Type.Array(Type.String())),
+  members: Type.Optional(Type.Array(Type.String())),
+  admins: Type.Optional(Type.Array(Type.String())),
+  valid_until: Type.Optional(Type.String()),
+  config: Type.Optional(Type.Record(Type.String(), Type.String())),
+})
+export type PostgresRoleCreate = Static<typeof postgresRoleCreateSchema>
+
+export const postgresRoleUpdateSchema = Type.Object({
+  name: Type.Optional(Type.String()),
+  password: Type.Optional(Type.String()),
+  inherit_role: Type.Optional(Type.Boolean()),
+  can_login: Type.Optional(Type.Boolean()),
+  is_superuser: Type.Optional(Type.Boolean()),
+  can_create_db: Type.Optional(Type.Boolean()),
+  can_create_role: Type.Optional(Type.Boolean()),
+  is_replication_role: Type.Optional(Type.Boolean()),
+  can_bypass_rls: Type.Optional(Type.Boolean()),
+  connection_limit: Type.Optional(Type.Integer()),
+  valid_until: Type.Optional(Type.String()),
+  config: Type.Optional(Type.Array(PostgresMetaRoleConfigSchema)),
+})
+export type PostgresRoleUpdate = Static<typeof postgresRoleUpdateSchema>
+
 export const postgresSchemaSchema = Type.Object({
   id: Type.Integer(),
   name: Type.String(),