[api] implement verbatim module syntax in tsconfig

api.planx.uk/.eslintrc

@@ -18,6 +18,7 @@
       }
     ],
     "@typescript-eslint/no-non-null-assertion": "off",
+    "@typescript-eslint/consistent-type-imports": "error",
     "no-nested-ternary": "error",
     "@vitest/expect-expect": [
       "error",

api.planx.uk/docs/index.ts

@@ -1,4 +1,4 @@
-import { Express } from "express";
+import type { Express } from "express";
 import swaggerJSDoc from "swagger-jsdoc";
 import swaggerUi from "swagger-ui-express";
 

api.planx.uk/helpers.ts

@@ -1,7 +1,8 @@
 import { gql } from "graphql-request";
 import capitalize from "lodash/capitalize.js";
-import { Flow, Node } from "./types.js";
-import { ComponentType, FlowGraph } from "@opensystemslab/planx-core/types";
+import type { Flow, Node } from "./types.js";
+import type { FlowGraph } from "@opensystemslab/planx-core/types";
+import { ComponentType } from "@opensystemslab/planx-core/types";
 import { $public, getClient } from "./client/index.js";
 
 export interface FlowData {

api.planx.uk/lib/hasura/metadata/index.test.ts

@@ -1,10 +1,11 @@
-import { createScheduledEvent, RequiredScheduledEventArgs } from "./index.js";
+import type { RequiredScheduledEventArgs } from "./index.js";
+import { createScheduledEvent } from "./index.js";
 import axios from "axios";
 import type { Mocked } from "vitest";
 
 describe("Creation of scheduled event", () => {
   vi.mock("axios", async (importOriginal) => {
-    const actualAxios = await importOriginal<typeof import("axios")>();
+    const actualAxios = await importOriginal<typeof axios>();
     return {
       default: {
         ...actualAxios,

api.planx.uk/lib/hasura/metadata/index.ts

@@ -1,4 +1,5 @@
-import Axios, { AxiosResponse, isAxiosError } from "axios";
+import type { AxiosResponse } from "axios";
+import axios, { isAxiosError } from "axios";
 
 /**
  * Body posted to Hasura Metadata API to create a scheduled event
@@ -46,7 +47,7 @@ const postToMetadataAPI = async (
   body: ScheduledEvent,
 ): Promise<AxiosResponse<ScheduledEventResponse>> => {
   try {
-    return await Axios.post(
+    return await axios.post(
       process.env.HASURA_METADATA_URL!,
       JSON.stringify(body),
       {

api.planx.uk/lib/hasura/schema/index.test.ts

@@ -4,7 +4,7 @@ import type { Mocked } from "vitest";
 
 describe("runSQL", () => {
   vi.mock("axios", async (importOriginal) => {
-    const actualAxios = await importOriginal<typeof import("axios")>();
+    const actualAxios = await importOriginal<typeof axios>();
     return {
       default: {
         ...actualAxios,

api.planx.uk/lib/hasura/schema/index.ts

@@ -1,4 +1,5 @@
-import Axios, { AxiosResponse, isAxiosError } from "axios";
+import type { AxiosResponse } from "axios";
+import axios, { isAxiosError } from "axios";
 
 export interface RunSQLArgs {
   source: "default";
@@ -18,7 +19,7 @@ const postToSchemaAPI = async <T>(
   query: SchemaAPIQuery,
 ): Promise<AxiosResponse<T>> => {
   try {
-    return await Axios.post(
+    return await axios.post(
       process.env.HASURA_SCHEMA_URL!,
       JSON.stringify(query),
       {

api.planx.uk/lib/notify/index.test.ts

@@ -1,6 +1,6 @@
 import { sendEmail } from "./index.js";
 import { NotifyClient } from "notifications-node-client";
-import { NotifyConfig } from "../../types.js";
+import type { NotifyConfig } from "../../types.js";
 
 vi.mock("notifications-node-client");
 

api.planx.uk/lib/notify/index.ts

@@ -1,6 +1,6 @@
 import { NotifyClient } from "notifications-node-client";
 import { softDeleteSession } from "../../modules/saveAndReturn/service/utils.js";
-import { NotifyConfig } from "../../types.js";
+import type { NotifyConfig } from "../../types.js";
 import { $api, $public } from "../../client/index.js";
 
 const notifyClient = new NotifyClient(process.env.GOVUK_NOTIFY_API_KEY);
@@ -70,7 +70,7 @@
     if (template === "save")
       returnValue.expiryDate = config.personalisation.expiryDate;
     return returnValue;
   } catch (error: any) {
     const notifyError = error?.response?.data?.errors?.length
       ? JSON.stringify(error?.response?.data?.errors?.[0])
       : error?.message;

api.planx.uk/modules/admin/session/csv.ts

@@ -1,5 +1,5 @@
 import { stringify } from "csv-stringify";
-import { NextFunction, Request, Response } from "express";
+import type { NextFunction, Request, Response } from "express";
 import { $api } from "../../../client/index.js";
 
 /**

api.planx.uk/modules/admin/session/digitalPlanningData.ts

@@ -1,4 +1,4 @@
-import { NextFunction, Request, Response } from "express";
+import type { NextFunction, Request, Response } from "express";
 import { $api } from "../../../client/index.js";
 
 /**

api.planx.uk/modules/admin/session/oneAppXML.ts

@@ -1,4 +1,4 @@
-import { Request, Response, NextFunction } from "express";
+import type { Request, Response, NextFunction } from "express";
 import { $api } from "../../../client/index.js";
 
 /**

api.planx.uk/modules/admin/session/summary.ts

@@ -1,13 +1,18 @@
-import {
+import type {
   GovUKPayment,
   PaymentRequest,
   Session,
   Team,
 } from "@opensystemslab/planx-core/types";
-import { NextFunction, Request, Response } from "express";
+import type { NextFunction, Request, Response } from "express";
 import { gql } from "graphql-request";
 
-import { Breadcrumb, Flow, LowCalSession, Passport } from "../../../types.js";
+import type {
+  Breadcrumb,
+  Flow,
+  LowCalSession,
+  Passport,
+} from "../../../types.js";
 import { $api } from "../../../client/index.js";
 
 /**

api.planx.uk/modules/admin/session/zip.ts

@@ -1,4 +1,4 @@
-import { NextFunction, Request, Response } from "express";
+import type { NextFunction, Request, Response } from "express";
 import { buildSubmissionExportZip } from "../../send/utils/exportZip.js";
 
 /**

api.planx.uk/modules/analytics/controller.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { trackAnalyticsLogExit } from "./service.js";
-import { ValidatedRequestHandler } from "../../shared/middleware/validate.js";
+import type { ValidatedRequestHandler } from "../../shared/middleware/validate.js";
 
 export const logAnalyticsSchema = z.object({
   query: z.object({

api.planx.uk/modules/auth/controller.ts

@@ -1,5 +1,5 @@
-import { CookieOptions, RequestHandler, Response } from "express";
-import { Request } from "express-jwt";
+import type { CookieOptions, RequestHandler, Response } from "express";
+import type { Request } from "express-jwt";
 
 export const failedLogin: RequestHandler = (_req, _res, next) =>
   next({

api.planx.uk/modules/auth/middleware.ts

@@ -1,14 +1,14 @@
 import crypto from "crypto";
 import assert from "assert";
 import { ServerError } from "../../errors/index.js";
-import { Template } from "../../lib/notify/index.js";
+import type { Template } from "../../lib/notify/index.js";
 import { expressjwt } from "express-jwt";
 import { generators } from "openid-client";
-import { Authenticator } from "passport";
-import { RequestHandler } from "http-proxy-middleware";
-import { Role } from "@opensystemslab/planx-core/types";
+import type { Authenticator } from "passport";
+import type { RequestHandler } from "http-proxy-middleware";
+import type { Role } from "@opensystemslab/planx-core/types";
 import { AsyncLocalStorage } from "async_hooks";
-import { Request } from "express";
+import type { Request } from "express";
 
 export const userContext = new AsyncLocalStorage<{ user: Express.User }>();
 

api.planx.uk/modules/auth/passport.ts

@@ -1,5 +1,6 @@
 import { Issuer } from "openid-client";
-import passport, { type Authenticator } from "passport";
+import type { Authenticator } from "passport";
+import passport from "passport";
 
 import { googleStrategy } from "./strategy/google.js";
 import {

api.planx.uk/modules/auth/service.ts

@@ -1,6 +1,6 @@
 import jwt from "jsonwebtoken";
 import { $api } from "../../client/index.js";
-import { User, Role } from "@opensystemslab/planx-core/types";
+import type { User, Role } from "@opensystemslab/planx-core/types";
 
 export const buildJWT = async (email: string): Promise<string | undefined> => {
   await checkUserCanAccessEnv(email, process.env.NODE_ENV);

api.planx.uk/modules/file/controller.ts

@@ -3,7 +3,7 @@ import { uploadPrivateFile, uploadPublicFile } from "./service/uploadFile.js";
 import { buildFilePath } from "./service/utils.js";
 import { getFileFromS3 } from "./service/getFile.js";
 import { z } from "zod";
-import { ValidatedRequestHandler } from "../../shared/middleware/validate.js";
+import type { ValidatedRequestHandler } from "../../shared/middleware/validate.js";
 import { ServerError } from "../../errors/index.js";
 
 assert(process.env.AWS_S3_BUCKET);

api.planx.uk/modules/file/file.test.ts

@@ -1,5 +1,5 @@
 import supertest from "supertest";
-import { Mocked } from "vitest";
+import type { Mocked } from "vitest";
 
 import app from "../../server.js";
 import { deleteFilesByURL } from "./service/deleteFile.js";

api.planx.uk/modules/file/service/deleteFile.ts

@@ -1,4 +1,4 @@
-import { DeleteObjectsRequest } from "aws-sdk/clients/s3.js";
+import type { DeleteObjectsRequest } from "aws-sdk/clients/s3.js";
 import { getS3KeyFromURL, s3Factory } from "./utils.js";
 
 export const deleteFilesByURL = async (

api.planx.uk/modules/file/service/getFile.ts

@@ -1,4 +1,4 @@
-import S3 from "aws-sdk/clients/s3.js";
+import type S3 from "aws-sdk/clients/s3.js";
 import { s3Factory } from "./utils.js";
 
 export const getFileFromS3 = async (fileId: string) => {

api.planx.uk/modules/file/service/uploadFile.ts

@@ -1,4 +1,4 @@
-import S3 from "aws-sdk/clients/s3.js";
+import type S3 from "aws-sdk/clients/s3.js";
 import { customAlphabet } from "nanoid";
 import mime from "mime";
 import { s3Factory } from "./utils.js";

api.planx.uk/modules/flows/copyFlow/controller.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
-import { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
-import { Flow } from "../../../types.js";
+import type { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
+import type { Flow } from "../../../types.js";
 import { ServerError } from "../../../errors/index.js";
 import { copyFlow } from "./service.js";
 

api.planx.uk/modules/flows/copyFlow/copyFlow.test.ts

@@ -3,7 +3,7 @@ import supertest from "supertest";
 import { queryMock } from "../../../tests/graphqlQueryMock.js";
 import { authHeader } from "../../../tests/mockJWT.js";
 import app from "../../../server.js";
-import { Flow } from "../../../types.js";
+import type { Flow } from "../../../types.js";
 import { userContext } from "../../auth/middleware.js";
 
 beforeEach(() => {

api.planx.uk/modules/flows/copyFlowAsPortal/controller.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
-import { Flow } from "../../../types.js";
-import { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
+import type { Flow } from "../../../types.js";
+import type { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
 import { copyPortalAsFlow } from "./service.js";
 import { ServerError } from "../../../errors/index.js";
 

api.planx.uk/modules/flows/copyFlowAsPortal/copyPortalAsFlow.test.ts

@@ -3,7 +3,7 @@ import supertest from "supertest";
 import { queryMock } from "../../../tests/graphqlQueryMock.js";
 import { authHeader } from "../../../tests/mockJWT.js";
 import app from "../../../server.js";
-import { Flow } from "../../../types.js";
+import type { Flow } from "../../../types.js";
 
 beforeEach(() => {
   queryMock.mockQuery({

api.planx.uk/modules/flows/copyFlowAsPortal/service.ts

@@ -1,5 +1,5 @@
 import { getFlowData, getChildren, makeUniqueFlow } from "../../../helpers.js";
-import { Flow } from "../../../types.js";
+import type { Flow } from "../../../types.js";
 
 /**
  * Copies an internal portal and transforms it to be an independent flow

api.planx.uk/modules/flows/downloadSchema/controller.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
+import type { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
 import { stringify } from "csv-stringify";
 import { getFlowSchema } from "./service.js";
 import { ServerError } from "../../../errors/index.js";

api.planx.uk/modules/flows/findReplace/controller.ts

@@ -1,9 +1,9 @@
-import { Flow } from "../../../types.js";
-import { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
+import type { Flow } from "../../../types.js";
+import type { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
 import { z } from "zod";
 import { ServerError } from "../../../errors/index.js";
 import { findAndReplaceInFlow } from "./service.js";
-import { FlowGraph } from "@opensystemslab/planx-core/types";
+import type { FlowGraph } from "@opensystemslab/planx-core/types";
 
 interface FindAndReplaceResponse {
   message: string;

api.planx.uk/modules/flows/findReplace/findReplace.test.ts

@@ -3,7 +3,7 @@ import supertest from "supertest";
 import { queryMock } from "../../../tests/graphqlQueryMock.js";
 import { authHeader } from "../../../tests/mockJWT.js";
 import app from "../../../server.js";
-import { Flow } from "../../../types.js";
+import type { Flow } from "../../../types.js";
 
 const auth = authHeader({ role: "platformAdmin" });
 

api.planx.uk/modules/flows/findReplace/service.ts

@@ -1,8 +1,8 @@
 import { gql } from "graphql-request";
 import { getFlowData } from "../../../helpers.js";
 import { $api } from "../../../client/index.js";
-import { FlowGraph } from "@opensystemslab/planx-core/types";
-import { Flow } from "../../../types.js";
+import type { FlowGraph } from "@opensystemslab/planx-core/types";
+import type { Flow } from "../../../types.js";
 
 interface MatchResult {
   matches: Flow["data"];

api.planx.uk/modules/flows/flattenFlow/controller.ts

@@ -1,7 +1,7 @@
-import { FlowGraph } from "@opensystemslab/planx-core/types";
+import type { FlowGraph } from "@opensystemslab/planx-core/types";
 import { z } from "zod";
 import { ServerError } from "../../../errors/index.js";
-import { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
+import type { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
 import { dataMerged } from "../../../helpers.js";
 
 type FlattenFlowDataResponse = FlowGraph;

api.planx.uk/modules/flows/moveFlow/controller.ts

@@ -1,4 +1,4 @@
-import { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
+import type { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
 import { z } from "zod";
 import { ServerError } from "../../../errors/index.js";
 import { moveFlow } from "./service.js";

api.planx.uk/modules/flows/moveFlow/service.ts

@@ -1,7 +1,7 @@
 import { gql } from "graphql-request";
-import { Flow } from "../../../types.js";
+import type { Flow } from "../../../types.js";
 import { getClient } from "../../../client/index.js";
-import { Team } from "@opensystemslab/planx-core/types";
+import type { Team } from "@opensystemslab/planx-core/types";
 
 export const moveFlow = async (flowId: string, teamSlug: string) => {
   const $client = getClient();

api.planx.uk/modules/flows/publish/controller.ts

@@ -1,5 +1,5 @@
-import { Node } from "@opensystemslab/planx-core/types";
-import { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
+import type { Node } from "@opensystemslab/planx-core/types";
+import type { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
 import { z } from "zod";
 import { publishFlow } from "./service.js";
 import { ServerError } from "../../../errors/index.js";

api.planx.uk/modules/flows/publish/service.ts

@@ -1,7 +1,7 @@
 import * as jsondiffpatch from "jsondiffpatch";
 import { dataMerged, getMostRecentPublishedFlow } from "../../../helpers.js";
 import { gql } from "graphql-request";
-import { FlowGraph, Node } from "@opensystemslab/planx-core/types";
+import type { FlowGraph, Node } from "@opensystemslab/planx-core/types";
 import { userContext } from "../../auth/middleware.js";
 import { getClient } from "../../../client/index.js";
 

api.planx.uk/modules/flows/validate/controller.ts

@@ -1,5 +1,5 @@
-import { Node } from "@opensystemslab/planx-core/types";
-import { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
+import type { Node } from "@opensystemslab/planx-core/types";
+import type { ValidatedRequestHandler } from "../../../shared/middleware/validate.js";
 import { z } from "zod";
 import { validateAndDiffFlow } from "./service/index.js";
 import { ServerError } from "../../../errors/index.js";

api.planx.uk/modules/flows/validate/helpers.ts

@@ -1,9 +1,9 @@
-import {
+import type {
   ComponentType,
   FlowGraph,
   Node,
 } from "@opensystemslab/planx-core/types";
-import { Entry } from "type-fest";
+import type { Entry } from "type-fest";
 
 export const isComponentType = (
   entry: Entry<FlowGraph>,

api.planx.uk/modules/flows/validate/service/fileTypes.ts

@@ -1,13 +1,10 @@
 import { getValidSchemaValues } from "@opensystemslab/planx-core";
-import {
-  ComponentType,
-  FlowGraph,
-  Node,
-} from "@opensystemslab/planx-core/types";
+import type { FlowGraph, Node } from "@opensystemslab/planx-core/types";
+import { ComponentType } from "@opensystemslab/planx-core/types";
 import countBy from "lodash/countBy.js";
 
 import { isComponentType } from "../helpers.js";
-import { FlowValidationResponse } from "./index.js";
+import type { FlowValidationResponse } from "./index.js";
 
 const validateFileTypes = (flowGraph: FlowGraph): FlowValidationResponse => {
   // Get all passport variables set by FileUpload and/or FileUploadAndLabel
@@ -70,7 +67,7 @@
   const uploadAndLabelFileTypes = uploadAndLabelNodes
     .map(([_nodeId, node]: [string, Node]) => node.data?.fileTypes)
     .flat();
   return uploadAndLabelFileTypes?.map((file: any) => file?.fn as string);
 };
 
 export { validateFileTypes };