@strapi/typescript-utils 5.50.1 → 5.50.2

package/lib/generators/content-types/index.js

@@ -1,74 +0,0 @@
-'use strict';
-
-const { factory } = require('typescript');
-const { values, pipe, map, sortBy } = require('lodash/fp');
-
-const { models } = require('../common');
-const { emitDefinitions, format, generateSharedExtensionDefinition } = require('../utils');
-
-const NO_CONTENT_TYPE_PLACEHOLDER_COMMENT = `/*
- * The app doesn't have any content-types yet.
- */
-`;
-
-/**
- * Generate type definitions for Strapi Content-Types
- *
- * @param {object} [options]
- * @param {object} options.strapi
- * @param {object} options.logger
- * @param {string} options.pwd
- */
-const generateContentTypesDefinitions = async (options = {}) => {
-  const { strapi } = options;
-
-  const { contentTypes } = strapi;
-
-  const contentTypesDefinitions = pipe(
-    values,
-    sortBy('uid'),
-    map((contentType) => ({
-      uid: contentType.uid,
-      definition: models.schema.generateSchemaDefinition(contentType),
-    }))
-  )(contentTypes);
-
-  options.logger.debug(`Found ${contentTypesDefinitions.length} content-types.`);
-
-  if (contentTypesDefinitions.length === 0) {
-    return { output: NO_CONTENT_TYPE_PLACEHOLDER_COMMENT, stats: {} };
-  }
-
-  const formattedSchemasDefinitions = contentTypesDefinitions.reduce((acc, def) => {
-    acc.push(
-      // Definition
-      def.definition,
-
-      // Add a newline between each interface declaration
-      factory.createIdentifier('\n')
-    );
-
-    return acc;
-  }, []);
-
-  const allDefinitions = [
-    // Imports
-    ...models.imports.generateImportDefinition(),
-
-    // Add a newline after the import statement
-    factory.createIdentifier('\n'),
-
-    // Schemas
-    ...formattedSchemasDefinitions,
-
-    // Global
-    generateSharedExtensionDefinition('ContentTypeSchemas', contentTypesDefinitions),
-  ];
-
-  const output = emitDefinitions(allDefinitions);
-  const formattedOutput = await format(output);
-
-  return { output: formattedOutput, stats: {} };
-};
-
-module.exports = generateContentTypesDefinitions;

package/lib/generators/index.js

