config-loader: bump typescript-json-schema and remove TS 4.3 workaround

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

.changeset/sharp-candles-type.md

@@ -0,0 +1,5 @@
+---
+'@backstage/config-loader': patch
+---
+
+Removed workaround for breaking change in typescript 4.3 and bump `typescript-json-schema` instead. This should again allow the usage of `@items.visibility <value>` to set the visibility of array items.

packages/config-loader/package.json

@@ -37,7 +37,7 @@
     "fs-extra": "^9.0.0",
     "json-schema": "^0.3.0",
     "json-schema-merge-allof": "^0.8.1",
-    "typescript-json-schema": "^0.49.0",
+    "typescript-json-schema": "^0.50.1",
     "yaml": "^1.9.2",
     "yup": "^0.29.3"
   },

packages/config-loader/src/lib/schema/collect.test.ts

@@ -28,6 +28,15 @@ const mockSchema = {
   },
 };
 
+// We need to load in actual TS libraries when using mock-fs.
+// This lookup is to allow the `typescript` dependency to exist either
+// at top level or inside node_modules of typescript-json-schema
+const typescriptModuleDir = path.dirname(
+  require.resolve('typescript/package.json', {
+    paths: [require.resolve('typescript-json-schema')],
+  }),
+);
+
 describe('collectConfigSchemas', () => {
   afterEach(() => {
     mockFs.restore();
@@ -157,9 +166,7 @@ describe('collectConfigSchemas', () => {
         },
       },
       // TypeScript compilation needs to load some real files inside the typescript dir
-      '../../node_modules/typescript': (mockFs as any).load(
-        '../../node_modules/typescript',
-      ),
+      [typescriptModuleDir]: (mockFs as any).load(typescriptModuleDir),
     });
 
     await expect(collectConfigSchemas(['a', 'b', 'c'])).resolves.toEqual([
@@ -218,9 +225,7 @@ describe('collectConfigSchemas', () => {
         },
       },
       // TypeScript compilation needs to load some real files inside the typescript dir
-      '../../node_modules/typescript': (mockFs as any).load(
-        '../../node_modules/typescript',
-      ),
+      [typescriptModuleDir]: (mockFs as any).load(typescriptModuleDir),
     });
 
     await expect(collectConfigSchemas(['a'])).rejects.toThrow(

packages/config-loader/src/lib/schema/collect.ts

@@ -168,23 +168,6 @@ function compileTsSchemas(paths: string[]) {
         },
         [path.split(sep).join('/')], // Unix paths are expected for all OSes here
       ) as JsonObject | null;
-
-      // This is a workaround for an API change in TypeScript 4.3 where doc comments no
-      // longer are represented by a single string, but instead an array of objects.
-      // This isn't handled by typescript-json-schema so we do the conversion here instead.
-      value = JSON.parse(JSON.stringify(value), (key, prop) => {
-        if (key === 'visibility' && Array.isArray(prop)) {
-          const text = prop[0]?.text;
-          if (!text) {
-            const propStr = JSON.stringify(prop);
-            throw new Error(
-              `Failed conversion of visibility schema, got ${propStr}`,
-            );
-          }
-          return text;
-        }
-        return prop;
-      });
     } catch (error) {
       if (error.message !== 'type Config not found') {
         throw error;

yarn.lock

@@ -6161,6 +6161,11 @@
   resolved "https://registry.npmjs.org/@types/node/-/node-13.13.45.tgz#e6676bcca092bae5751d015f074a234d5a82eb63"
   integrity sha512-703YTEp8AwQeapI0PTXDOj+Bs/mtdV/k9VcTP7z/de+lx6XjFMKdB+JhKnK+6PZ5za7omgZ3V6qm/dNkMj/Zow==
 
+"@types/node@^14.14.33":
+  version "14.17.3"
+  resolved "https://registry.npmjs.org/@types/node/-/node-14.17.3.tgz#6d327abaa4be34a74e421ed6409a0ae2f47f4c3d"
+  integrity sha512-e6ZowgGJmTuXa3GyaPbTGxX17tnThl2aSSizrFthQ7m9uLGZBXiGhgE55cjRZTF5kjZvYn9EOPOMljdjwbflxw==
+
 "@types/normalize-package-data@^2.4.0":
   version "2.4.0"
   resolved "https://registry.npmjs.org/@types/normalize-package-data/-/normalize-package-data-2.4.0.tgz#e486d0d97396d79beedd0a6e33f4534ff6b4973e"
@@ -25679,11 +25684,29 @@ typescript-json-schema@^0.49.0:
     typescript "^4.1.3"
     yargs "^16.2.0"
 
+typescript-json-schema@^0.50.1:
+  version "0.50.1"
+  resolved "https://registry.npmjs.org/typescript-json-schema/-/typescript-json-schema-0.50.1.tgz#48041eb9f6efbdf4ba88c3e3af9433601f7a2b47"
+  integrity sha512-GCof/SDoiTDl0qzPonNEV4CHyCsZEIIf+mZtlrjoD8vURCcEzEfa2deRuxYid8Znp/e27eDR7Cjg8jgGrimBCA==
+  dependencies:
+    "@types/json-schema" "^7.0.7"
+    "@types/node" "^14.14.33"
+    glob "^7.1.6"
+    json-stable-stringify "^1.0.1"
+    ts-node "^9.1.1"
+    typescript "~4.2.3"
+    yargs "^16.2.0"
+
 typescript@^4.0.3, typescript@^4.1.3, typescript@~4.1.3:
   version "4.2.3"
   resolved "https://registry.npmjs.org/typescript/-/typescript-4.2.3.tgz#39062d8019912d43726298f09493d598048c1ce3"
   integrity sha512-qOcYwxaByStAWrBf4x0fibwZvMRG+r4cQoTjbPtUlrWjBHbmCAww1i448U0GJ+3cNNEtebDteo/cHOR3xJ4wEw==
 
+typescript@~4.2.3:
+  version "4.2.4"
+  resolved "https://registry.npmjs.org/typescript/-/typescript-4.2.4.tgz#8610b59747de028fda898a8aef0e103f156d0961"
+  integrity sha512-V+evlYHZnQkaz8TRBuxTA92yZBPotr5H+WhQ7bD3hZUndx5tGOa1fuCgeSjxAzM1RiN5IzvadIXTVefuuwZCRg==
+
 ua-parser-js@^0.7.18:
   version "0.7.28"
   resolved "https://registry.npmjs.org/ua-parser-js/-/ua-parser-js-0.7.28.tgz#8ba04e653f35ce210239c64661685bf9121dec31"