Migrate codebase to Typescript

.eslintignore

@@ -0,0 +1,10 @@
+node_modules
+coverage
+.nyc_output
+
+# Compiled output for packages already converted to TypeScript
+packages/*/**/*.js
+packages/*/**/*.d.ts
+!packages/*/test/**
+!packages/preset-qpf/**/*.js
+!packages/server/**/*.js

.eslintrc

@@ -197,6 +197,83 @@
       rules: {
         "import/no-extraneous-dependencies": "off"
       }
+    },
+    {
+      // TypeScript source files
+      files: [ "packages/**/*.ts" ],
+      parser: "@typescript-eslint/parser",
+      extends: [ "plugin:@typescript-eslint/recommended-requiring-type-checking" ],
+      parserOptions: {
+        ecmaVersion: 9,
+        sourceType: "module",
+        project: "./tsconfig.json"
+      },
+      plugins: [ "@typescript-eslint" ],
+      rules: {
+        "no-unused-vars": "off",
+        "@typescript-eslint/no-unused-vars": [ 2, { args: "none" } ],
+        // The TS compiler already catches undefined references, and this rule
+        // otherwise misfires on TS-only constructs (interfaces, type imports).
+        "no-undef": "off",
+        // Misfires on TS function-overload signatures (multiple declarations
+        // for one implementation) — the TS compiler already validates those.
+        "no-redeclare": "off",
+        // Third-party type names (e.g. rdf-js's Quad_Graph) aren't ours to rename.
+        "camelcase": "off",
+        // Comunica's own eslint config disables these same three as "TODO: check
+        // if these can be enabled" — any flowing through further calls/assignments
+        // is too common a real pattern here to enforce yet.
+        "@typescript-eslint/no-unsafe-assignment": "off",
+        "@typescript-eslint/no-unsafe-argument": "off",
+        "@typescript-eslint/no-unsafe-return": "off",
+        // This codebase uses `let` pervasively as a long-standing style choice;
+        // enforcing const-where-possible would touch nearly every converted file.
+        "prefer-const": "off",
+        // 'text ' + someNumber is safe and pervasive in this codebase's string-building
+        // style; keep the rule's real catches (undefined, objects, Terms) active.
+        "@typescript-eslint/restrict-plus-operands": [ 2, { allowNumberAndString: true } ],
+        // Every hit is a destructured DataFactory method (quad/namedNode/literal) or
+        // lodash's _.noop — none use `this`, but the rule can't see that from the
+        // third-party type declarations alone.
+        "@typescript-eslint/unbound-method": "off",
+        // no-floating-promises' own suggested fix for an intentionally-unawaited
+        // promise chain is prefixing it with `void`.
+        "no-void": [ 2, { allowAsStatement: true } ],
+        // `x as unknown as Y` opts out of type checking entirely for x. Files with
+        // an existing, individually-reviewed need for it are exempted below;
+        // this catches it showing up anywhere else. Prefer a real type, or
+        // String(x)/Number(x) if this is really just coercion.
+        "no-restricted-syntax": [ 2, {
+          selector: "TSAsExpression > TSAsExpression[typeAnnotation.type='TSUnknownKeyword']",
+          message: "as unknown as X bypasses type checking. Prefer a real type; if unavoidable, add this file to the no-restricted-syntax exemption list in .eslintrc."
+        } ]
+      }
+    },
+    {
+      // HdtDatasource's constructor swaps in an ExternalHdtDatasource instance in place
+      // of `this`; the two are sibling classes (not a subtype relationship), and each
+      // independently overrides several of Datasource's protected methods, which brands
+      // them as structurally incompatible for TS's purposes even though they're
+      // interchangeable at runtime. Resolving this for real means either widening those
+      // protected overrides to public across both classes, or replacing the pattern with
+      // a factory function — both bigger changes than a type-only cleanup; see the
+      // commit history for the investigation.
+      files: [
+        "packages/datasource-hdt/lib/datasources/HdtDatasource.ts"
+      ],
+      rules: {
+        "no-restricted-syntax": "off"
+      }
+    },
+    {
+      // Needs `as unknown as X` to reach n3.Parser's internals,
+      // since @types/n3 has no typing for them.
+      files: [
+        "packages/core/lib/N3ParserExtended.ts"
+      ],
+      rules: {
+        "no-restricted-syntax": "off"
+      }
     }
   ]
 }

.github/workflows/ci.yml

@@ -40,6 +40,8 @@ jobs:
           key: ${{ runner.os }}-test-modules-${{ hashFiles('**/yarn.lock') }}
       - name: Install dependencies
         run: yarn install
+      - name: Build TypeScript
+        run: yarn run build
       - name: Run tests
         run: yarn run test-ci
       - name: Submit coverage results

.gitignore

@@ -13,4 +13,14 @@ config/*.json
 
 # Ignore dev environment files
 .idea
-.devcontainer
+.devcontainer
+
+# Compiled output for packages already converted to TypeScript
+packages/*/**/*.js
+packages/*/**/*.js.map
+packages/*/**/*.d.ts
+!packages/*/test/**
+!packages/preset-qpf/**/*.js
+!packages/preset-qpf/**/*.js.map
+!packages/server/**/*.js
+!packages/server/**/*.js.map

package.json

