Merge pull request #4297 from GordonSmith/V3_DDLSHIM

feat: Upgrade ddl-shim to v3
hpcc-systems · Nov 13, 2024 · 3e146cd · 3e146cd
2 parents d8d4ae6 + 4861665
commit 3e146cd
Show file tree

Hide file tree

Showing 17 changed files with 659 additions and 185 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -16,7 +16,7 @@
     "packages/comms",
     "packages/composite",
     "packages/dataflow",
-    "xpackages/ddl-shim",
+    "packages/ddl-shim",
     "xpackages/deck-shim",
     "packages/dgrid",
     "packages/dgrid-shim",

diff --git a/packages/comms/package.json b/packages/comms/package.json
@@ -58,7 +58,6 @@
         "wsdl-all": "npm-run-all --aggregate-output -c --serial build --parallel wsdl-*"
     },
     "dependencies": {
-        "@hpcc-js/ddl-shim": "^2.22.0",
         "@hpcc-js/util": "^3.1.0",
         "@xmldom/xmldom": "0.9.5",
         "abort-controller": "3.0.0",
@@ -69,6 +68,7 @@
     },
     "devDependencies": {
         "@hpcc-js/esbuild-plugins": "^1.2.0",
+        "@hpcc-js/ddl-shim": "^3.0.0",
         "@types/d3-request": "1.0.9",
         "@types/d3-time-format": "2.3.4",
         "@types/node": "^18",

diff --git a/packages/comms/src/services/wsEcl.ts b/packages/comms/src/services/wsEcl.ts
@@ -1,4 +1,4 @@
-import { DDL2 } from "@hpcc-js/ddl-shim";
+import type { DDL2 } from "@hpcc-js/ddl-shim";
 import { IConnection, IOptions } from "../connection.ts";
 import { ESPExceptions, Service } from "../espConnection.ts";
 

diff --git a/packages/ddl-shim/.vscode/launch.json b/packages/ddl-shim/.vscode/launch.json
@@ -0,0 +1,47 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "test-browser",
+            "type": "msedge",
+            "request": "launch",
+            "url": "http://localhost:8888",
+            "webRoot": "${workspaceFolder}",
+            "outFiles": [
+                "${workspaceFolder}/**/*.js",
+                "!**/node_modules/**"
+            ],
+        },
+        {
+            "name": "test-node",
+            "type": "node",
+            "request": "launch",
+            "runtimeArgs": [
+                "run-script",
+                "test-node"
+            ],
+            "runtimeExecutable": "npm",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "outFiles": [
+                "${workspaceFolder}/**/*.js",
+                "!**/node_modules/**"
+            ],
+        },
+        {
+            "name": "index.html",
+            "request": "launch",
+            "type": "msedge",
+            "url": "file:///${workspaceFolder}/index.html",
+            "runtimeArgs": [
+                "--disable-web-security"
+            ],
+            "webRoot": "${workspaceFolder}",
+            "outFiles": [
+                "${workspaceFolder}/**/*.js",
+                "!**/node_modules/**"
+            ]
+        }
+    ]
+}
diff --git a/packages/ddl-shim/.vscode/tasks.json b/packages/ddl-shim/.vscode/tasks.json
@@ -0,0 +1,36 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "gen-types-watch",
+            "type": "npm",
+            "script": "gen-types-watch",
+            "problemMatcher": [
+                "$tsc-watch"
+            ],
+            "presentation": {
+                "group": "group-build"
+            }
+        },
+        {
+            "label": "bundle-watch",
+            "type": "npm",
+            "script": "bundle-watch",
+            "problemMatcher": [],
+            "presentation": {
+                "group": "group-build"
+            }
+        },
+        {
+            "label": "build",
+            "dependsOn": [
+                "gen-types-watch",
+                "bundle-watch",
+            ],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        }
+    ]
+}
diff --git a/packages/ddl-shim/esbuild.js b/packages/ddl-shim/esbuild.js
@@ -0,0 +1,12 @@
+import { neutralTpl } from "@hpcc-js/esbuild-plugins";
+import pkg from "./package.json" with { type: "json" };
+
+//  config  ---
+await Promise.all([
+    neutralTpl("src/index.ts", "dist/index", {
+        keepNames: true,
+        external: [
+            ...Object.keys(pkg.dependencies),
+        ]
+    })
+]);
diff --git a/packages/ddl-shim/package.json b/packages/ddl-shim/package.json
@@ -1,54 +1,50 @@
 {
     "name": "@hpcc-js/ddl-shim",
-    "version": "2.22.0",
+    "version": "3.0.0",
     "description": "hpcc-js DDL parser",
-    "main": "dist/index.js",
-    "module": "dist/index.es6",
-    "unpkg": "dist/index.min.js",
-    "jsdelivr": "dist/index.min.js",
-    "bin": "dist/cli.js",
-    "types": "types/index.d.ts",
-    "typesVersions": {
-        "<3.8": {
-            "*": [
-                "types-3.4/index.d.ts"
-            ]
-        }
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./types/index.d.ts",
+            "default": "./dist/index.js"
+        },
+        "./dist/*": "./dist/*"
     },
