@strapi/typescript-utils 4.1.3

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015-present Strapi Solutions SAS
+
+Portions of the Strapi software are licensed as follows:
+
+* All software that resides under an "ee/" directory (the “EE Software”), if that directory exists, is licensed under the license defined in "ee/LICENSE".
+
+* All software outside of the above-mentioned directories or restrictions above is available under the "MIT Expat" license as set forth below.
+
+MIT Expat License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/compile.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const compilers = require('./compilers');
+const getConfigPath = require('./utils/get-config-path');
+const copyResources = require('./utils/copy-resources');
+
+module.exports = async (srcDir, { watch = false } = {}) => {
+  // TODO: Use the Strapi debug logger instead or don't log at all
+  console.log(`Starting the compilation for TypeScript files in ${srcDir}`);
+
+  const compiler = watch ? compilers.watch : compilers.basic;
+  const configPath = getConfigPath(srcDir);
+
+  compiler.run(configPath);
+
+  await copyResources(srcDir);
+};

package/lib/compilers/basic.js

@@ -0,0 +1,38 @@
+'use strict';
+
+const ts = require('typescript');
+
+const reportDiagnostics = require('../utils/report-diagnostics');
+const resolveConfigOptions = require('../utils/resolve-config-options');
+
+module.exports = {
+  /**
+   * Default TS -> JS Compilation for Strapi
+   * @param {string} tsConfigPath
+   */
+  run(tsConfigPath) {
+    // Parse the tsconfig.json file & resolve the configuration options
+    const { fileNames, options, projectReferences } = resolveConfigOptions(tsConfigPath);
+
+    const program = ts.createProgram({
+      rootNames: fileNames,
+      projectReferences,
+      options,
+    });
+
+    const emitResults = program.emit();
+
+    const diagnostics = ts.sortAndDeduplicateDiagnostics(
+      ts.getPreEmitDiagnostics(program).concat(emitResults.diagnostics)
+    );
+
+    if (diagnostics.length > 0) {
+      reportDiagnostics(diagnostics);
+    }
+
+    // If the compilation failed, exit early
+    if (emitResults.emitSkipped) {
+      process.exit(1);
+    }
+  },
+};

package/lib/compilers/index.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const basic = require('./basic');
+const watch = require('./watch');
+
+module.exports = {
+  basic,
+  watch,
+};

package/lib/compilers/watch.js

@@ -0,0 +1,37 @@
+'use strict';
+
+const ts = require('typescript');
+
+const reportDiagnostics = require('../utils/report-diagnostics');
+const formatHost = require('../utils/format-host');
+const resolveConfigOptions = require('../utils/resolve-config-options');
+
+/**
+ * Prints a diagnostic every time the watch status changes.
+ * This is mainly for messages like "Starting compilation" or "Compilation completed".
+ */
+const reportWatchStatusChanged = diagnostic => {
+  console.info(ts.formatDiagnostic(diagnostic, formatHost));
+};
+
+module.exports = {
+  run(configPath) {
+    const createProgram = ts.createSemanticDiagnosticsBuilderProgram;
+
+    const { fileNames, options, projectReferences, watchOptions } = resolveConfigOptions(
+      configPath
+    );
+    const host = ts.createWatchCompilerHost(
+      fileNames,
+      options,
+      ts.sys,
+      createProgram,
+      reportDiagnostics,
+      reportWatchStatusChanged,
+      projectReferences,
+      watchOptions
+    );
+
+    ts.createWatchProgram(host);
+  },
+};

package/lib/index.js

@@ -0,0 +1,12 @@
+'use strict';
+
+const compile = require('./compile');
+const compilers = require('./compilers');
+const utils = require('./utils');
+
+module.exports = {
+  compile,
+  compilers,
+
+  ...utils,
+};

package/lib/utils/copy-resources.js

@@ -0,0 +1,12 @@
+'use strict';
+
+const path = require('path');
+const fse = require('fs-extra');
+
+const DEFAULT_RESOURCES_PATHS = ['public', 'favicon.ico', 'package.json'];
+
+module.exports = async (dir, resources = DEFAULT_RESOURCES_PATHS) => {
+  await Promise.all(
+    resources.map(resourceName => fse.copy(resourceName, path.join(dir, 'dist', resourceName)))
+  );
+};

package/lib/utils/format-host.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const ts = require('typescript');
+const { identity } = require('lodash/fp');
+
+/**
+ * @type {ts.FormatDiagnosticsHost}
+ */
+const formatHost = {
+  getCanonicalFileName: identity,
+  getCurrentDirectory: ts.sys.getCurrentDirectory,
+  getNewLine: () => ts.sys.newLine,
+};
+
+module.exports = formatHost;

