@magda/scripts 2.3.3 → 3.0.0-alpha.0

package/create-secrets/pwgen.js

@@ -1,4 +1,4 @@
-const Pwgen = require("pwgen/lib/pwgen_module");
+import Pwgen from "pwgen/lib/pwgen_module.js";
 
 function generatePassword(
     maxLength = 16,
@@ -13,4 +13,4 @@ function generatePassword(
     return pwgenGenerator.generate();
 }
 
-module.exports = generatePassword;
+export default generatePassword;

package/db/getDBConfig.js

@@ -1,4 +1,4 @@
-function getDBConfig() {
+export default function getDBConfig() {
     const {
         POSTGRES_HOST: host,
         POSTGRES_DB: database,
@@ -15,5 +15,3 @@ function getDBConfig() {
         password: password ? password : ""
     };
 }
-
-module.exports = getDBConfig;

package/db/getDBPool.js

@@ -1,5 +1,5 @@
-const pg = require("pg");
-const getDBConfig = require("./getDBConfig");
+import pg from "pg";
+import getDBConfig from "./getDBConfig.js";
 
 const pool = new pg.Pool(getDBConfig());
 pool.on("error", function (err, client) {
@@ -10,4 +10,4 @@ function getDBPool() {
     return pool;
 }
 
-module.exports = getDBPool;
+export default getDBPool;

package/docker-util.js

@@ -1,4 +1,4 @@
-exports.getVersions = function getVersions(local, version) {
+export function getVersions(local, version) {
     return (
         version || [
             !local && process.env.npm_package_version
@@ -6,9 +6,9 @@ exports.getVersions = function getVersions(local, version) {
                 : "latest"
         ]
     );
-};
+}
 
-exports.getName = function getName(name) {
+export function getName(name) {
     if (name && typeof name === "string") {
         return name;
     }
@@ -17,21 +17,21 @@ exports.getName = function getName(name) {
         : process.env.npm_package_name
         ? "data61/magda-" + process.env.npm_package_name.split("/")[1]
         : "UnnamedImage";
-};
+}
 
-exports.getTags = function getTags(tag, local, repository, version, name) {
+export function getTags(tag, local, repository, version, name) {
     if (tag === "auto") {
-        return exports.getVersions(local, version).map((version) => {
-            const tagPrefix = exports.getRepository(local, repository);
-            const imageName = exports.getName(name);
+        return getVersions(local, version).map((version) => {
+            const tagPrefix = getRepository(local, repository);
+            const imageName = getName(name);
 
             return tagPrefix + imageName + ":" + version;
         });
     } else {
         return tag ? [tag] : [];
     }
-};
+}
 
-exports.getRepository = function getRepository(local, repository) {
+export function getRepository(local, repository) {
     return (repository && repository + "/") || (local ? "localhost:5000/" : "");
-};
+}

package/findLastModifiedFile.js

@@ -1,5 +1,5 @@
-const fse = require("fs-extra");
-const klawSync = require("klaw-sync");
+import fse from "fs-extra";
+import klawSync from "klaw-sync";
 
 function findLastModifiedFile(path) {
     if (!fse.existsSync(path)) {

package/generate-api-documentation.js

@@ -1,10 +1,11 @@
 #!/usr/bin/env node
-const childProcess = require("child_process");
-const process = require("process");
-const yargs = require("yargs");
-const fs = require("fs");
-const path = require("path");
-const url = require("url");
+import childProcess from "node:child_process";
+import yargs from "yargs";
+import fs from "node:fs";
+import path from "node:path";
+import url from "url";
+import { getCurrentDirPath, require } from "@magda/esm-utils";
+const __dirname = getCurrentDirPath();
 
 const argv = yargs
     .options({

package/generate-registry-typescript.js

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
-var spawnSync = require("child_process").spawnSync;
-const fs = require("fs-extra");
-var path = require("path");
-
+import { spawnSync } from "node:child_process";
+import fs from "fs-extra";
+import path from "path";
+import { __dirname as getCurDirPath, require } from "@magda/esm-utils";
+const __dirname = getCurDirPath();
 const outputDir = path.resolve(process.argv[2]);
 const swaggerOutputDir = path.resolve(
     __dirname,

package/getAllPackages.js

@@ -1,5 +1,9 @@
+import { require } from "@magda/esm-utils";
 const lernaJson = require("../lerna.json");
-const path = require("path");
+import path from "path";
+import { __dirname as getCurDirPath, require } from "@magda/esm-utils";
+
+const __dirname = getCurDirPath();
 
 function getAllPackages() {
     return lernaJson.packages.map((relativePath) =>
@@ -7,4 +11,4 @@ function getAllPackages() {
     );
 }
 
-module.exports = getAllPackages;
+export default getAllPackages;

package/isScalaPackage.js

@@ -1,8 +1,8 @@
-const fse = require("fs-extra");
-const path = require("path");
+import fse from "fs-extra";
+import path from "path";
 
 function isScalaPackage(packagePath) {
     return fse.existsSync(path.resolve(packagePath, "build.sbt"));
 }
 
-module.exports = isScalaPackage;
+export default isScalaPackage;

package/isTypeScriptPackage.js

@@ -1,5 +1,6 @@
-const fse = require("fs-extra");
-const path = require("path");
+import fse from "fs-extra";
+import path from "path";
+import { require } from "@magda/esm-utils";
 
 function isTypeScriptPackage(packagePath, packageJson) {
     packageJson =
@@ -17,4 +18,4 @@ function isTypeScriptPackage(packagePath, packageJson) {
     return isTypeScript;
 }
 
-module.exports = isTypeScriptPackage;
+export default isTypeScriptPackage;

package/loaders/remove-hashbag-loader.js

@@ -1,3 +1,3 @@
-module.exports = function (source) {
+export default function (source) {
     return source.replace(/^#!.+$/m, "");
-};
+}

package/org-tree/getNodeIdFromNameOrId.js

@@ -1,4 +1,4 @@
-const isUuid = require("@magda/typescript-common/dist/util/isUuid").default;
+import isUuid from "@magda/typescript-common/dist/util/isUuid.js";
 async function getNodeIdByNameOrId(nameOrId, queryer) {
     if (isUuid(nameOrId)) {
         return nameOrId;
@@ -10,4 +10,4 @@ async function getNodeIdByNameOrId(nameOrId, queryer) {
         return nodes[0].id;
     }
 }
-module.exports = getNodeIdByNameOrId;
+export default getNodeIdByNameOrId;

package/org-tree/getUserIdFromNameOrId.js

@@ -1,4 +1,4 @@
-const isUuid = require("@magda/typescript-common/dist/util/isUuid").default;
+import isUuid from "@magda/typescript-common/dist/util/isUuid.js";
 async function getUserIdFromNameOrId(nameOrId, pool) {
     if (isUuid(nameOrId)) {
         return nameOrId;
@@ -13,4 +13,4 @@ async function getUserIdFromNameOrId(nameOrId, pool) {
         return result.rows[0].id;
     }
 }
-module.exports = getUserIdFromNameOrId;
+export default getUserIdFromNameOrId;

package/org-tree/index.js

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
+import { program } from "commander";
+import chalk from "chalk";
 
 program
     .version(pkg.version)

package/org-tree/org-tree-assign.js

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const NestedSetModelQueryer = require("@magda/authorization-api/dist/NestedSetModelQueryer")
-    .default;
-const getDBPool = require("../db/getDBPool");
-const getNodeIdFromNameOrId = require("./getNodeIdFromNameOrId");
-const getUserIdFromNameOrId = require("./getUserIdFromNameOrId");
+import { program } from "commander";
+import chalk from "chalk";
+import NestedSetModelQueryer from "@magda/authorization-api/dist/NestedSetModelQueryer.js";
+import getDBPool from "../db/getDBPool.js";
+import getNodeIdFromNameOrId from "./getNodeIdFromNameOrId.js";
+import getUserIdFromNameOrId from "./getUserIdFromNameOrId.js";
 
 program
     .description(

package/org-tree/org-tree-create.js

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const NestedSetModelQueryer = require("@magda/authorization-api/dist/NestedSetModelQueryer")
-    .default;
-const getDBPool = require("../db/getDBPool");
+import { program } from "commander";
+import chalk from "chalk";
+import NestedSetModelQueryer from "@magda/authorization-api/dist/NestedSetModelQueryer.js";
+import getDBPool from "../db/getDBPool.js";
 
 program
     .description(

package/org-tree/org-tree-delete.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const NestedSetModelQueryer = require("@magda/authorization-api/dist/NestedSetModelQueryer")
-    .default;
-const getDBPool = require("../db/getDBPool");
-const getNodeIdFromNameOrId = require("./getNodeIdFromNameOrId");
+import { program } from "commander";
+import chalk from "chalk";
+import NestedSetModelQueryer from "@magda/authorization-api/dist/NestedSetModelQueryer.js";
+import getDBPool from "../db/getDBPool.js";
+import getNodeIdFromNameOrId from "./getNodeIdFromNameOrId.js";
 
 program
     .description(

package/org-tree/org-tree-insert.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const NestedSetModelQueryer = require("@magda/authorization-api/dist/NestedSetModelQueryer")
-    .default;
-const getDBPool = require("../db/getDBPool");
-const getNodeIdFromNameOrId = require("./getNodeIdFromNameOrId");
+import { program } from "commander";
+import chalk from "chalk";
+import NestedSetModelQueryer from "@magda/authorization-api/dist/NestedSetModelQueryer.js";
+import getDBPool from "../db/getDBPool.js";
+import getNodeIdFromNameOrId from "./getNodeIdFromNameOrId.js";
 
 program
     .description(

package/org-tree/org-tree-move.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const NestedSetModelQueryer = require("@magda/authorization-api/dist/NestedSetModelQueryer")
-    .default;
-const getDBPool = require("../db/getDBPool");
-const getNodeIdFromNameOrId = require("./getNodeIdFromNameOrId");
+import { program } from "commander";
+import chalk from "chalk";
+import NestedSetModelQueryer from "@magda/authorization-api/dist/NestedSetModelQueryer.js";
+import getDBPool from "../db/getDBPool.js";
+import getNodeIdFromNameOrId from "./getNodeIdFromNameOrId.js";
 
 program
     .description(

package/org-tree/org-tree-unassign.js

@@ -1,12 +1,10 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const NestedSetModelQueryer = require("@magda/authorization-api/dist/NestedSetModelQueryer")
-    .default;
-const getDBPool = require("../db/getDBPool");
-const getNodeIdFromNameOrId = require("./getNodeIdFromNameOrId");
-const getUserIdFromNameOrId = require("./getUserIdFromNameOrId");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
+import getUserIdFromNameOrId from "./getUserIdFromNameOrId.js";
 
 program
     .description("Remove the specified user to from any org unit.")

package/org-tree/org-tree-view.js

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const NestedSetModelQueryer = require("@magda/authorization-api/dist/NestedSetModelQueryer")
-    .default;
-const getDBPool = require("../db/getDBPool");
+import { program } from "commander";
+import chalk from "chalk";
+import NestedSetModelQueryer from "@magda/authorization-api/dist/NestedSetModelQueryer.js";
+import getDBPool from "../db/getDBPool.js";
 
 program
     .version(pkg.version)

package/package.json

@@ -1,15 +1,21 @@
 {
   "name": "@magda/scripts",
-  "version": "2.3.3",
+  "version": "3.0.0-alpha.0",
   "description": "Scripts for building, running, and deploying MAGDA",
   "license": "Apache-2.0",
+  "type": "module",
+  "exports": {
+    "./*.js": "./*.js",
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=18.19.0"
+  },
   "bin": {
     "generate-registry-typescript": "generate-registry-typescript.js",
     "create-jwt-token": "create-jwt-token.js",
     "create-docker-context-for-node-component": "create-docker-context-for-node-component.js",
-    "generate-connector-jobs": "generate-connector-jobs.js",
     "run-typescript-in-nodemon": "run-typescript-in-nodemon.js",
-    "create-pod-and-forward": "create-pod-and-forward.js",
     "retag-and-push": "retag-and-push.js",
     "generate-api-documentation": "generate-api-documentation.js",
     "create-secrets": "create-secrets/index.js",
@@ -39,14 +45,16 @@
     }
   },
   "dependencies": {
+    "@magda/esm-utils": "^1.0.1",
+    "@magda/typescript-common": "^3.0.0-alpha.0",
     "ansi-styles": "^3.2.1",
     "apidoc": "https://github.com/magda-io/apidoc",
     "chalk": "^2.4.1",
     "clear": "^0.1.0",
     "cli-cursor": "^3.1.0",
-    "commander": "^2.17.0",
+    "commander": "^11.1.0",
     "configstore": "^4.0.0",
-    "fs-extra": "^2.1.2",
+    "fs-extra": "^11.2.0",
     "fuzzy": "^0.1.3",
     "inquirer": "^6.0.0",
     "inquirer-autocomplete-prompt": "^1.0.1",
@@ -68,9 +76,8 @@
     "table": "^5.3.3",
     "tmp": "0.0.31",
     "toposort": "^1.0.6",
-    "ts-node": "^8.9.2",
-    "tsconfig-paths": "^4.1.0",
-    "typescript": "~4.2.4",
+    "tsx": "^4.7.0",
+    "typescript": "~5.2.2",
     "uniqid": "^5.0.3",
     "yaml": "^1.10.0",
     "yargs": "^12.0.5"

package/retag-and-push.js

@@ -1,13 +1,8 @@
 #!/usr/bin/env node
 
-const yargs = require("yargs");
-const childProcess = require("child_process");
-const {
-    getVersions,
-    getTags,
-    getName,
-    getRepository
-} = require("./docker-util");
+import yargs from "yargs";
+import * as childProcess from "child_process";
+import { getVersions, getName } from "./docker-util";
 
 // Docker and ConEmu (an otherwise excellent console for Windows) don't get along.
 // See: https://github.com/Maximus5/ConEmu/issues/958 and https://github.com/moby/moby/issues/28814

package/run-in-submodules.js

@@ -1,14 +1,16 @@
 #!/usr/bin/env node
 
-const path = require("path");
-const childProcess = require("child_process");
-const glob = require("glob");
-const _ = require("lodash");
-const os = require("os");
+import { require } from "@magda/esm-utils";
+import path from "node:path";
+import childProcess from "child_process";
+import glob from "glob";
+import _ from "lodash";
+import os from "node:os";
+import yargs from "yargs";
 
 const lernaJson = require("../lerna.json");
 
-const argv = require("yargs").option("filters", {
+const argv = yargs.option("filters", {
     alias: "f",
     type: "string",
     describe:
@@ -30,8 +32,8 @@ const filters = argFilters.map((string) => {
 });
 
 const jsPackages = _(lernaJson.packages)
-    .map((package) => package + "/package.json")
-    .flatMap((package) => glob.sync(package))
+    .map((pkg) => pkg + "/package.json")
+    .flatMap((pkg) => glob.sync(pkg))
     .map((packagePath) => {
         const packageJson = require(path.resolve(packagePath));
         return packageJson;
@@ -50,7 +52,7 @@ const jsPackages = _(lernaJson.packages)
 const result = childProcess.spawnSync(
     "lerna",
     [
-        ...jsPackages.map((package) => "--scope " + package),
+        ...jsPackages.map((pkg) => "--scope " + pkg),
         "--stream",
         "--concurrency",
         os.cpus().length,

package/run-typescript-in-nodemon.js

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
-const fse = require("fs-extra");
-const nodemon = require("nodemon");
-const path = require("path");
-const process = require("process");
+import { require } from "@magda/esm-utils";
+import fse from "fs-extra";
+import nodemon from "nodemon";
+import path from "path";
+import process from "process";
 
 const script = process.argv[2];
 if (!script) {
@@ -47,11 +48,7 @@ nodemon({
     args: process.argv.slice(3),
     watch: watchPaths,
     execMap: {
-        ts:
-            "node " +
-            require.resolve("ts-node/dist/bin.js") +
-            " -r " +
-            require.resolve("tsconfig-paths/register")
+        ts: "node " + " --import tsx/esm "
     }
 });
 

package/set-scss-vars.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const chalk = require("chalk");
 const path = require("path");
 const fse = require("fs-extra");

package/tools/swagger-codegen-cli.md

@@ -12,7 +12,7 @@ yarn run generateSwaggerApis
 To build:
 
 ```
-git checkout -b magda git@github.com:TerriaJS/swagger-codegen.git
+git checkout -b magda git@github.com:magda-io/swagger-codegen.git
 cd swagger-codegen
 mvn clean package
 ```

package/update-helm-chart-version.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const path = require("path");
 const recursive = require("recursive-readdir");
 const fse = require("fs-extra");

package/create-all-tsconfigs.js

@@ -1,51 +0,0 @@
-#!/usr/bin/env node
-const fse = require("fs-extra");
-const path = require("path");
-const getAllPackages = require("./getAllPackages");
-const isTypeScriptPackage = require("./isTypeScriptPackage");
-
-getAllPackages().forEach(function (packagePath) {
-    const packageJson = require(path.resolve(packagePath, "package.json"));
-    const isTypeScript = isTypeScriptPackage(packagePath, packageJson);
-    if (!isTypeScript) {
-        return;
-    }
-
-    console.log(packagePath);
-
-    const tsConfigBuild = {
-        extends: "../tsconfig-global.json",
-        compilerOptions: {
-            declaration: true,
-            outDir: "dist",
-            baseUrl: "."
-        },
-        include: ["src"]
-    };
-
-    fse.writeFileSync(
-        path.resolve(packagePath, "tsconfig-build.json"),
-        JSON.stringify(tsConfigBuild, undefined, "    ")
-    );
-
-    const paths = {};
-    const dependencies = packageJson.dependencies || {};
-    Object.keys(dependencies)
-        .filter((key) => key.indexOf("@magda") === 0)
-        .forEach(function (key) {
-            paths[key + "/dist/*"] = ["./node_modules/" + key + "/src/*"];
-        });
-
-    const tsConfig = {
-        extends: "./tsconfig-build.json",
-        compilerOptions: {
-            baseUrl: ".",
-            paths: paths
-        }
-    };
-
-    fse.writeFileSync(
-        path.resolve(packagePath, "tsconfig.json"),
-        JSON.stringify(tsConfig, undefined, "    ")
-    );
-});