@strapi/typescript-utils 0.0.0-next.e3b4cdeebf6e9b0cd5575ff80b8a86715d44ce98 → 0.0.0-next.e6eaa3d0563c85f80fd88b258df70a55c057096e

package/lib/generators/index.js

@@ -1,7 +1,122 @@
 'use strict';
 
-const generateSchemasDefinitions = require('./schemas');
+const path = require('path');
+const chalk = require('chalk');
 
-module.exports = {
-  generateSchemasDefinitions,
+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(__dirname, 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

@@ -0,0 +1,211 @@
+'use strict';
+
+const path = require('path');
+const assert = require('assert');
+const ts = require('typescript');
+const prettier = require('prettier');
+const fse = require('fs-extra');
+const chalk = require('chalk');
+
+const { factory } = ts;
+
+/**
+ * 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) => {
+  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('@strapi/types', true),
+    factory.createModuleBlock([
+      factory.createModuleDeclaration(
+        [factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+        factory.createIdentifier('Shared'),
+        factory.createModuleBlock(
+          properties.length > 0
+            ? [
+                factory.createInterfaceDeclaration(
+                  [factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+                  factory.createIdentifier(registry),
+                  undefined,
+                  undefined,
+                  properties
+                ),
+              ]
+            : []
+        )
+      ),
+    ]),
+    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/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@strapi/typescript-utils",
-  "version": "0.0.0-next.e3b4cdeebf6e9b0cd5575ff80b8a86715d44ce98",
+  "version": "0.0.0-next.e6eaa3d0563c85f80fd88b258df70a55c057096e",
   "description": "Typescript support for Strapi",
   "keywords": [
     "strapi",
     "generators"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/strapi/strapi.git",
+    "directory": "packages/utils/typescript"
+  },
   "license": "SEE LICENSE IN LICENSE",
   "author": {
     "name": "Strapi Solutions SAS",
@@ -32,14 +37,14 @@
   "dependencies": {
     "chalk": "4.1.2",
     "cli-table3": "0.6.2",
-    "fs-extra": "10.0.1",
+    "fs-extra": "10.0.0",
     "lodash": "4.17.21",
     "prettier": "2.8.4",
-    "typescript": "5.0.4"
+    "typescript": "5.2.2"
   },
   "engines": {
-    "node": ">=14.19.1 <=18.x.x",
+    "node": ">=18.0.0 <=20.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "e3b4cdeebf6e9b0cd5575ff80b8a86715d44ce98"
+  "gitHead": "e6eaa3d0563c85f80fd88b258df70a55c057096e"
 }

package/tsconfigs/admin.json

@@ -1,20 +1,19 @@
 {
-    "$schema": "https://json.schemastore.org/tsconfig",
-    
-    "compilerOptions": {
-        "module": "ES2020",
-        "moduleResolution": "node",
-        "lib": ["ES2020", "DOM"],
-        "target": "ES5",
-
-        "jsx": "react",
-        "sourceMap": true,
-        "incremental": true,
-
-        "allowJs": true,
-        "allowSyntheticDefaultImports": true,
-        "resolveJsonModule": true,
-        "noEmit": true,
-        "skipLibCheck": true
-    }
-}
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "useDefineForClassFields": true,
+    "lib": ["DOM", "DOM.Iterable", "ESNext"],
+    "allowJs": false,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "noEmit": true,
+    "jsx": "react-jsx"
+  }
+}

package/tsconfigs/server.json

@@ -1,19 +1,20 @@
 {
-    "$schema": "https://json.schemastore.org/tsconfig",
-    
-    "compilerOptions": {
-        "module": "CommonJS",
-        "moduleResolution": "Node",
-        "lib": ["ES2020"],
-        "target": "ES2019",
+  "$schema": "https://json.schemastore.org/tsconfig",
 
-        "strict": false,
-        "skipLibCheck": true,
-        "forceConsistentCasingInFileNames": true,
+  "compilerOptions": {
+    "module": "CommonJS",
+    "moduleResolution": "Node",
+    "lib": ["ES2020"],
+    "target": "ES2019",
 
-        "incremental": true,
-        "esModuleInterop": true,
-        "resolveJsonModule": true,
-        "noEmitOnError": true
-    }
-}
+    "strict": false,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+
+    "incremental": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "noEmitOnError": true,
+    "noImplicitThis": true
+  }
+}

package/lib/__tests__/generators/schemas/global.test.js

@@ -1,108 +0,0 @@
-'use strict';
-
-jest.mock('../../../generators/schemas/utils', () => ({
-  getSchemaInterfaceName: jest.fn(),
-}));
-
-const ts = require('typescript');
-const { get } = require('lodash/fp');
-
-const { generateGlobalDefinition } = require('../../../generators/schemas/global');
-const { getSchemaInterfaceName } = require('../../../generators/schemas/utils');
-
-const getSchemasInterfaceNode = get('body.statements[0].body.statements[0]');
-
-describe('Global', () => {
-  afterAll(() => {
-    jest.resetAllMocks();
-  });
-
-  const assertGlobalNodeStructure = (node) => {
-    // "declare global"
-    expect(node.kind).toBe(ts.SyntaxKind.ModuleDeclaration);
-    expect(node.modifiers).toHaveLength(1);
-    expect(node.modifiers[0].kind).toBe(ts.SyntaxKind.DeclareKeyword);
-    expect(node.name.originalKeywordKind).toBe(ts.SyntaxKind.GlobalKeyword);
-    expect(node.name.escapedText).toBe('global');
-
-    // "namespace Strapi"
-    const [strapiNamespace] = node.body.statements;
-
-    expect(strapiNamespace.kind).toBe(ts.SyntaxKind.ModuleDeclaration);
-    expect(strapiNamespace.name.kind).toBe(ts.SyntaxKind.Identifier);
-    expect(strapiNamespace.name.escapedText).toBe('Strapi');
-
-    // "interface Schemas"
-    const [schemasInterface] = strapiNamespace.body.statements;
-
-    expect(schemasInterface.kind).toBe(ts.SyntaxKind.InterfaceDeclaration);
-    expect(schemasInterface.name.escapedText).toBe('Schemas');
-  };
-
-  describe('Generate Global Definition', () => {
-    beforeEach(() => {
-      jest.resetAllMocks();
-    });
-
-    test('With empty definition', () => {
-      const definitions = [];
-
-      const globalNode = generateGlobalDefinition(definitions);
-
-      assertGlobalNodeStructure(globalNode);
-
-      expect(getSchemaInterfaceName).not.toHaveBeenCalled();
-
-      const schemasNode = getSchemasInterfaceNode(globalNode);
-
-      expect(schemasNode.members).toHaveLength(0);
-    });
-
-    test('With no definition', () => {
-      const globalNode = generateGlobalDefinition();
-
-      assertGlobalNodeStructure(globalNode);
-
-      expect(getSchemaInterfaceName).not.toHaveBeenCalled();
-
-      const schemasNode = getSchemasInterfaceNode(globalNode);
-
-      expect(schemasNode.members).toHaveLength(0);
-    });
-
-    test('With multiple definitions', () => {
-      const definitions = [
-        { schema: { uid: 'api::foo.foo' } },
-        { schema: { uid: 'api::bar.bar' } },
-        { schema: { uid: 'api::foobar.foobar' } },
-        { schema: { uid: 'default.barfoo' } },
-      ];
-
-      getSchemaInterfaceName.mockReturnValue('Placeholder');
-
-      const globalNode = generateGlobalDefinition(definitions);
-
-      assertGlobalNodeStructure(globalNode);
-
-      const schemasNode = getSchemasInterfaceNode(globalNode);
-
-      expect(schemasNode.members).toHaveLength(definitions.length);
-
-      definitions.forEach(({ schema }, index) => {
-        const { uid } = schema;
-        const node = schemasNode.members[index];
-
-        expect(node.kind).toBe(ts.SyntaxKind.PropertySignature);
-
-        expect(getSchemaInterfaceName).toHaveBeenCalledWith(uid);
-
-        expect(node.name.kind).toBe(ts.SyntaxKind.StringLiteral);
-        expect(node.name.text).toBe(uid);
-        expect(node.name.singleQuote).toBeTruthy();
-
-        expect(node.type.kind).toBe(ts.SyntaxKind.TypeReference);
-        expect(node.type.typeName.escapedText).toBe('Placeholder');
-      });
-    });
-  });
-});

package/lib/compilers/watch.js

@@ -1,37 +0,0 @@
-'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/generators/schemas/global.js

@@ -1,67 +0,0 @@
-'use strict';
-
-/* eslint-disable no-bitwise */
-
-const ts = require('typescript');
-const { factory } = require('typescript');
-
-const { getSchemaInterfaceName } = require('./utils');
-
-/**
- *
- * @param {object} schemaDefinition
- * @param {ts.InterfaceDeclaration} schemaDefinition.definition
- * @param {object} schemaDefinition.schema
- */
-const schemaDefinitionToPropertySignature = ({ schema }) => {
-  const { uid } = schema;
-
-  const interfaceTypeName = getSchemaInterfaceName(uid);
-
-  return factory.createPropertySignature(
-    undefined,
-    factory.createStringLiteral(uid, true),
-    undefined,
-    factory.createTypeReferenceNode(factory.createIdentifier(interfaceTypeName))
-  );
-};
-
-/**
- * Generate the global module augmentation block
- *
- * @param {Array<{ schema: object; definition: ts.TypeNode }>} schemasDefinitions
- * @returns {ts.ModuleDeclaration}
- */
-const generateGlobalDefinition = (schemasDefinitions = []) => {
-  const properties = schemasDefinitions.map(schemaDefinitionToPropertySignature);
-
-  return factory.createModuleDeclaration(
-    [factory.createModifier(ts.SyntaxKind.DeclareKeyword)],
-    factory.createIdentifier('global'),
-    factory.createModuleBlock([
-      factory.createModuleDeclaration(
-        undefined,
-        factory.createIdentifier('Strapi'),
-        factory.createModuleBlock([
-          factory.createInterfaceDeclaration(
-            undefined,
-            factory.createIdentifier('Schemas'),
-            undefined,
-            undefined,
-            properties
-          ),
-        ]),
-        ts.NodeFlags.Namespace |
-          ts.NodeFlags.ExportContext |
-          ts.NodeFlags.Ambient |
-          ts.NodeFlags.ContextFlags
-      ),
-    ]),
-    ts.NodeFlags.ExportContext |
-      ts.NodeFlags.GlobalAugmentation |
-      ts.NodeFlags.Ambient |
-      ts.NodeFlags.ContextFlags
-  );
-};
-
-module.exports = { generateGlobalDefinition };