Cleanup

package.json

@@ -70,7 +70,7 @@
     "rimraf": "^3.0.2",
     "stats-lite": "^2.2.0",
     "ts-node": "^10.8.2",
-    "typescript": "~5.4.5"
+    "typescript": "~5.5.4"
   },
   "dependencies": {
     "@graphql-tools/schema": "^8.5.0",

spec/model/implementation/i18n-fields.spec.ts

@@ -5,7 +5,7 @@ const FULLY = 'fully';
 const PARTIALLY = 'partially';
 const NAMESPACED = 'namespaced';
 
-const i18n: LocalizationConfig[] = [
+const i18n: ReadonlyArray<LocalizationConfig> = [
     {
         language: FULLY,
         namespacePath: [],

spec/model/implementation/i18n-types.spec.ts

@@ -5,7 +5,7 @@ const FULLY = 'fully';
 const PARTIALLY = 'partially';
 const NAMESPACED = 'namespaced';
 
-const i18n: LocalizationConfig[] = [
+const i18n: ReadonlyArray<LocalizationConfig> = [
     {
         language: FULLY,
         namespacePath: [],

spec/performance/associations.perf.ts

@@ -48,7 +48,7 @@ function testFetchWithAssociations(config: {
     associationCount: number;
 }): BenchmarkConfig {
     let env: TestEnvironment;
-    let sampledIDs: string[] = [];
+    let sampledIDs: ReadonlyArray<string> = [];
     return {
         name: `Fetch one of one root entity with one level deep associations (${config.paperCount} papers, ${config.userCount} users, ${config.associationCount} associations`,
         async beforeAll() {

spec/performance/crud.perf.ts

@@ -42,7 +42,7 @@ function getOneOfXRootEntities(config: {
     onlyFewFields?: boolean;
 }): BenchmarkConfig {
     let env: TestEnvironment;
-    let sampledIDs: string[] = [];
+    let sampledIDs: ReadonlyArray<string> = [];
     const sizeFactor = getSizeFactorForJSONLength(config.documentLength);
     return {
         name: `Get ${config.onlyFewFields ? 'two fields of ' : ''} one of ${

spec/performance/query-pipeline.perf.ts

@@ -160,7 +160,7 @@ function testQueryPipeline(params: {
 
     let schema: GraphQLSchema;
     let model: Model;
-    let preparedQueries: PreparedQuery[];
+    let preparedQueries: ReadonlyArray<PreparedQuery>;
 
     return {
         name: `Run query pipeline with ${optionsStr}`,

spec/performance/references.perf.ts

@@ -36,7 +36,7 @@ function testReferenceLookup(config: {
     referenceCountEach: number;
 }): BenchmarkConfig {
     let env: TestEnvironment;
-    let sampledIDs: string[] = [];
+    let sampledIDs: ReadonlyArray<string> = [];
     return {
         name: `Set up ${config.paperCount} root entities with ${config.referenceCountEach} references each, then fetch a random root entity with all its references`,
         async beforeAll() {

spec/performance/support/async-bench.ts

@@ -88,7 +88,7 @@ export interface BenchmarkResultConfig {
 
     readonly elapsedTime: number;
     readonly setUpTime: number;
-    readonly cycleDetails: BenchmarkCycleDetails[];
+    readonly cycleDetails: ReadonlyArray<BenchmarkCycleDetails>;
 }
 
 export class BenchmarkResult {
@@ -100,7 +100,7 @@ export class BenchmarkResult {
     /**
      * Detailed information about each cycle
      */
-    public readonly cycleDetails: BenchmarkCycleDetails[];
+    public readonly cycleDetails: ReadonlyArray<BenchmarkCycleDetails>;
 
     /**
      * The mean time, in seconds, per iteration
@@ -154,7 +154,9 @@ export async function benchmark(
     config: BenchmarkConfig,
     callbacks?: BenchmarkExecutionCallbacks,
 ): Promise<BenchmarkResult> {
-    async function cycle(count: number): Promise<{ times: number[]; netTime: number }> {
+    async function cycle(
+        count: number,
+    ): Promise<{ times: ReadonlyArray<number>; netTime: number }> {
         if (config.before) {
             await config.before({ count });
         }
@@ -171,7 +173,9 @@ export async function benchmark(
         };
     }
 
-    async function cycleSync(count: number): Promise<{ times: number[]; netTime: number }> {
+    async function cycleSync(
+        count: number,
+    ): Promise<{ times: ReadonlyArray<number>; netTime: number }> {
         if (config.before) {
             await config.before({ count });
         }
@@ -188,7 +192,9 @@ export async function benchmark(
         };
     }
 
-    async function cycleDetailed(count: number): Promise<{ times: number[]; netTime: number }> {
+    async function cycleDetailed(
+        count: number,
+    ): Promise<{ times: ReadonlyArray<number>; netTime: number }> {
         if (config.before) {
             await config.before({ count });
         }
@@ -359,7 +365,7 @@ const tTable: { [key: string]: number } = {
     infinity: 1.96,
 };
 
-function getTimings(times: number[]): Timings {
+function getTimings(times: ReadonlyArray<number>): Timings {
     const mean: number = stats.mean(times);
     // Compute the sample standard deviation (estimate of the population standard deviation).
     const sd = stats.stdev(times);

spec/performance/support/helpers.ts

@@ -10,7 +10,8 @@ import { Log4jsLoggerProvider } from '../../helpers/log4js-logger-provider';
 import { createTempDatabase } from '../../regression/initialization';
 
 // arangojs typings for this are completely broken
-export const aql: (template: TemplateStringsArray, ...args: any[]) => any = require('arangojs').aql;
+export const aql: (template: TemplateStringsArray, ...args: ReadonlyArray<any>) => any =
+    require('arangojs').aql;
 
 const MODEL_PATH = resolve(__dirname, '../../regression/papers/model');
 
@@ -130,7 +131,7 @@ export async function addNumberedPapersWithAQL(environment: TestEnvironment, cou
 export async function getRandomPaperIDsWithAQL(
     environment: TestEnvironment,
     count: number,
-): Promise<string[]> {
+): Promise<ReadonlyArray<string>> {
     const cursor = await environment
         .getDB()
         .query(aql`FOR node IN papers SORT RAND() LIMIT ${count} RETURN { id: node._key }`);

spec/regression/initialization.ts

@@ -16,7 +16,7 @@ export async function createTempDatabase(): Promise<ArangoDBConfig> {
     const dbs = await systemDatabase.listDatabases();
     if (dbs.indexOf(DATABASE_NAME) >= 0) {
         const db = systemDatabase.database(DATABASE_NAME);
-        const colls = (await db.collections(true)) as Collection[];
+        const colls = await db.collections(true);
         await Promise.all(colls.map((coll) => coll.drop()));
     } else {
         await systemDatabase.createDatabase(DATABASE_NAME);
@@ -144,7 +144,7 @@ export async function initTestData(
     return { fillTemplateStrings };
 }
 
-function wrapNamespaceForQuery(stuff: string, namespace: string[]) {
+function wrapNamespaceForQuery(stuff: string, namespace: ReadonlyArray<string>) {
     if (!namespace) {
         return stuff;
     }
@@ -155,7 +155,7 @@ function wrapNamespaceForQuery(stuff: string, namespace: string[]) {
     return result;
 }
 
-function retrieveIdFromResult(result: ExecutionResult, namespace: string[]) {
+function retrieveIdFromResult(result: ExecutionResult, namespace: ReadonlyArray<string>) {
     const ns = [...namespace];
     let node = result.data as any;
     while (ns.length) {

spec/regression/regression-suite.ts

@@ -203,7 +203,7 @@ export class RegressionSuite {
 
         const operations = parse(gqlSource).definitions.filter(
             (def) => def.kind == 'OperationDefinition',
-        ) as OperationDefinitionNode[];
+        ) as ReadonlyArray<OperationDefinitionNode>;
         this._isSetUpClean =
             this._isSetUpClean && !operations.some((op) => op.operation == 'mutation');
         const hasNamedOperations = operations.length && operations[0].name;

spec/schema/source-validation-modules/sidecar-schema.spec.ts

@@ -63,7 +63,7 @@ const invalidValueWithComments = `{
 describe('sidecar-schema validator', () => {
     const validator = new SidecarSchemaValidator();
 
-    function getValidatorMessages(ps: ProjectSource): ValidationMessage[] {
+    function getValidatorMessages(ps: ProjectSource): ReadonlyArray<ValidationMessage> {
         const parsedSource = parseProjectSource(ps, {}, new ValidationContext());
         if (parsedSource) {
             return validator.validate(parsedSource);

spec/schema/source-validation-modules/source-validation-helper.ts

@@ -2,7 +2,7 @@ import { ValidationContext, ValidationMessage } from '../../../src/model/validat
 import { ProjectSource } from '../../../src/project/source';
 import { parseProjectSource } from '../../../src/schema/schema-builder';
 
-export function getMessages(source: ProjectSource): ValidationMessage[] {
+export function getMessages(source: ProjectSource): ReadonlyArray<ValidationMessage> {
     const validationContext = new ValidationContext();
     parseProjectSource(source, {}, validationContext);
 

src/authorization/execution.ts

@@ -14,7 +14,7 @@ import { AuthContext } from './auth-basics';
 import { moveErrorsToOutputNodes } from './move-errors-to-output-nodes';
 import { transformNode } from './transformers';
 
-const MUTATIONS: Function[] = [
+const MUTATIONS: ReadonlyArray<Function> = [
     CreateEntityQueryNode,
     UpdateEntitiesQueryNode,
     DeleteEntitiesQueryNode,

src/authorization/permission-descriptors.ts

@@ -14,6 +14,7 @@ import { simplifyBooleans } from '../query-tree/utils';
 import { createFieldPathNode } from '../schema-generation/field-path-node';
 import { ACCESS_GROUP_FIELD } from '../schema/constants';
 import { AccessOperation, AuthContext } from './auth-basics';
+import { isReadonlyArray } from '../utils/utils';
 
 export enum ConditionExplanationContext {
     BEFORE_WRITE,
@@ -248,7 +249,7 @@ export class ProfileBasedPermissionDescriptor extends PermissionDescriptor {
 
             if (restriction.claim !== undefined) {
                 const claimValue = authContext.claims?.[restriction.claim];
-                const claimValues = Array.isArray(claimValue) ? claimValue : [claimValue];
+                const claimValues = isReadonlyArray(claimValue) ? claimValue : [claimValue];
                 const sanitizedClaimValues = claimValues.filter(
                     (v) => !!v && typeof v === 'string',
                 );

src/config/parsed-project.ts

@@ -3,7 +3,7 @@ import { PlainObject } from '../utils/utils';
 import { MessageLocation } from '../model/validation/message';
 
 export interface ParsedProject {
-    readonly sources: ParsedProjectSource[];
+    readonly sources: ReadonlyArray<ParsedProjectSource>;
 }
 
 export type ParsedProjectSource = ParsedGraphQLProjectSource | ParsedObjectProjectSource;

src/database/arangodb/aql-generator.ts

@@ -71,7 +71,7 @@ import {
 import { Quantifier, QuantifierFilterNode } from '../../query-tree/quantifiers';
 import { extractVariableAssignments, simplifyBooleans } from '../../query-tree/utils';
 import { not } from '../../schema-generation/utils/input-types';
-import { Constructor, decapitalize } from '../../utils/utils';
+import { Constructor, decapitalize, isReadonlyArray } from '../../utils/utils';
 import { FlexSearchTokenizable } from '../database-adapter';
 import { analyzeLikePatternPrefix } from '../like-helpers';
 import {
@@ -286,7 +286,7 @@ class QueryContext {
         return variable;
     }
 
-    getPreExecuteQueries(): AQLCompoundQuery[] {
+    getPreExecuteQueries(): ReadonlyArray<AQLCompoundQuery> {
         return this.preExecQueries;
     }
 
@@ -1862,7 +1862,7 @@ function getFullIDsFromKeysNode(
     }
     if (
         idsNode instanceof LiteralQueryNode &&
-        Array.isArray(idsNode.value) &&
+        isReadonlyArray(idsNode.value) &&
         idsNode.value.every((v) => typeof v === 'string')
     ) {
         const collName = getCollectionNameForRootEntity(rootEntityType);

src/database/arangodb/aql.ts

@@ -26,7 +26,7 @@ function indentLineBreaks(val: string, level: number) {
 }
 
 export class AQLCodeBuildingContext {
-    private readonly boundValues: any[] = [];
+    private readonly boundValues: unknown[] = [];
     private readonly boundCollectionNames = new Set<string>();
     private variableBindings = new Map<AQLVariable, string>();
     private preExecInjectedVariablesMap = new Map<AQLQueryResultVariable, string>();
@@ -340,7 +340,10 @@ export namespace aql {
         return new AQLCompoundFragment(fragments);
     }
 
-    export function join(fragments: AQLFragment[], separator: AQLFragment): AQLFragment {
+    export function join(
+        fragments: ReadonlyArray<AQLFragment>,
+        separator: AQLFragment,
+    ): AQLFragment {
         const newFragments: AQLFragment[] = [];
         let isFirst = true;
         for (const fragment of fragments) {
@@ -360,7 +363,7 @@ export namespace aql {
         return new AQLCodeFragment(code);
     }
 
-    export function lines(...fragments: AQLFragment[]) {
+    export function lines(...fragments: ReadonlyArray<AQLFragment>) {
         return join(fragments, aql`\n`);
     }
 
@@ -424,7 +427,7 @@ export namespace aql {
  */
 export class AQLCompoundQuery extends AQLFragment {
     constructor(
-        public readonly preExecQueries: AQLCompoundQuery[],
+        public readonly preExecQueries: ReadonlyArray<AQLCompoundQuery>,
         public readonly aqlQuery: AQLFragment,
         public readonly resultVar: AQLQueryResultVariable | undefined,
         public readonly resultValidator: QueryResultValidator | undefined,
@@ -439,14 +442,14 @@ export class AQLCompoundQuery extends AQLFragment {
      *
      * The returned transaction steps are to be executed sequentially.
      */
-    getExecutableQueries(): AQLExecutableQuery[] {
+    getExecutableQueries(): ReadonlyArray<AQLExecutableQuery> {
         const resultVarToNameMap = new Map<AQLQueryResultVariable, string>();
         return this.getExecutableQueriesRecursive(resultVarToNameMap);
     }
 
     private getExecutableQueriesRecursive(
         resultVarToNameMap: Map<AQLQueryResultVariable, string>,
-    ): AQLExecutableQuery[] {
+    ): ReadonlyArray<AQLExecutableQuery> {
         const executableQueries = flatMap(this.preExecQueries, (aqlQuery) =>
             aqlQuery.getExecutableQueriesRecursive(resultVarToNameMap),
         );

src/database/arangodb/arangodb-adapter.ts

@@ -328,7 +328,7 @@ export class ArangoDBAdapter implements DatabaseAdapter {
     async executeExt({ queryTree, ...options }: ExecutionArgs): Promise<ExecutionResult> {
         const prepStartTime = getPreciseTime();
         globalContext.registerContext(this.schemaContext);
-        let executableQueries: AQLExecutableQuery[];
+        let executableQueries: ReadonlyArray<AQLExecutableQuery>;
         let aqlQuery: AQLCompoundQuery;
         const oldEnableIndentationForCode = aqlConfig.enableIndentationForCode;
         aqlConfig.enableIndentationForCode = !!options.recordPlan;

src/database/arangodb/arangojs-instrumentation/custom-connection.ts

@@ -3,6 +3,7 @@ import { normalizeUrl } from 'arangojs/lib/normalizeUrl';
 import { ArangojsResponse } from 'arangojs/lib/request';
 import { RequestInstrumentation, requestInstrumentationBodyKey } from './config';
 import { createRequest, RequestOptions as CustomRequestOptions } from './custom-request';
+import { isReadonlyArray } from '../../../utils/utils';
 
 /**
  * @internal
@@ -111,8 +112,8 @@ export class CustomConnection extends Connection {
         });
     }
 
-    addToHostList(urls: string | string[]): string[] {
-        const cleanUrls = (Array.isArray(urls) ? urls : [urls]).map((url) => normalizeUrl(url));
+    addToHostList(urls: string | ReadonlyArray<string>): string[] {
+        const cleanUrls = (isReadonlyArray(urls) ? urls : [urls]).map((url) => normalizeUrl(url));
         const newUrls = cleanUrls.filter((url) => this._hostUrls.indexOf(url) === -1);
         this._hostUrls.push(...newUrls);
         this._hosts.push(