Syntax fixes (#5367)

* Declare return types on functions

And a very few other type related minor fixes

* Minor syntax fixes

* Remove unnecessary escape chars in regexes
* Remove unnecessary awaits
* Replace deprecated req.connection with req.socket
* Replace deprecated upload with uploadOne
* Remove unnecessary eslint-disable-next-line comments
* Comment empty functions / catch or finally clauses
* Fix irregular whitespaces
* Add missing returns (null)
* Remove unreachable code
* A few logical fixes
* Remove / Handle non-null assertions which are certainly unnecessary (e.g. in
tests)

app/src/interfaces/_system/interface-options/interface-options.vue

@@ -29,6 +29,7 @@
 <script lang="ts">
 import { defineComponent, computed, inject, ref } from '@vue/composition-api';
 import { getInterfaces } from '@/interfaces';
+import { InterfaceConfig } from '@/interfaces/types';
 
 export default defineComponent({
 	props: {
@@ -49,7 +50,7 @@ export default defineComponent({
 		const selectedInterface = computed(() => {
 			if (!values.value[props.interfaceField]) return;
 
-			return interfaces.value.find((inter) => inter.id === values.value[props.interfaceField]);
+			return interfaces.value.find((inter: InterfaceConfig) => inter.id === values.value[props.interfaceField]);
 		});
 
 		return { selectedInterface, values };

app/src/interfaces/_system/interface/interface.vue

@@ -15,7 +15,7 @@
 import { defineComponent, computed, PropType, inject, ref, watch } from '@vue/composition-api';
 import i18n from '@/lang';
 import { getInterfaces } from '@/interfaces';
-import { types } from '@/types';
+import { InterfaceConfig } from '@/interfaces/types';
 
 export default defineComponent({
 	props: {
@@ -47,9 +47,11 @@ export default defineComponent({
 
 		const items = computed(() => {
 			return interfaces.value
-				.filter((inter) => inter.relational !== true && inter.system !== true)
-				.filter((inter) => selectedType.value === undefined || inter.types.includes(selectedType.value))
-				.map((inter) => {
+				.filter((inter: InterfaceConfig) => inter.relational !== true && inter.system !== true)
+				.filter(
+					(inter: InterfaceConfig) => selectedType.value === undefined || inter.types.includes(selectedType.value)
+				)
+				.map((inter: InterfaceConfig) => {
 					return {
 						text: inter.name,
 						value: inter.id,

app/src/interfaces/code/code.vue

@@ -136,7 +136,7 @@ export default defineComponent({
 					codemirror.value.setOption('mode', { name: 'javascript', json: true });
 
 					CodeMirror.registerHelper('lint', 'json', (text: string) => {
-						const found: {}[] = [];
+						const found: Record<string, any> = [];
 						const parser = jsonlint.parser;
 
 						parser.parseError = (str: string, hash: any) => {
@@ -150,7 +150,9 @@ export default defineComponent({
 						if (text.length > 0) {
 							try {
 								jsonlint.parse(text);
-							} catch (e) {}
+							} finally {
+								// Do nothing
+							}
 						}
 						return found;
 					});
@@ -273,7 +275,9 @@ export default defineComponent({
 			if (props.type === 'json') {
 				try {
 					emit('input', JSON.parse(props.template));
-				} catch {}
+				} finally {
+					// Do nothing
+				}
 			} else {
 				emit('input', props.template);
 			}

app/src/interfaces/image/image.vue

@@ -113,7 +113,7 @@ export default defineComponent({
 			if (!image.value) return null;
 			const { filesize, width, height, type } = image.value;
 
-			return `${i18n.n(width)}x${i18n.n(height)} • ${formatFilesize(filesize)} • ${type}`;
+			return `${i18n.n(width)}x${i18n.n(height)} • ${formatFilesize(filesize)} • ${type}`;
 		});
 
 		watch(

app/src/interfaces/index.ts

@@ -4,7 +4,7 @@ import { InterfaceConfig } from './types';
 let interfacesRaw: Ref<InterfaceConfig[]>;
 let interfaces: Ref<InterfaceConfig[]>;
 
-export function getInterfaces() {
+export function getInterfaces(): Record<string, Ref> {
 	if (!interfacesRaw) {
 		interfacesRaw = ref([]);
 	}

app/src/interfaces/m2a-builder/m2a-builder.vue

@@ -329,7 +329,6 @@ export default defineComponent({
 							} else {
 								val[anyRelation.value.many_field] = cloneDeep(item);
 							}
-						} else {
 						}
 
 						return val;

app/src/interfaces/many-to-many/many-to-many.vue

@@ -86,6 +86,7 @@ import useSort from './use-sort';
 import { getFieldsFromTemplate } from '@/utils/get-fields-from-template';
 import adjustFieldsForDisplays from '@/utils/adjust-fields-for-displays';
 import { usePermissionsStore, useUserStore } from '@/stores';
+import { DisplayConfig } from '@/displays/types';
 
 export default defineComponent({
 	components: { DrawerItem, DrawerCollection, Draggable },
@@ -138,7 +139,7 @@ export default defineComponent({
 			let relatedDisplayTemplate = relationCollection.value.meta?.display_template;
 			if (relatedDisplayTemplate) {
 				const regex = /({{.*?}})/g;
-				const parts = relatedDisplayTemplate.split(regex).filter((p) => p);
+				const parts = relatedDisplayTemplate.split(regex).filter((p: DisplayConfig) => p);
 
 				for (const part of parts) {
 					if (part.startsWith('{{') === false) continue;

app/src/interfaces/many-to-many/use-actions.ts

@@ -6,7 +6,7 @@ export default function useActions(
 	value: Ref<(string | number | Record<string, any>)[] | null>,
 	relation: Ref<RelationInfo>,
 	emit: (newValue: any[] | null) => void
-) {
+): Record<string, any> {
 	// Returns the junction item with the given Id.
 	function getJunctionItem(id: string | number) {
 		const { junctionPkField } = relation.value;

app/src/interfaces/many-to-many/use-edit.ts

@@ -6,7 +6,7 @@ export default function useEdit(
 	value: Ref<(string | number | Record<string, any>)[] | null>,
 	relation: Ref<RelationInfo>,
 	emit: (newVal: any[] | null) => void
-) {
+): Record<string, any> {
 	const editModalActive = ref(false);
 	const currentlyEditing = ref<string | number | null>(null);
 	const relatedPrimaryKey = ref<string | number | null>(null);

app/src/interfaces/many-to-many/use-preview.ts

@@ -14,7 +14,7 @@ export default function usePreview(
 	getUpdatedItems: () => Record<string, any>[],
 	getNewItems: () => Record<string, any>[],
 	getPrimaryKeys: () => (string | number)[]
-) {
+): Record<string, Ref> {
 	// Using a ref for the table headers here means that the table itself can update the
 	// values if it needs to. This allows the user to manually resize the columns for example
 

app/src/interfaces/many-to-many/use-relation.ts

@@ -12,7 +12,7 @@ export type RelationInfo = {
 	relationCollection: string;
 };
 
-export default function useRelation(collection: Ref<string>, field: Ref<string>) {
+export default function useRelation(collection: Ref<string>, field: Ref<string>): Record<string, any> {
 	const relationsStore = useRelationsStore();
 	const collectionsStore = useCollectionsStore();
 

app/src/interfaces/many-to-many/use-selection.ts

@@ -8,7 +8,7 @@ export default function useSelection(
 	items: Ref<Record<string, any>[]>,
 	relation: Ref<RelationInfo>,
 	emit: (newVal: any[] | null) => void
-) {
+): Record<string, any> {
 	const selectModalActive = ref(false);
 
 	const selectedPrimaryKeys = computed(() => {

app/src/interfaces/many-to-many/use-sort.ts

@@ -8,7 +8,7 @@ export default function useSort(
 	fields: Ref<string[]>,
 	items: Ref<Record<string, any>[]>,
 	emit: (newVal: any[] | null) => void
-) {
+): Record<string, any> {
 	const sort = ref<Sort>({ by: relation.value.sortField || fields.value[0], desc: false });
 
 	const sortedItems = computed(() => {

app/src/interfaces/markdown/composables/use-edit.ts

@@ -32,7 +32,7 @@ export type CustomSyntax = {
 	box: 'inline' | 'block';
 };
 
-export function useEdit(codemirror: Ref<CodeMirror.EditorFromTextArea | null>, customSyntaxBlocks: CustomSyntax[]) {
+export function useEdit(codemirror: Ref<CodeMirror.EditorFromTextArea | null>): Record<string, any> {
 	const alterations: AlterationFunctions = {
 		heading(selection, { cursorTo }, options) {
 			const level = options?.level || 3;

app/src/interfaces/markdown/markdown.vue

@@ -235,7 +235,7 @@ export default defineComponent({
 			}
 		);
 
-		const { edit } = useEdit(codemirror, props.customSyntax);
+		const { edit } = useEdit(codemirror);
 
 		const html = computed(() => {
 			let md = props.value || '';

app/src/interfaces/register.ts

@@ -4,10 +4,11 @@ import { Component } from 'vue';
 import api from '@/api';
 import { getRootPath } from '@/utils/get-root-path';
 import asyncPool from 'tiny-async-pool';
+import { InterfaceConfig } from './types';
 
 const { interfacesRaw } = getInterfaces();
 
-export async function registerInterfaces() {
+export async function registerInterfaces(): Promise<void> {
 	const context = require.context('.', true, /^.*index\.ts$/);
 
 	const modules = context
@@ -36,7 +37,7 @@ export async function registerInterfaces() {
 
 	interfacesRaw.value = modules;
 
-	interfacesRaw.value.forEach((inter) => {
+	interfacesRaw.value.forEach((inter: InterfaceConfig) => {
 		registerComponent('interface-' + inter.id, inter.component);
 
 		if (typeof inter.options !== 'function' && Array.isArray(inter.options) === false) {

app/src/interfaces/repeater/options.vue

@@ -12,7 +12,7 @@
 
 		<div class="grid-element full">
 			<p class="type-label">{{ $t('interfaces.repeater.edit_fields') }}</p>
-			<repeater v-model="repeaterValue" :template="`{{ field }} — {{ interface }}`" :fields="repeaterFields" />
+			<repeater v-model="repeaterValue" :template="`{{ field }} — {{ interface }}`" :fields="repeaterFields" />
 		</div>
 	</div>
 </template>

app/src/interfaces/wysiwyg/get-editor-styles.ts

@@ -2,7 +2,7 @@ function cssVar(name: string) {
 	return getComputedStyle(document.body).getPropertyValue(name);
 }
 
-export default function getEditorStyles(font: 'sans-serif' | 'serif' | 'monospace') {
+export default function getEditorStyles(font: 'sans-serif' | 'serif' | 'monospace'): string {
 	return `
 body {
 	color: ${cssVar('--foreground-normal')};

app/src/interfaces/wysiwyg/useImage.ts

@@ -10,7 +10,7 @@ type ImageSelection = {
 	height?: number;
 };
 
-export default function useImage(editor: Ref<any>, imageToken: Ref<string>) {
+export default function useImage(editor: Ref<any>, imageToken: Ref<string>): Record<string, any> {
 	const imageDrawerOpen = ref(false);
 	const imageSelection = ref<ImageSelection | null>(null);
 

app/src/interfaces/wysiwyg/useLink.ts

@@ -8,7 +8,7 @@ type LinkSelection = {
 	newTab: boolean;
 };
 
-export default function useLink(editor: Ref<any>) {
+export default function useLink(editor: Ref<any>): Record<string, any> {
 	const linkDrawerOpen = ref(false);
 	const linkSelection = ref<LinkSelection>({
 		url: null,

app/src/interfaces/wysiwyg/useMedia.ts

@@ -9,7 +9,7 @@ type MediaSelection = {
 	height?: number;
 };
 
-export default function useMedia(editor: Ref<any>, imageToken: Ref<string>) {
+export default function useMedia(editor: Ref<any>, imageToken: Ref<string>): Record<string, any> {
 	const mediaDrawerOpen = ref(false);
 	const mediaSelection = ref<MediaSelection | null>(null);
 	const openMediaTab = ref(['video']);

app/src/interfaces/wysiwyg/useSourceCode.ts

@@ -1,7 +1,7 @@
 import { Ref, ref } from '@vue/composition-api';
 import i18n from '@/lang';
 
-export default function useSourceCode(editor: Ref<any>) {
+export default function useSourceCode(editor: Ref<any>): Record<string, any> {
 	const codeDrawerOpen = ref(false);
 	const code = ref<string>();