refactor: Standardizes the types so that it is more inline with the other APIs

schema_name -> schema

Author: kiwicopple

dist/api/types.js

@@ -65,6 +65,6 @@ router.get('/', function (req, res) { return __awaiter(void 0, void 0, void 0, f
     });
 }); });
 var removeSystemSchemas = function (data) {
-    return data.filter(function (x) { return !schemas_1.DEFAULT_SYSTEM_SCHEMAS.includes(x.schema_name); });
+    return data.filter(function (x) { return !schemas_1.DEFAULT_SYSTEM_SCHEMAS.includes(x.schema); });
 };
 module.exports = router;

dist/lib/sql/types/list.sql

@@ -1,13 +1,9 @@
 SELECT 
+(t.typname || '.' || n.nspname) as type_id,
 t.typname  AS name,
+n.nspname as schema,
 pg_catalog.Format_type ( t.oid, NULL ) AS format,
-n.nspname as schema_name,
 pg_catalog.obj_description ( t.oid, 'pg_type' ) AS description,
-CASE
-	WHEN t.typrelid != 0 THEN Cast ( 'tuple' AS pg_catalog.TEXT )
-	WHEN t.typlen < 0 THEN Cast ( 'var' AS pg_catalog.TEXT )
-	ELSE Cast ( t.typlen AS pg_catalog.TEXT )
-END AS size,
 array (
 	select   e.enumlabel
 	FROM     pg_catalog.pg_enum e
@@ -24,6 +20,4 @@ and NOT EXISTS (
 	SELECT 1
 	FROM pg_catalog.pg_type el
 	WHERE el.oid = t.typelem AND el.typarray = t.oid 
-)
-AND pg_catalog.pg_type_is_visible ( t.oid )
-ORDER BY 1, 2; 
+); 

src/api/types.ts

@@ -20,7 +20,7 @@ router.get('/', async (req, res) => {
 
 
 const removeSystemSchemas = (data: Types.Type[]) => {
-  return data.filter((x) => !DEFAULT_SYSTEM_SCHEMAS.includes(x.schema_name))
+  return data.filter((x) => !DEFAULT_SYSTEM_SCHEMAS.includes(x.schema))
 }
 
 

src/lib/interfaces/types.ts

@@ -1,12 +1,12 @@
 export namespace Types {
 
   export interface Type {
+    type_id: string
     name: string
+    schema: string
     format: string
-    schema_name: string
     description: string
-    size: string
-    enums: string
+    enums: string[]
   }
 
 

src/lib/sql/types/list.sql

@@ -1,13 +1,9 @@
 SELECT 
+(t.typname || '.' || n.nspname) as type_id,
 t.typname  AS name,
+n.nspname as schema,
 pg_catalog.Format_type ( t.oid, NULL ) AS format,
-n.nspname as schema_name,
 pg_catalog.obj_description ( t.oid, 'pg_type' ) AS description,
-CASE
-	WHEN t.typrelid != 0 THEN Cast ( 'tuple' AS pg_catalog.TEXT )
-	WHEN t.typlen < 0 THEN Cast ( 'var' AS pg_catalog.TEXT )
-	ELSE Cast ( t.typlen AS pg_catalog.TEXT )
-END AS size,
 array (
 	select   e.enumlabel
 	FROM     pg_catalog.pg_enum e
@@ -24,6 +20,4 @@ and NOT EXISTS (
 	SELECT 1
 	FROM pg_catalog.pg_type el
 	WHERE el.oid = t.typelem AND el.typarray = t.oid 
-)
-AND pg_catalog.pg_type_is_visible ( t.oid )
-ORDER BY 1, 2; 
+); 

test/integration/index.spec.js

@@ -103,17 +103,17 @@ describe('/types', () => {
   it('GET', async () => {
     const res = await axios.get(`${URL}/types`)
     // console.log('res.data', res.data)
-    const datum = res.data.find((x) => x.schema_name == 'public')
-    const notIncluded = res.data.find((x) => x.schema_name == 'pg_toast')
+    const datum = res.data.find((x) => x.schema == 'public')
+    const notIncluded = res.data.find((x) => x.schema == 'pg_toast')
     assert.equal(res.status, STATUS.SUCCESS)
     assert.equal(true, !!datum)
     assert.equal(true, !notIncluded)
   })
   it('GET with system types', async () => {
     const res = await axios.get(`${URL}/types?includeSystemSchemas=true`)
     // console.log('res.data', res.data)
-    const datum = res.data.find((x) => x.schema_name == 'public')
-    const included = res.data.find((x) => x.schema_name == 'pg_catalog')
+    const datum = res.data.find((x) => x.schema == 'public')
+    const included = res.data.find((x) => x.schema == 'pg_catalog')
     assert.equal(res.status, STATUS.SUCCESS)
     assert.equal(true, !!datum)
     assert.equal(true, !!included)