@@ -1,122 +0,0 @@
-'use strict';
-
-const path = require('path');
-const chalk = require('chalk');
-
-const { TYPES_ROOT_DIR, GENERATED_OUT_DIR } = require('./constants');
-const { saveDefinitionToFileSystem, createLogger, timer } = require('./utils');
-const generateContentTypesDefinitions = require('./content-types');
-const generateComponentsDefinitions = require('./components');
-
-const GENERATORS = {
-  contentTypes: generateContentTypesDefinitions,
-  components: generateComponentsDefinitions,
-};
-
-/**
- * @typedef GenerateConfig
- *
- * @property {object} strapi
- * @property {boolean} pwd
- * @property {object} [artifacts]
- * @property {boolean} [artifacts.contentTypes]
- * @property {boolean} [artifacts.components]
- * @property {boolean} [artifacts.services]
- * @property {boolean} [artifacts.controllers]
- * @property {boolean} [artifacts.policies]
- * @property {boolean} [artifacts.middlewares]
- * @property {object} [logger]
- * @property {boolean} [logger.silent]
- * @property {boolean} [logger.debug]
- * @property {boolean} [logger.verbose]
- */
-
-/**
- * Generate types definitions based on the given configuration
- *
- * @param {GenerateConfig} [config]
- */
-const generate = async (config = {}) => {
-  const { pwd, rootDir = TYPES_ROOT_DIR, strapi, artifacts = {}, logger: loggerConfig } = config;
-  const reports = {};
-  const logger = createLogger(loggerConfig);
-  const psTimer = timer().start();
-
-  const registryPwd = path.join(pwd, rootDir, GENERATED_OUT_DIR);
-  const generatorConfig = { strapi, pwd: registryPwd, logger };
-
-  const returnWithMessage = () => {
-    const nbWarnings = chalk.yellow(`${logger.warnings} warning(s)`);
-    const nbErrors = chalk.red(`${logger.errors} error(s)`);
-
-    const status = logger.errors > 0 ? chalk.red('errored') : chalk.green('completed successfully');
-
-    psTimer.end();
-
-    logger.info(`The task ${status} with ${nbWarnings} and ${nbErrors} in ${psTimer.duration}s.`);
-
-    return reports;
-  };
-
-  const enabledArtifacts = Object.keys(artifacts).filter((p) => artifacts[p] === true);
-
-  logger.info('Starting the type generation process');
-  logger.debug(`Enabled artifacts: ${enabledArtifacts.join(', ')}`);
-
-  for (const artifact of enabledArtifacts) {
-    const boldArtifact = chalk.bold(artifact); // used for log messages
-
-    logger.info(`Generating types for ${boldArtifact}`);
-
-    if (artifact in GENERATORS) {
-      const generator = GENERATORS[artifact];
-
-      try {
-        const artifactGenTimer = timer().start();
-
-        reports[artifact] = await generator(generatorConfig);
-
-        artifactGenTimer.end();
-
-        logger.debug(`Generated ${boldArtifact} in ${artifactGenTimer.duration}s`);
-      } catch (e) {
-        logger.error(
-          `Failed to generate types for ${boldArtifact}: ${e.message ?? e.toString()}. Exiting`
-        );
-        return returnWithMessage();
-      }
-    } else {
-      logger.warn(`The types generator for ${boldArtifact} is not implemented, skipping`);
-    }
-  }
-
-  for (const artifact of Object.keys(reports)) {
-    const boldArtifact = chalk.bold(artifact); // used for log messages
-
-    const artifactFsTimer = timer().start();
-
-    const report = reports[artifact];
-    const filename = `${artifact}.d.ts`;
-
-    try {
-      const outPath = await saveDefinitionToFileSystem(registryPwd, filename, report.output);
-      const relativeOutPath = path.relative(process.cwd(), outPath);
-
-      artifactFsTimer.end();
-
-      logger.info(`Saved ${boldArtifact} types in ${chalk.bold(relativeOutPath)}`);
-      logger.debug(`Saved ${boldArtifact} in ${artifactFsTimer.duration}s`);
-    } catch (e) {
-      logger.error(
-        `An error occurred while saving ${boldArtifact} types to the filesystem: ${
-          e.message ?? e.toString()
-        }. Exiting`
-      );
-      return returnWithMessage();
-    }
-  }
-
-  return returnWithMessage();
-};
-
-module.exports = { generate };

package/lib/generators/utils.js