+    "module": "./dist/index.js",
+    "browser": "./dist/index.js",
+    "types": "./types/index.d.ts",
     "files": [
         "dist/*",
         "src/*",
-        "schema/*.json",
         "types/*"
     ],
     "scripts": {
         "preinstall": "echo \"\" > cli.js",
-        "clean": "rimraf --glob bin lib* types dist ./src/ddl*Schema*.ts ./schema/*.json *.tsbuildinfo",
-        "compile-es6": "tsc --module es6 --outDir ./lib-es6",
-        "compile-es6-watch": "npm run compile-es6 -- -w",
+        "clean": "rimraf --glob bin lib* types dist ./src/ddl*Schema*.ts ./schema/*.json *.tsbuildinfo .turbo",
         "generate-v1": "ts-json-schema-generator --tsconfig tsconfig-schema.json --type DDLSchema > ./schema/v1.json",
         "generate-v2": "ts-json-schema-generator --tsconfig tsconfig-schema.json --type Schema > ./schema/v2.json",
         "generate": "run-p generate-v1 generate-v2",
-        "bundle": "rollup -c",
-        "bundle-watch": "npm run bundle -- --watch",
-        "minimize": "terser dist/index.js -c -m --source-map -o dist/index.min.js",
-        "gen-legacy-types": "downlevel-dts ./types ./types-3.4",
-        "build": "run-s generate compile-es6 bundle",
-        "watch": "npm-run-all compile-es6 -p compile-es6-watch bundle-watch",
+        "bundle": "node esbuild.js",
+        "bundle-watch": "npm run bundle -- --development --watch",
+        "gen-types": "tsc --project tsconfig.json",
+        "gen-types-watch": "npm run gen-types -- --watch",
+        "build": "npm-run-all --serial generate --parallel gen-types bundle",
         "stamp": "node ../../node_modules/@hpcc-js/bundle/src/stamp.js",
         "lint": "eslint ./src",
+        "lint-fix": "eslint --fix src/**/*.ts",
         "docs": "typedoc --options tdoptions.json .",
-        "update": "npx --yes npm-check-updates -u -t minor"
+        "coverage": "vitest run --coverage",
+        "update": "npx --yes npm-check-updates -u -t minor",
+        "update-major": "npx --yes npm-check-updates -u"
     },
     "dependencies": {
         "ajv": "6.12.6"
     },
     "devDependencies": {
-        "@hpcc-js/bundle": "^2.12.0",
+        "@hpcc-js/esbuild-plugins": "^1.2.0",
         "@rodrigoff/ajv-cli": "5.2.0",
         "@types/node": "^18",
-        "ts-json-schema-generator": "0.98.0",
-        "tslib": "2.7.0"
+        "ts-json-schema-generator": "0.98.0"
     },
     "repository": {
         "type": "git",
@@ -61,4 +57,4 @@
         "url": "https://github.com/hpcc-systems/Visualization/issues"
     },
     "homepage": "https://github.com/hpcc-systems/Visualization"
-}
+}
diff --git a/packages/ddl-shim/rollup.config.mjs b/packages/ddl-shim/rollup.config.mjs
diff --git a/packages/ddl-shim/src/cli.ts b/packages/ddl-shim/src/cli.ts
@@ -2,7 +2,7 @@ import * as fs from "fs";
 
 // @ts-ignore
 import * as ddl2Schema from "../schema/v2.json";
-import { upgrade } from "./upgrade";
+import { upgrade } from "./upgrade.ts";
 
 const args = process.argv.slice(2);
 