package/lib/utils/get-config-path.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const ts = require('typescript');
+
+const DEFAULT_FILE_NAME = 'tsconfig-server.json';
+
+module.exports = (dir, filename = DEFAULT_FILE_NAME) => {
+  return ts.findConfigFile(dir, ts.sys.fileExists, filename);
+};

package/lib/utils/index.js

@@ -0,0 +1,19 @@
+'use strict';
+
+const isTypeScriptProject = require('./is-typescript-project');
+const isTypeScriptProjectSync = require('./is-typescript-project-sync');
+const getConfigPath = require('./get-config-path');
+const reportDiagnostics = require('./report-diagnostics');
+const resolveConfigOptions = require('./resolve-config-options');
+const copyResources = require('./copy-resources');
+const formatHost = require('./format-host');
+
+module.exports = {
+  isTypeScriptProject,
+  isTypeScriptProjectSync,
+  getConfigPath,
+  reportDiagnostics,
+  resolveConfigOptions,
+  copyResources,
+  formatHost,
+};

package/lib/utils/is-typescript-project-sync.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const fse = require('fs-extra');
+
+const getConfigPath = require('./get-config-path');
+
+/**
+ * Checks if `dir` is a TypeScript directory (whether there is a tsconfig file or not)
+ * @param {string} dir
+ * @param {string | undefined} filename
+ * @returns {boolean}
+ */
+module.exports = (dir, filename = undefined) => {
+  const filePath = getConfigPath(dir, filename);
+
+  return fse.pathExistsSync(filePath);
+};

package/lib/utils/is-typescript-project.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const fse = require('fs-extra');
+
+const getConfigPath = require('./get-config-path');
+
+/**
+ * Checks if `dir` is a TypeScript directory (whether there is a tsconfig file or not)
+ * @param {string} dir
+ * @param {string | undefined} filename
+ * @returns {Promise<boolean>}
+ */
+module.exports = (dir, filename = undefined) => {
+  const filePath = getConfigPath(dir, filename);
+
+  return fse.pathExists(filePath);
+};

package/lib/utils/report-diagnostics.js

@@ -0,0 +1,19 @@
+'use strict';
+
+const ts = require('typescript');
+
+const formatHost = require('./format-host');
+
+/**
+ * Report one or several diagnostic to the console
+ * @param {ts.Diagnostic[] | ts.Diagnostic} diagnostics
+ */
+module.exports = diagnostics => {
+  const formattedDiagnostics = ts.formatDiagnosticsWithColorAndContext(
+    Array.isArray(diagnostics) ? diagnostics : [diagnostics],
+    formatHost
+  );
+
+  console.error(formattedDiagnostics);
+  console.info(`Found ${diagnostics.length} error(s).${ts.sys.newLine}`);
+};

package/lib/utils/resolve-config-options.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const ts = require('typescript');
+
+const logDiagnostics = require('./report-diagnostics');
+
+module.exports = configPath => {
+  // Parse the tsconfig.json file and resolve every file name & compiler options
+  const { errors, ...configOptions } = ts.getParsedCommandLineOfConfigFile(
+    configPath,
+    undefined,
+    ts.sys
+  );
+
+  // If there are errors in the tsconfig.json
+  // file, report them and exit early
+  if (errors.length > 0) {
+    logDiagnostics(errors);
+    process.exit(1);
+  }
+
+  return configOptions;
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@strapi/typescript-utils",
+  "version": "4.1.3",
+  "description": "Typescript support for Strapi",
+  "keywords": [
+    "strapi",
+    "generators"
+  ],
+  "license": "SEE LICENSE IN LICENSE",
+  "author": {
+    "name": "Strapi Solutions SAS",
+    "email": "hi@strapi.io",
+    "url": "https://strapi.io"
+  },
+  "maintainers": [
+    {
+      "name": "Strapi Solutions SAS",
+      "email": "hi@strapi.io",
+      "url": "https://strapi.io"
+    }
+  ],
+  "main": "./lib/index.js",
+  "directories": {
+    "lib": "./lib"
+  },
+  "dependencies": {
+    "lodash": "4.17.21",
+    "fs-extra": "10.0.1",
+    "typescript": "4.6.2"
+  },
+  "engines": {
+    "node": ">=12.22.0 <=16.x.x",
+    "npm": ">=6.0.0"
+  }
+}