Issue/2593 Upgrade Typescript Project to Use Project References

.gitignore

@@ -47,3 +47,5 @@ docker-context-*/
 #tenant-api specific
 magda-tenant-api/lib/
 
+#typescript
+tsconfig.tsbuildinfo

.gitlab-ci.yml

@@ -9,7 +9,7 @@ variables:
     -Dsbt.ivy.home=$CI_PROJECT_DIR/sbt-cache/ivy
   # If you changed dependencies (especially for scala), you might want to prevent your branch from using old cache by increase the version blew
   # gitlab actually use the same technique when you click the `Clear Cache Button` 
-  CACHE_VERSION: 5
+  CACHE_VERSION: ts-6-scala-5
 
 stages:
   - builders
@@ -316,6 +316,7 @@ buildtest:typescript-apis:
     - cd ../../../../..
     - yarn run in-submodules -- -f categories.api=true -f language=typescript -- run build --include-filtered-dependencies
     - yarn run in-submodules -- -f categories.api=true -f language=typescript -- run test --include-filtered-dependencies
+    - cd magda-typescript-common && yarn test && cd ..
     - cd deploy/helm/magda/charts/opa
     - docker-compose down
   artifacts:

.vscode/settings.json

@@ -1,4 +1,5 @@
 {
+    "typescript.tsdk": "node_modules/typescript/lib",
     "files.exclude": {
         "**/node_modules": true,
         "**/bin": true,

CHANGES.md

@@ -3,6 +3,7 @@
 General:
 
 -   CSV Connector can now process ampersand character properly
+-   Upgraded typescript to 3.7.2 & Use [Project References](https://www.typescriptlang.org/docs/handbook/project-references.html) to organize typescript project
 
 UI:
 

magda-admin-api/package.json

@@ -2,9 +2,10 @@
   "name": "@magda/admin-api",
   "version": "0.0.57-0",
   "scripts": {
+    "prebuild": "rimraf dist tsconfig.tsbuildinfo",
     "build": "yarn run compile",
-    "compile": "tsc -p tsconfig-build.json",
-    "watch": "tsc -p tsconfig-build.json --watch",
+    "compile": "tsc -b && ts-module-alias-transformer dist",
+    "watch": "tsc -b --watch",
     "start": "node dist/index.js",
     "dev": "run-typescript-in-nodemon src/index.ts",
     "docker-build-local": "create-docker-context-for-node-component --build --push --tag auto --local",
@@ -43,7 +44,7 @@
     "request-debug": "^0.2.0",
     "sinon": "^3.2.1",
     "supertest": "^3.0.0",
-    "typescript": "^3.2.0"
+    "typescript": "^3.7.2"
   },
   "config": {
     "docker": {
@@ -66,5 +67,8 @@
     "exclude": [
       "src/test/**"
     ]
+  },
+  "_moduleMappings": {
+    "magda-typescript-common/src": "@magda/typescript-common/dist"
   }
 }

magda-admin-api/src/buildApiRouter.ts

@@ -1,14 +1,14 @@
-import * as express from "express";
+import express from "express";
 import buildConnectorManifest from "./buildConnectorManifest";
 import buildInteractiveConnectorRouter from "./buildInteractiveConnectorRouter";
-import * as _ from "lodash";
+import _ from "lodash";
 import K8SApi, { K8SApiType } from "./k8sApi";
-import { mustBeAdmin } from "@magda/typescript-common/dist/authorization-api/authMiddleware";
+import { mustBeAdmin } from "magda-typescript-common/src/authorization-api/authMiddleware";
 
 import {
     installStatusRouter,
     createServiceProbe
-} from "@magda/typescript-common/dist/express/status";
+} from "magda-typescript-common/src/express/status";
 
 export interface Options {
     dockerRepo: string;

magda-admin-api/src/buildInteractiveConnectorRouter.ts

@@ -1,8 +1,8 @@
 import "isomorphic-fetch";
 import buildConnectorManifest from "./buildConnectorManifest";
 import K8SApi from "./k8sApi";
-import * as express from "express";
-import * as HttpProxy from "http-proxy";
+import express from "express";
+import HttpProxy from "http-proxy";
 
 // Use type merging to add a connectorProxy property to Express's Request object.
 declare global {

magda-admin-api/src/index.ts

@@ -1,8 +1,8 @@
-import * as express from "express";
-import * as yargs from "yargs";
+import express from "express";
+import yargs from "yargs";
 
 import buildApiRouter from "./buildApiRouter";
-import addJwtSecretFromEnvVar from "@magda/typescript-common/dist/session/addJwtSecretFromEnvVar";
+import addJwtSecretFromEnvVar from "magda-typescript-common/src/session/addJwtSecretFromEnvVar";
 import { K8SApiType } from "./k8sApi";
 
 const argv = addJwtSecretFromEnvVar(
@@ -95,6 +95,9 @@ app.use(
 app.listen(argv.listenPort);
 console.log("Admin API started on port " + argv.listenPort);
 
-process.on("unhandledRejection", (reason: string, promise: any) => {
-    console.error(reason);
-});
+process.on(
+    "unhandledRejection",
+    (reason: {} | null | undefined, promise: Promise<any>) => {
+        console.error(reason);
+    }
+);

magda-admin-api/src/k8sApi.ts

@@ -1,10 +1,11 @@
+/// <reference types="./missing" />
 require("util.promisify/shim")();
-import * as Api from "kubernetes-client";
-import * as fs from "fs";
+import Api from "kubernetes-client";
+import fs from "fs";
 import { promisify } from "util";
-import * as _ from "lodash";
-import * as path from "path";
-import getMinikubeIP from "@magda/typescript-common/dist/util/getMinikubeIP";
+import _ from "lodash";
+import path from "path";
+import getMinikubeIP from "magda-typescript-common/src/util/getMinikubeIP";
 // var request = require('request');
 // require('request-debug')(request);
 

magda-admin-api/src/test/arbitraries.ts

@@ -1,11 +1,11 @@
-import * as _ from "lodash";
+import _ from "lodash";
 
-import jsc from "@magda/typescript-common/dist/test/jsverify";
+import jsc from "magda-typescript-common/src/test/jsverify";
 import {
     stringArb,
     dateStringArb,
     arbFlatMap
-} from "@magda/typescript-common/dist/test/arbitraries";
+} from "magda-typescript-common/src/test/arbitraries";
 
 export const configArb = jsc.record({
     type: stringArb,
@@ -59,12 +59,17 @@ export const stateArb: jsc.Arbitrary<State> = arbFlatMap(
                 })
             ])
             .fromPairs()
-            .value();
+            .value() as {
+            [key: string]: jsc.Arbitrary<{
+                config: any;
+                job: any;
+            }>;
+        };
 
         if (connectorIds.length > 0) {
             return jsc.record(connectorStates);
         } else {
-            return jsc.constant({} as _.Dictionary<any>);
+            return jsc.constant({});
         }
     },
     connectorStates => {

magda-admin-api/src/test/buildApiRouter.spec.ts

@@ -1,12 +1,12 @@
-import * as _ from "lodash";
+import _ from "lodash";
 import {} from "mocha";
 import { expect } from "chai";
-import * as express from "express";
-import * as sinon from "sinon";
-import * as nock from "nock";
-import jsc from "@magda/typescript-common/dist/test/jsverify";
+import express from "express";
+import sinon from "sinon";
+import nock from "nock";
+import jsc from "magda-typescript-common/src/test/jsverify";
 import * as helpers from "./helpers";
-import * as request from "supertest";
+import request from "supertest";
 
 import buildApiRouter from "../buildApiRouter";
 import { stateArb } from "./arbitraries";

magda-admin-api/src/test/fixtures.ts

@@ -1,4 +1,4 @@
-import * as _ from "lodash";
+import _ from "lodash";
 
 export const getJobs = (jobs: {
     [jobName: string]: {

magda-admin-api/src/test/helpers.ts

@@ -1,10 +1,10 @@
-import * as request from "supertest";
+import request from "supertest";
 import * as fixtures from "./fixtures";
-import mockAuthorization from "@magda/typescript-common/dist/test/mockAuthorization";
+import mockAuthorization from "magda-typescript-common/src/test/mockAuthorization";
 import { State, ConnectorState, ConfigState, JobState } from "./arbitraries";
-import * as express from "express";
-import * as nock from "nock";
-import * as _ from "lodash";
+import express from "express";
+import nock from "nock";
+import _ from "lodash";
 
 export function getConnectors(
     app: express.Application,

magda-admin-api/tsconfig.json

@@ -1,11 +1,11 @@
 {
-    "extends": "./tsconfig-build.json",
+    "extends": "../tsconfig-global.json",
     "compilerOptions": {
-        "baseUrl": ".",
-        "paths": {
-            "@magda/typescript-common/dist/*": [
-                "../node_modules/@magda/typescript-common/src/*"
-            ]
-        }
-    }
+        "outDir": "./dist",
+        "strictNullChecks": false,
+        "rootDir": "./src",
+        "tsBuildInfoFile": "./tsconfig.tsbuildinfo"
+    },
+    "references": [{ "path": "../magda-typescript-common" }],
+    "include": ["./src"]
 }

magda-authorization-api/package.json

@@ -2,9 +2,10 @@
   "name": "@magda/authorization-api",
   "version": "0.0.57-0",
   "scripts": {
+    "prebuild": "rimraf dist tsconfig.tsbuildinfo",
     "build": "yarn run compile",
-    "compile": "tsc -p tsconfig-build.json",
-    "watch": "tsc -p tsconfig-build.json --watch",
+    "compile": "tsc -b && ts-module-alias-transformer dist",
+    "watch": "tsc -b --watch",
     "start": "node dist/index.js",
     "dev": "export PGUSER=client && export JWT_SECRET=squirrel && run-typescript-in-nodemon src/index.ts",
     "test": "nyc mocha --compilers ts:ts-node/register,tsx:ts-node/register --require tsconfig-paths/register \"src/test/**/*.spec.ts\"",
@@ -52,7 +53,7 @@
     "recursive-readdir": "^2.2.2",
     "sinon": "^7.3.1",
     "supertest": "^3.0.0",
-    "typescript": "^3.2.0"
+    "typescript": "^3.7.2"
   },
   "config": {
     "docker": {
@@ -75,5 +76,8 @@
     "exclude": [
       "src/test/**"
     ]
+  },
+  "_moduleMappings": {
+    "magda-typescript-common/src": "@magda/typescript-common/dist"
   }
 }

magda-authorization-api/src/Database.ts

@@ -3,15 +3,15 @@ import {
     User,
     Role,
     Permission
-} from "@magda/typescript-common/dist/authorization-api/model";
+} from "magda-typescript-common/src/authorization-api/model";
 import { Maybe } from "tsmonad";
-import arrayToMaybe from "@magda/typescript-common/dist/util/arrayToMaybe";
-import * as pg from "pg";
-import * as _ from "lodash";
-import GenericError from "@magda/typescript-common/dist/authorization-api/GenericError";
-import { getUserId } from "@magda/typescript-common/dist/session/GetUserId";
+import arrayToMaybe from "magda-typescript-common/src/util/arrayToMaybe";
+import pg from "pg";
+import _ from "lodash";
+import GenericError from "magda-typescript-common/src/authorization-api/GenericError";
+import { getUserId } from "magda-typescript-common/src/session/GetUserId";
 import NestedSetModelQueryer from "./NestedSetModelQueryer";
-import isUuid from "@magda/typescript-common/dist/util/isUuid";
+import isUuid from "magda-typescript-common/src/util/isUuid";
 
 export interface DatabaseOptions {
     dbHost: string;

magda-authorization-api/src/NestedSetModelQueryer.ts

@@ -1,5 +1,5 @@
-import * as pg from "pg";
-import * as _ from "lodash";
+import pg from "pg";
+import _ from "lodash";
 import { Maybe } from "tsmonad";
 const textTree = require("text-treeview");
 

magda-authorization-api/src/createApiRouter.ts

@@ -1,23 +1,23 @@
-import * as express from "express";
+import express from "express";
 import { Maybe } from "tsmonad";
 
 import Database from "./Database";
 import {
     PublicUser,
     DatasetAccessControlMetaData
-} from "@magda/typescript-common/dist/authorization-api/model";
+} from "magda-typescript-common/src/authorization-api/model";
 import {
     getUserIdHandling,
     getUserId
-} from "@magda/typescript-common/dist/session/GetUserId";
-import GenericError from "@magda/typescript-common/dist/authorization-api/GenericError";
-import AuthError from "@magda/typescript-common/dist/authorization-api/AuthError";
-import { installStatusRouter } from "@magda/typescript-common/dist/express/status";
+} from "magda-typescript-common/src/session/GetUserId";
+import GenericError from "magda-typescript-common/src/authorization-api/GenericError";
+import AuthError from "magda-typescript-common/src/authorization-api/AuthError";
+import { installStatusRouter } from "magda-typescript-common/src/express/status";
 import { NodeNotFoundError } from "./NestedSetModelQueryer";
-import Registry from "@magda/typescript-common/dist/registry/AuthorizedRegistryClient";
-import { AuthorizedRegistryOptions } from "@magda/typescript-common/dist/registry/AuthorizedRegistryClient";
-import { Record } from "@magda/typescript-common/dist/generated/registry/api";
-import unionToThrowable from "@magda/typescript-common/dist/util/unionToThrowable";
+import Registry from "magda-typescript-common/src/registry/AuthorizedRegistryClient";
+import { AuthorizedRegistryOptions } from "magda-typescript-common/src/registry/AuthorizedRegistryClient";
+import { Record } from "magda-typescript-common/src/generated/registry/api";
+import unionToThrowable from "magda-typescript-common/src/util/unionToThrowable";
 import getUsersAllowedOperationOnDataset from "./getUsersAllowedOperationOnDataset";
 
 export interface ApiRouterOptions {

magda-authorization-api/src/createOpaRouter.ts

@@ -1,13 +1,13 @@
-import * as express from "express";
+import express from "express";
 import { Router } from "express";
-import * as _ from "lodash";
+import _ from "lodash";
 import Database from "./Database";
-import { User } from "@magda/typescript-common/dist/authorization-api/model";
-import { getUserSession } from "@magda/typescript-common/dist/session/GetUserSession";
-import OpaCompileResponseParser from "@magda/typescript-common/dist/OpaCompileResponseParser";
-import * as request from "request-promise-native";
-import * as bodyParser from "body-parser";
-import * as objectPath from "object-path";
+import { User } from "magda-typescript-common/src/authorization-api/model";
+import { getUserSession } from "magda-typescript-common/src/session/GetUserSession";
+import OpaCompileResponseParser from "magda-typescript-common/src/OpaCompileResponseParser";
+import request from "request-promise-native";
+import bodyParser from "body-parser";
+import objectPath from "object-path";
 
 export interface OpaRouterOptions {
     opaUrl: string;

magda-authorization-api/src/createPool.ts

@@ -1,4 +1,4 @@
-import * as pg from "pg";
+import pg from "pg";
 
 export interface PoolCreationOptions {
     dbHost: string;

magda-authorization-api/src/getUsersAllowedOperationOnDataset.ts

@@ -1,16 +1,16 @@
-import * as request from "request-promise-native";
-import * as _ from "lodash";
-import GenericError from "@magda/typescript-common/dist/authorization-api/GenericError";
-import isUuid from "@magda/typescript-common/dist/util/isUuid";
+import request from "request-promise-native";
+import _ from "lodash";
+import GenericError from "magda-typescript-common/src/authorization-api/GenericError";
+import isUuid from "magda-typescript-common/src/util/isUuid";
 import OpaCompileResponseParser, {
     RegoRef,
     RegoExp
-} from "@magda/typescript-common/dist/OpaCompileResponseParser";
+} from "magda-typescript-common/src/OpaCompileResponseParser";
 import {
     DatasetAccessControlMetaData,
     User
-} from "@magda/typescript-common/dist/authorization-api/model";
-import * as pg from "pg";
+} from "magda-typescript-common/src/authorization-api/model";
+import pg from "pg";
 
 const INVALID_CHAR_REGEX = /[^a-z_\d\.]/i;