diff --git a/packages/ddl-shim/src/dermatology.ts b/packages/ddl-shim/src/dermatology.ts
@@ -1,4 +1,4 @@
-import * as DDL2 from "./ddl/v2";
+import * as DDL2 from "./ddl/v2.ts";
 
 const classMappings: any = {
     c3chart_Bar: "chart_Bar",

diff --git a/packages/ddl-shim/src/index.ts b/packages/ddl-shim/src/index.ts
@@ -1,8 +1,8 @@
-export * from "./__package__";
-import * as DDL1 from "./ddl/v1";
-import * as DDL2 from "./ddl/v2";
-export * from "./upgrade";
-export * from "./validate";
+export * from "./__package__.ts";
+import * as DDL1 from "./ddl/v1.ts";
+import * as DDL2 from "./ddl/v2.ts";
+export * from "./upgrade.ts";
+export * from "./validate.ts";
 
 export { DDL1, DDL2 };
 

diff --git a/packages/ddl-shim/src/upgrade.ts b/packages/ddl-shim/src/upgrade.ts
@@ -1,7 +1,7 @@
-import { PKG_NAME, PKG_VERSION } from "./__package__";
-import * as DDL1 from "./ddl/v1";
-import * as DDL2 from "./ddl/v2";
-import { upgrade as dermatologyUpgrade } from "./dermatology";
+import { PKG_NAME, PKG_VERSION } from "./__package__.ts";
+import * as DDL1 from "./ddl/v1.ts";
+import * as DDL2 from "./ddl/v2.ts";
+import { upgrade as dermatologyUpgrade } from "./dermatology.ts";
 
 interface IDatasourceOutput {
     datasource: DDL1.IAnyDatasource;

diff --git a/packages/ddl-shim/src/validate.ts b/packages/ddl-shim/src/validate.ts
@@ -1,6 +1,6 @@
 import * as _Ajv from "ajv";
-import * as DDL from "./ddl/v1";
-import * as DDL2 from "./ddl/v2";
+import * as DDL from "./ddl/v1.ts";
+import * as DDL2 from "./ddl/v2.ts";
 
 const Ajv = (_Ajv as any).default || _Ajv;
 
@@ -31,9 +31,8 @@ export function validate(ddl: DDL.DDLSchema) {
 }
 */
 
-// @ts-ignore
-import * as _ddl2Schema from "../schema/v2.json";
+import _ddl2Schema from "../schema/v2.json" with { type: "json" };
 
 export function validate2(ddl: DDL2.Schema) {
-    return doValidate(ddl, _ddl2Schema);
+    return doValidate(ddl, _ddl2Schema as any);
 }
diff --git a/packages/ddl-shim/tsconfig.json b/packages/ddl-shim/tsconfig.json
@@ -1,14 +1,25 @@
 {
-    "extends": "../tsconfig.settings.json",
     "compilerOptions": {
-        "rootDir": "./src",
-        "outDir": "./lib-umd",
-        "declarationDir": "./types",
-        "types": [
-            "node"
+        "rootDir": "src",
+        "module": "NodeNext",
+        "target": "ESNext",
+        "resolveJsonModule": true,
+        "emitDeclarationOnly": true,
+        "declaration": true,
+        "declarationDir": "types",
+        "strict": false,
+        "noImplicitAny": false,
+        "noImplicitThis": false,
+        "strictNullChecks": false,
+        "skipLibCheck": true,
+        "allowImportingTsExtensions": true,
+        "lib": [
+            "DOM",
+            "ESNext",
+            "ES2020"
         ]
     },
     "include": [
-        "./src/**/*"
+        "./src/index.ts"
     ]
 }
diff --git a/packages/ddl-shim/vitest.workspace.ts b/packages/ddl-shim/vitest.workspace.ts
@@ -0,0 +1,6 @@
+import { defineWorkspace } from 'vitest/config';
+import baseWorkspace from '../../vitest.workspace.ts';
+
+export default defineWorkspace([
+    ...baseWorkspace
+])
diff --git a/packages/dgrid/package.json b/packages/dgrid/package.json
@@ -42,7 +42,7 @@
     },
     "devDependencies": {
         "@hpcc-js/esbuild-plugins": "^1.2.0",
-        "@hpcc-js/ddl-shim": "^2.22.0",
+        "@hpcc-js/ddl-shim": "^3.0.0",
         "@testing-library/dom": "10.4.0",
         "d3-format": "^1",
         "d3-selection": "^1"