@@ -1,217 +0,0 @@
-'use strict';
-
-const path = require('path');
-const assert = require('assert');
-const ts = require('typescript');
-const fse = require('fs-extra');
-const chalk = require('chalk');
-
-const { factory } = ts;
-
-const MODULE_DECLARATION = '@strapi/strapi';
-const PUBLIC_NAMESPACE = 'Public';
-
-/**
- * Aggregate the given TypeScript nodes into a single string
- *
- * @param {ts.Node[]} definitions
- * @return {string}
- */
-const emitDefinitions = (definitions) => {
-  const nodeArray = factory.createNodeArray(definitions);
-
-  const sourceFile = ts.createSourceFile(
-    'placeholder.ts',
-    '',
-    ts.ScriptTarget.ESNext,
-    true,
-    ts.ScriptKind.TS
-  );
-
-  const printer = ts.createPrinter({ omitTrailingSemicolon: true });
-
-  return printer.printList(ts.ListFormat.MultiLine, nodeArray, sourceFile);
-};
-
-/**
- * Save the given string representation of TS nodes in a file
- * If the given directory doesn't exist, it'll be created automatically
- *
- * @param {string} dir
- * @param {string} file
- * @param {string} content
- *
- * @return {Promise<string>} The path of the created file
- */
-const saveDefinitionToFileSystem = async (dir, file, content) => {
-  const filepath = path.join(dir, file);
-
-  fse.ensureDirSync(dir);
-  await fse.writeFile(filepath, content);
-
-  return filepath;
-};
-
-/**
- * Format the given definitions.
- * Uses the existing config if one is defined in the project.
- *
- * @param {string} content
- * @returns {Promise<string>}
- */
-const format = async (content) => {
-  // eslint-disable-next-line node/no-unsupported-features/es-syntax
-  const prettier = await import('prettier'); // ESM-only
-
-  const configFile = await prettier.resolveConfigFile();
-  const config = configFile
-    ? await prettier.resolveConfig(configFile)
-    : // Default config
-      {
-        singleQuote: true,
-        useTabs: false,
-        tabWidth: 2,
-      };
-
-  Object.assign(config, { parser: 'typescript' });
-
-  return prettier.format(content, config);
-};
-
-/**
- * Generate the extension block for a shared component from strapi/strapi
- *
- * @param {string} registry The registry to extend
- * @param {Array<{ uid: string; definition: ts.TypeNode }>} definitions
- * @returns {ts.ModuleDeclaration}
- */
-const generateSharedExtensionDefinition = (registry, definitions) => {
-  const properties = definitions.map(({ uid, definition }) =>
-    factory.createPropertySignature(
-      undefined,
-      factory.createStringLiteral(uid, true),
-      undefined,
-      factory.createTypeReferenceNode(factory.createIdentifier(definition.name.escapedText))
-    )
-  );
-
-  return factory.createModuleDeclaration(
-    [factory.createModifier(ts.SyntaxKind.DeclareKeyword)],
-    factory.createStringLiteral(MODULE_DECLARATION, true),
-    factory.createModuleBlock([
-      factory.createModuleDeclaration(
-        [factory.createModifier(ts.SyntaxKind.ExportKeyword)],
-        factory.createIdentifier(PUBLIC_NAMESPACE),
-        factory.createModuleBlock(
-          properties.length > 0
-            ? [
-                factory.createInterfaceDeclaration(
-                  [factory.createModifier(ts.SyntaxKind.ExportKeyword)],
-                  factory.createIdentifier(registry),
-                  undefined,
-                  undefined,
-                  properties
-                ),
-              ]
-            : []
-        ),
-        ts.NodeFlags.Namespace
-      ),
-    ]),
-    ts.NodeFlags.ExportContext
-  );
-};
-
-const createLogger = (options = {}) => {
-  const { silent = false, debug = false } = options;
-
-  const state = { errors: 0, warning: 0 };
-
-  return {
-    get warnings() {
-      return state.warning;
-    },
-
-    get errors() {
-      return state.errors;
-    },
-
-    debug(...args) {
-      if (silent || !debug) {
-        return;
-      }
-
-      console.log(chalk.cyan(`[DEBUG]\t[${new Date().toISOString()}] (Typegen)`), ...args);
-    },
-
-    info(...args) {
-      if (silent) {
-        return;
-      }
-
-      console.info(chalk.blue(`[INFO]\t[${new Date().toISOString()}] (Typegen)`), ...args);
-    },
-
-    warn(...args) {
-      state.warning += 1;
-
-      if (silent) {
-        return;
-      }
-
-      console.warn(chalk.yellow(`[WARN]\t[${new Date().toISOString()}] (Typegen)`), ...args);
-    },
-
-    error(...args) {
-      state.errors += 1;
-
-      if (silent) {
-        return;
-      }
-
-      console.error(chalk.red(`[ERROR]\t[${new Date().toISOString()}] (Typegen)`), ...args);
-    },
-  };
-};
-
-const timer = () => {
-  const state = {
-    start: null,
-    end: null,
-  };
-
-  return {
-    start() {
-      assert(state.start === null, 'The timer has already been started');
-      assert(state.end === null, 'The timer has already been ended');
-
-      state.start = Date.now();
-
-      return this;
-    },
-
-    end() {
-      assert(state.start !== null, 'The timer needs to be started before ending it');
-      assert(state.end === null, 'The timer has already been ended');
-
-      state.end = Date.now();
-
-      return this;
-    },
-
-    get duration() {
-      assert(state.start !== null, 'The timer has not been started');
-
-      return ((state.end ?? Date.now) - state.start) / 1000;
-    },
-  };
-};
-
-module.exports = {
-  emitDefinitions,
-  saveDefinitionToFileSystem,
-  format,
-  generateSharedExtensionDefinition,
-  createLogger,
-  timer,
-};

package/lib/index.js

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

package/lib/utils/format-host.js

@@ -1,15 +0,0 @@
-'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

