@magda/scripts 2.3.3 → 3.0.0-alpha.1

package/create-secrets/index.js

@@ -1,10 +1,11 @@
 #!/usr/bin/env node
-const { askQuestions, getEnvVarInfo } = require("./askQuestions");
-const k8sExecution = require("./k8sExecution");
-const preloadConfig = require("./preloadConfig");
-const clear = require("clear");
-const chalk = require("chalk");
-const Configstore = require("configstore");
+import { askQuestions, getEnvVarInfo } from "./askQuestions.js";
+import k8sExecution from "./k8sExecution.js";
+import preloadConfig from "./preloadConfig.js";
+import clear from "clear";
+import chalk from "chalk";
+import Configstore from "configstore";
+import { require } from "@magda/esm-utils";
 
 const appName = "magda-create-secrets";
 const pkg = require("../package.json");

package/create-secrets/k8sExecution.js

@@ -1,14 +1,14 @@
-const childProcess = require("child_process");
-const process = require("process");
-const chalk = require("chalk");
-const trim = require("lodash/trim");
-const {
+import childProcess from "child_process";
+import process from "process";
+import chalk from "chalk";
+import trim from "lodash/trim.js";
+import {
     getEnvVarInfo,
     askIfCreateNamespace,
     settingNameToEnvVarName
-} = require("./askQuestions");
-const Base64 = require("js-base64").Base64;
-const pwgen = require("./pwgen");
+} from "./askQuestions.js";
+import { Base64 } from "js-base64";
+import pwgen from "./pwgen.js";
 
 const dbPasswordNames = [
     "authorization-db",
@@ -472,4 +472,4 @@ function getKubectlCommand(configData) {
     return clusterType === "microk8s" ? "microk8s kubectl" : "kubectl";
 }
 
-module.exports = k8sExecution;
+export default k8sExecution;

package/create-secrets/preloadConfig.js

@@ -1,6 +1,6 @@
-const fs = require("fs");
-const chalk = require("chalk");
-const trim = require("lodash/trim");
+import fs from "fs";
+import chalk from "chalk";
+import trim from "lodash/trim.js";
 
 function preloadConfig(configStore, executeOption) {
     return Promise.resolve().then(function () {
@@ -100,4 +100,4 @@ function readConfigFromFile(configStore, executeOption) {
     });
 }
 
-module.exports = preloadConfig;
+export default preloadConfig;

package/create-secrets/prompts/inquirer-fuzzy-path.js

@@ -1,12 +1,12 @@
-const fs = require("fs");
-const path = require("path");
-const util = require("util");
+import fs from "fs";
+import path from "path";
+import util from "util";
 
-const Choices = require("inquirer/lib/objects/choices");
-const InquirerAutocomplete = require("inquirer-autocomplete-prompt");
-const stripAnsi = require("strip-ansi");
-const style = require("ansi-styles");
-const fuzzy = require("fuzzy");
+import Choices from "inquirer/lib/objects/choices.js";
+import InquirerAutocomplete from "inquirer-autocomplete-prompt";
+import stripAnsi from "strip-ansi";
+import style from "ansi-styles";
+import fuzzy from "fuzzy";
 
 const readdir_ = util.promisify(fs.readdir);
 const maxScanDepth = 2;
@@ -114,4 +114,4 @@ function getPaths(rootPath, pattern, pathFilter) {
     return filterPromise;
 }
 
-module.exports = InquirerFuzzyPath;
+export default InquirerFuzzyPath;

package/create-secrets/prompts/list-with-transformer.js

@@ -1,7 +1,7 @@
-const List = require("inquirer/lib/prompts/list");
-const chalk = require("chalk");
-const figures = require("figures");
-const cliCursor = require("cli-cursor");
+import List from "inquirer/lib/prompts/list.js";
+import chalk from "chalk";
+import figures from "figures";
+import cliCursor from "cli-cursor";
 
 /**
  * A customized UI input (selection list).
@@ -98,4 +98,4 @@ function listRender(choices, pointer) {
     return output.replace(/\n$/, "");
 }
 
-module.exports = ListWithTransformer;
+export default ListWithTransformer;

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(
@@ -14,8 +14,8 @@ program
             "\nBoth `userNameOrId` & `nodeNameOrId` can be either entity name or Id. \n" +
             "\tIf more than one entities are located by entity name, the first one will be used."
     )
-    .option("<userNameOrId>", "user name or id")
-    .option("<nodeNameOrId>", "org unit node id or name")
+    .argument("<userNameOrId>", "user name or id")
+    .argument("<nodeNameOrId>", "org unit node id or name")
     .version(pkg.version)
     .action(async (userNameOrId, parentNodeNameOrId) => {
         try {

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

@@ -1,16 +1,16 @@
 #!/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(
         `Create a root tree node with specified name. You can then complete other node fields using other DB admin tools.`
     )
-    .option("<nodeName>", "Root node name")
+    .argument("<nodeName>", "Root node name")
     .version(pkg.version)
     .action(async (nodeName) => {
         try {

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(
@@ -14,7 +14,7 @@ program
             "\nIf -o or --only switch is on, only specified node will be removed and its children (if any) " +
             "will become its parent's children."
     )
-    .option("<nodeNameOrId>", "node name or id that to be removed")
+    .argument("<nodeNameOrId>", "node name or id that to be removed")
     .option(
         "-o, --only",
         "If only remove specified node and left its children (if any) to its parent"

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

@@ -1,19 +1,19 @@
 #!/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(
         "Insert a node as a child node of the specified the parent node with specified name. " +
             "\nIf the parent node name is given instead of the parent node Id, the newly created child node will be inserted to the first located parent node."
     )
-    .option("<parentNodeNameOrId>", "parent node id or name")
-    .option("<nodeName>", "insert node name")
+    .argument("<parentNodeNameOrId>", "parent node id or name")
+    .argument("<nodeName>", "insert node name")
     .version(pkg.version)
     .action(async (parentNodeNameOrId, nodeName) => {
         try {

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(
@@ -13,8 +13,8 @@ program
             "\nIf the node name is given instead of the node Id, the first located node (and its dependents) will be moved." +
             "\nIf the parent node name is given instead of the parent node Id, the specifed node will be moved to the first located parent node."
     )
-    .option("<nodeNameOrId>", "The id or name of the node to be moved")
-    .option("<parentNodeNameOrId>", "The new parent node id or name")
+    .argument("<nodeNameOrId>", "The id or name of the node to be moved")
+    .argument("<parentNodeNameOrId>", "The new parent node id or name")
     .version(pkg.version)
     .action(async (nodeNameOrId, parentNodeNameOrId) => {
         try {

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

@@ -1,16 +1,14 @@
 #!/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.")
-    .option("<userNameOrId>", "user name or id")
+    .argument("<userNameOrId>", "user name or id")
     .version(pkg.version)
     .action(async (userNameOrId) => {
         try {

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.1",
   "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",
@@ -28,8 +34,7 @@
     "release": "npm publish || echo \"Skip releasing npm package @magda/scripts.\""
   },
   "devDependencies": {
-    "@types/pg": "^8.6.5",
-    "@types/request": "^2.48.1"
+    "@types/pg": "^8.6.5"
   },
   "magda": {
     "language": "javascript",
@@ -39,14 +44,16 @@
     }
   },
   "dependencies": {
+    "@magda/esm-utils": "^1.0.1",
+    "@magda/typescript-common": "^3.0.0-alpha.1",
     "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",
@@ -57,20 +64,18 @@
     "klaw-sync": "^2.1.0",
     "lodash": "^4.17.5",
     "moment": "^2.19.4",
+    "node-fetch": "^3.3.2",
     "nodemon": "^1.11.0",
-    "pg": "^8.7.3",
-    "pkg": "^4.3.4",
+    "pg": "^8.11.3",
     "pwgen": "0.1.6",
-    "request": "^2.88.0",
     "stream-json": "^1.1.3",
     "strip-ansi": "^4.0.0",
     "strip-json-comments": "^2.0.1",
     "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.3.3",
     "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