refactor: remove userFields (#791)

* refactor: process custom fields on cache generate

* refactor: remove userFields

packages/utils/src/feature/spreadsheet-import/__tests__/spreadsheetImport.test.ts

@@ -0,0 +1,54 @@
+import { isImportMap } from '../spreadsheetImport';
+
+describe('isImportMap()', () => {
+  it('validates a v3 default import map', () => {
+    const v3ImportMap = {
+      worksheet: 'event schedule',
+      timeStart: 'time start',
+      timeEnd: 'time end',
+      duration: 'duration',
+      cue: 'cue',
+      title: 'title',
+      presenter: 'presenter',
+      subtitle: 'subtitle',
+      isPublic: 'public',
+      skip: 'skip',
+      note: 'notes',
+      colour: 'colour',
+      endAction: 'end action',
+      timerType: 'timer type',
+      timeWarning: 'warning time',
+      timeDanger: 'danger time',
+      custom: {},
+    };
+
+    expect(isImportMap(v3ImportMap)).toBe(true);
+  });
+
+  it('handles custom properties', () => {
+    const v3ImportMap = {
+      worksheet: 'event schedule',
+      timeStart: 'time start',
+      timeEnd: 'time end',
+      duration: 'duration',
+      cue: 'cue',
+      title: 'title',
+      presenter: 'presenter',
+      subtitle: 'subtitle',
+      isPublic: 'public',
+      skip: 'skip',
+      note: 'notes',
+      colour: 'colour',
+      endAction: 'end action',
+      timerType: 'timer type',
+      timeWarning: 'warning time',
+      timeDanger: 'danger time',
+      custom: {
+        userDefined: 'userDefined',
+        anotherOne: 'anotherOne',
+      },
+    };
+
+    expect(isImportMap(v3ImportMap)).toBe(true);
+  });
+});

packages/utils/src/feature/spreadsheet-import/spreadsheetImport.ts

@@ -0,0 +1,37 @@
+export type ImportOptions = keyof typeof defaultImportMap | 'custom';
+export type ImportCustom = Record<string, string>;
+export type ImportMap = typeof defaultImportMap & { custom: ImportCustom };
+
+// Record of ontime name and import name
+export const defaultImportMap = {
+  worksheet: 'event schedule',
+  timeStart: 'time start',
+  timeEnd: 'time end',
+  duration: 'duration',
+  cue: 'cue',
+  title: 'title',
+  presenter: 'presenter',
+  subtitle: 'subtitle',
+  isPublic: 'public',
+  skip: 'skip',
+  note: 'notes',
+  colour: 'colour',
+  endAction: 'end action',
+  timerType: 'timer type',
+  timeWarning: 'warning time',
+  timeDanger: 'danger time',
+  custom: {},
+};
+
+/**
+ * Validates whether an object is an Import Map
+ * @param obj
+ */
+export function isImportMap(obj: unknown): obj is ImportMap {
+  if (typeof obj !== 'object' || obj === null) {
+    return false;
+  }
+
+  const keys = Object.keys(defaultImportMap);
+  return keys.every((key) => Object.hasOwn(obj, key));
+}