@@ -1,29 +0,0 @@
-'use strict';
-
-const path = require('path');
-const ts = require('typescript');
-
-const DEFAULT_TS_CONFIG_FILENAME = 'tsconfig.json';
-
-/**
- * Get the path of the typescript config file for a given directory
- *
- * @param {string} dir
- * @param {object} [options]
- * @param {string} [options.filename]
- * @param {boolean} [options.ancestorsLookup]
- *
- * @return {string | undefined}
- */
-module.exports = (dir, { filename = DEFAULT_TS_CONFIG_FILENAME, ancestorsLookup = false } = {}) => {
-  const dirAbsolutePath = path.resolve(dir);
-  let configFilePath = ts.findConfigFile(dirAbsolutePath, ts.sys.fileExists, filename);
-
-  if (configFilePath) configFilePath = path.resolve(configFilePath);
-
-  if (!configFilePath || ancestorsLookup) {
-    return configFilePath;
-  }
-
-  return configFilePath.startsWith(dirAbsolutePath) ? configFilePath : undefined;
-};

package/lib/utils/index.js

@@ -1,21 +0,0 @@
-'use strict';
-
-const isUsingTypeScript = require('./is-using-typescript');
-const isUsingTypeScriptSync = require('./is-using-typescript-sync');
-const getConfigPath = require('./get-config-path');
-const reportDiagnostics = require('./report-diagnostics');
-const resolveConfigOptions = require('./resolve-config-options');
-const formatHost = require('./format-host');
-const resolveOutDir = require('./resolve-outdir');
-const resolveOutDirSync = require('./resolve-outdir-sync');
-
-module.exports = {
-  isUsingTypeScript,
-  isUsingTypeScriptSync,
-  getConfigPath,
-  reportDiagnostics,
-  resolveConfigOptions,
-  formatHost,
-  resolveOutDir,
-  resolveOutDirSync,
-};

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

@@ -1,19 +0,0 @@
-// @ts-check
-
-'use strict';
-
-const fse = require('fs-extra');
-
-const getConfigPath = require('./get-config-path');
-
-/**
- * Checks if `dir` is a using TypeScript (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 filePath ? fse.pathExistsSync(filePath) : false;
-};

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

@@ -1,17 +0,0 @@
-'use strict';
-
-const fse = require('fs-extra');
-
-const getConfigPath = require('./get-config-path');
-
-/**
- * Checks if `dir` is a using TypeScript (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

@@ -1,19 +0,0 @@
-'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

@@ -1,23 +0,0 @@
-'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/lib/utils/resolve-outdir-sync.js

@@ -1,18 +0,0 @@
-'use strict';
-
-const path = require('path');
-const resolveConfigOptions = require('./resolve-config-options');
-const isUsingTypescriptSync = require('./is-using-typescript-sync');
-
-const DEFAULT_TS_CONFIG_FILENAME = 'tsconfig.json';
-/**
- * Gets the outDir value from config file (tsconfig)
- * @param {string} dir
- * @param {string | undefined} configFilename
- * @returns {string | undefined}
- */
-module.exports = (dir, configFilename = DEFAULT_TS_CONFIG_FILENAME) => {
-  return isUsingTypescriptSync(dir)
-    ? resolveConfigOptions(path.join(dir, configFilename)).options.outDir
-    : undefined;
-};

package/lib/utils/resolve-outdir.js

@@ -1,18 +0,0 @@
-'use strict';
-
-const path = require('path');
-const resolveConfigOptions = require('./resolve-config-options');
-const isUsingTypescript = require('./is-using-typescript');
-
-const DEFAULT_TS_CONFIG_FILENAME = 'tsconfig.json';
-/**
- * Gets the outDir value from config file (tsconfig)
- * @param {string} dir
- * @param {string | undefined} configFilename
- * @returns {Promise<string | undefined>}
- */
-module.exports = async (dir, configFilename = DEFAULT_TS_CONFIG_FILENAME) => {
-  return (await isUsingTypescript(dir))
-    ? resolveConfigOptions(path.join(dir, configFilename)).options.outDir
-    : undefined;
-};

package/lint-staged.config.mjs

@@ -1 +0,0 @@
-export { default } from '../../../lint-staged.shared.mjs';