Merge pull request #187 from UN-OCHA/HPC-8569-getTableColumns

HPC-8569 get table columns function

src/util/types.ts

@@ -1,3 +1,5 @@
+import type { FieldDefinition } from '../db/util/model-definition';
+
 /**
  * This type allows us to restrict assignments of other types.
  *
@@ -21,3 +23,30 @@ export type Brand<T, S extends { s: symbol }, Label extends string = ''> = T & {
 
 export const createBrandedValue = <T, B extends Brand<T, any, any>>(v: T): B =>
   v as unknown as B;
+
+export const getTableColumns = <
+  T extends { _internals: { fields: FieldDefinition } },
+>(
+  table: T
+): string[] => {
+  const {
+    generated,
+    generatedCompositeKey,
+    nonNullWithDefault,
+    required,
+    optional,
+    accidentallyOptional,
+  } = table._internals.fields;
+
+  // Collect columns from all subsets
+  const columns = [
+    ...Object.keys(generated ?? {}),
+    ...Object.keys(generatedCompositeKey ?? {}),
+    ...Object.keys(nonNullWithDefault ?? {}),
+    ...Object.keys(required ?? {}),
+    ...Object.keys(optional ?? {}),
+    ...Object.keys(accidentallyOptional ?? {}),
+  ];
+
+  return columns;
+};

tests/utils/types.spec.ts

@@ -0,0 +1,34 @@
+import { getTableColumns } from '../../src/util/types';
+import ContextProvider from '../testContext';
+
+const context = ContextProvider.Instance;
+
+describe("Test 'getTableColumns' function", () => {
+  it('should return the columns of a table', () => {
+    const columns = getTableColumns(context.models.emergency);
+
+    expect(columns).toBeDefined();
+    expect(columns).toBeInstanceOf(Array);
+    const expectedColumns = [
+      'id',
+      'name',
+      'date',
+      'restricted',
+      'active',
+      'createdAt',
+      'updatedAt',
+      'description',
+      'glideId',
+      'levelThree',
+    ];
+    expectedColumns.forEach((column) => {
+      expect(columns).toContain(column);
+    });
+  });
+  it('should return an empty array if the table has no columns', () => {
+    const columns = getTableColumns({ _internals: { fields: {} } });
+    expect(columns).toBeDefined();
+    expect(columns).toBeInstanceOf(Array);
+    expect(columns).toHaveLength(0);
+  });
+});