@@ -5,9 +5,18 @@
     "packages/*"
   ],
   "engines": {
-    "node": ">=10.0"
+    "node": ">=20.0"
   },
   "devDependencies": {
+    "@types/lodash": "^4.17.24",
+    "@types/lru-cache": "^5.1.1",
+    "@types/mime": "^2.0.3",
+    "@types/node": "^22.20.1",
+    "@types/parse-cache-control": "^1.0.4",
+    "@types/q": "^1.5.8",
+    "@types/request": "^2.48.13",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
     "chai": "^4.0.0",
     "coveralls": "^3.0.9",
     "eslint": "^7.0.0",
@@ -17,9 +26,11 @@
     "mocha": "^8.0.0",
     "nyc": "^15.0.0",
     "pre-commit": "^1.1.3",
+    "rdf-object": "^1.14.0",
     "sinon": "^1.17.4",
     "sinon-chai": "^2.14.0",
-    "supertest": "^6.0.0"
+    "supertest": "^6.0.0",
+    "typescript": "^5.9.3"
   },
   "pre-commit": [
     "lint",
@@ -31,12 +42,14 @@
     "mocha": "mocha \"packages/*/test/**/*-test.js\" --recursive --require ./test/test-setup --timeout 500",
     "test": "nyc npm run mocha",
     "test-ci": "nyc --reporter=lcov npm run mocha",
-    "lint": "eslint packages/*/bin/* packages/*/lib packages/*/test",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "build": "tsc -p tsconfig.json",
+    "lint": "eslint packages/*/bin/* packages/*/lib packages/*/test --ext .js,.ts",
     "clean": "rm -rf ./node_modules && rm -rf ./packages/*/node_modules",
     "dedupe": "npx yarn-deduplicate yarn.lock --scopes",
     "publish": "lerna publish",
     "publish-bare": "lerna exec -- npm publish --silent",
-    "postinstall": "lerna run prepare",
+    "postinstall": "lerna run prepare && yarn run build",
     "version": "manual-git-changelog onversion"
   }
 }

packages/core/index.ts

@@ -0,0 +1,96 @@
+/*! @license MIT ©2015-2016 Ruben Verborgh, Ghent University - imec */
+/* Exports of the components of this package */
+
+import type * as Types from './lib/types';
+
+import { AssetsController } from './lib/controllers/AssetsController';
+import { Controller } from './lib/controllers/Controller';
+import { DeferenceController as DereferenceController } from './lib/controllers/DereferenceController';
+import { ErrorController } from './lib/controllers/ErrorController';
+import { NotFoundController } from './lib/controllers/NotFoundController';
+
+import { Datasource } from './lib/datasources/Datasource';
+import { EmptyDatasource } from './lib/datasources/EmptyDatasource';
+import { IndexDatasource } from './lib/datasources/IndexDatasource';
+import { MemoryDatasource } from './lib/datasources/MemoryDatasource';
+
+import { DatasourceRouter } from './lib/routers/DatasourceRouter';
+import { PageRouter } from './lib/routers/PageRouter';
+
+import { ErrorHtmlView } from './lib/views/error/ErrorHtmlView';
+import { ErrorRdfView } from './lib/views/error/ErrorRdfView';
+import { ForbiddenHtmlView } from './lib/views/forbidden/ForbiddenHtmlView';
+import { NotFoundHtmlView } from './lib/views/notfound/NotFoundHtmlView';
+import { NotFoundRdfView } from './lib/views/notfound/NotFoundRdfView';
+import { HtmlView } from './lib/views/HtmlView';
+import { RdfView } from './lib/views/RdfView';
+import { View } from './lib/views/View';
+import { ViewCollection } from './lib/views/ViewCollection';
+
+import { runCli, runCustom } from './lib/CliRunner';
+import { LinkedDataFragmentsServer } from './lib/LinkedDataFragmentsServer';
+import { LinkedDataFragmentsServerWorker } from './lib/LinkedDataFragmentsServerWorker';
+import { UrlData } from './lib/UrlData';
+import * as Util from './lib/Util';
+
+const Core = {
+  controllers: {
+    AssetsController,
+    Controller,
+    DereferenceController,
+    ErrorController,
+    NotFoundController,
+  },
+  datasources: {
+    Datasource,
+    EmptyDatasource,
+    IndexDatasource,
+    MemoryDatasource,
+  },
+  routers: {
+    DatasourceRouter,
+    PageRouter,
+  },
+  views: {
+    error: {
+      ErrorHtmlView,
+      ErrorRdfView,
+    },
+    forbidden: {
+      ForbiddenHtmlView,
+    },
+    notfound: {
+      NotFoundHtmlView,
+      NotFoundRdfView,
+    },
+    HtmlView,
+    RdfView,
+    View,
+    ViewCollection,
+  },
+  runCli,
+  runCustom,
+  LinkedDataFragmentsServer,
+  LinkedDataFragmentsServerWorker,
+  UrlData,
+  Util,
+};
+
+// Re-exports this package's shared type definitions, so consumers can pull
+// them from the package root instead of reaching into `@ldf/core/lib/types`
+namespace Core {
+  export type QueryFeatures = Types.QueryFeatures;
+  export type Query = Types.Query;
+  export type DatasourceRegistry = Types.DatasourceRegistry;
+  export type Pushable<T> = Types.Pushable<T>;
+  export type DatasourceOptions = Types.DatasourceOptions;
+  export type RenderDone = Types.RenderDone;
+  export type LdfRequest = Types.LdfRequest;
+  export type LdfResponse = Types.LdfResponse;
+  export type RouterRequest = Types.RouterRequest;
+  export type ControllerOptions = Types.ControllerOptions;
+  export type ViewSettings = Types.ViewSettings;
+  export type WorkerConfig = Types.WorkerConfig;
+}
+
+export = Core;