@strapi/typescript-utils 0.0.0-next.f45143c5e2a8a9d85691d0abf79a3f42024a0c71 → 0.0.0-next.f7babb775ed9a7e18d8351cb7f74c63e016323c4

package/lib/generators/utils.js

@@ -0,0 +1,211 @@
+'use strict';
+
+const ts = require('typescript');
+const prettier = require('prettier');
+const fse = require('fs-extra');
+const path = require('path');
+const chalk = require('chalk');
+const assert = require('assert');
+
+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/strapi', 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,6 +1,6 @@
 {
   "name": "@strapi/typescript-utils",
-  "version": "0.0.0-next.f45143c5e2a8a9d85691d0abf79a3f42024a0c71",
+  "version": "0.0.0-next.f7babb775ed9a7e18d8351cb7f74c63e016323c4",
   "description": "Typescript support for Strapi",
   "keywords": [
     "strapi",
@@ -20,6 +20,7 @@
     }
   ],
   "main": "./lib/index.js",
+  "types": "index.d.ts",
   "directories": {
     "lib": "./lib"
   },
@@ -31,14 +32,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": "4.6.2"
+    "typescript": "5.1.3"
   },
   "engines": {
-    "node": ">=14.19.1 <=18.x.x",
+    "node": ">=16.0.0 <=20.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "f45143c5e2a8a9d85691d0abf79a3f42024a0c71"
+  "gitHead": "f7babb775ed9a7e18d8351cb7f74c63e016323c4"
 }

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/generators/schemas/global.js

@@ -1,70 +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(
-    undefined,
-    [factory.createModifier(ts.SyntaxKind.DeclareKeyword)],
-    factory.createIdentifier('global'),
-    factory.createModuleBlock([
-      factory.createModuleDeclaration(
-        undefined,
-        undefined,
-        factory.createIdentifier('Strapi'),
-        factory.createModuleBlock([
-          factory.createInterfaceDeclaration(
-            undefined,
-            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 };

package/lib/generators/schemas/index.js

@@ -1,185 +0,0 @@
-'use strict';
-
-const path = require('path');
-
-const ts = require('typescript');
-const { factory } = require('typescript');
-
-const fp = require('lodash/fp');
-const fse = require('fs-extra');
-const prettier = require('prettier');
-const chalk = require('chalk');
-const CLITable = require('cli-table3');
-
-const { generateImportDefinition } = require('./imports');
-const { generateSchemaDefinition } = require('./schema');
-const { generateGlobalDefinition } = require('./global');
-const {
-  getAllStrapiSchemas,
-  getSchemaInterfaceName,
-  getSchemaModelType,
-  getDefinitionAttributesCount,
-} = require('./utils');
-
-const DEFAULT_OUT_FILENAME = 'schemas.d.ts';
-
-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({ newLine: true, omitTrailingSemicolon: true });
-
-  return printer.printList(ts.ListFormat.MultiLine, nodeArray, sourceFile);
-};
-
-const saveDefinitionToFileSystem = async (dir, file, content) => {
-  const filepath = path.join(dir, file);
-
-  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);
-};
-
-const logDebugInformation = (definitions, options = {}) => {
-  const { filepath, verbose, silent } = options;
-
-  if (verbose) {
-    const table = new CLITable({
-      head: [
-        chalk.bold(chalk.green('Model Type')),
-        chalk.bold(chalk.blue('UID')),
-        chalk.bold(chalk.blue('Type')),
-        chalk.bold(chalk.gray('Attributes Count')),
-      ],
-      colAligns: ['center', 'left', 'left', 'center'],
-    });
-
-    const sortedDefinitions = definitions.map((def) => ({
-      ...def,
-      attributesCount: getDefinitionAttributesCount(def.definition),
-    }));
-
-    for (const { schema, attributesCount } of sortedDefinitions) {
-      const modelType = fp.upperFirst(getSchemaModelType(schema));
-      const interfaceType = getSchemaInterfaceName(schema.uid);
-
-      table.push([
-        chalk.greenBright(modelType),
-        chalk.blue(schema.uid),
-        chalk.blue(interfaceType),
-        chalk.grey(fp.isNil(attributesCount) ? 'N/A' : attributesCount),
-      ]);
-    }
-
-    // Table
-    console.log(table.toString());
-  }
-
-  if (!silent) {
-    // Metrics
-    console.log(
-      chalk.greenBright(
-        `Generated ${definitions.length} type definition for your Strapi application's schemas.`
-      )
-    );
-
-    // Filepath
-    const relativePath = path.relative(process.cwd(), filepath);
-
-    console.log(
-      chalk.grey(`The definitions file has been generated here: ${chalk.bold(relativePath)}`)
-    );
-  }
-};
-
-/**
- * Generate type definitions for Strapi schemas
- *
- * @param {object} options
- * @param {Strapi} options.strapi
- * @param {{ distDir: string; appDir: string; }} options.dirs
- * @param {string} [options.outDir]
- * @param {string} [options.file]
- * @param {boolean} [options.verbose]
- */
-const generateSchemasDefinitions = async (options = {}) => {
-  const {
-    strapi,
-    outDir = process.cwd(),
-    file = DEFAULT_OUT_FILENAME,
-    verbose = false,
-    silent = false,
-  } = options;
-
-  const schemas = getAllStrapiSchemas(strapi);
-
-  const schemasDefinitions = Object.values(schemas).map((schema) => ({
-    schema,
-    definition: generateSchemaDefinition(schema),
-  }));
-
-  const formattedSchemasDefinitions = schemasDefinitions.reduce((acc, def) => {
-    acc.push(
-      // Definition
-      def.definition,
-
-      // Add a newline between each interface declaration
-      factory.createIdentifier('\n')
-    );
-
-    return acc;
-  }, []);
-
-  const allDefinitions = [
-    // Imports
-    generateImportDefinition(),
-
-    // Add a newline after the import statement
-    factory.createIdentifier('\n'),
-
-    // Schemas
-    ...formattedSchemasDefinitions,
-
-    // Global
-    generateGlobalDefinition(schemasDefinitions),
-  ];
-
-  const output = emitDefinitions(allDefinitions);
-  const formattedOutput = await format(output);
-
-  const definitionFilepath = await saveDefinitionToFileSystem(outDir, file, formattedOutput);
-
-  logDebugInformation(schemasDefinitions, { filepath: definitionFilepath, verbose, silent });
-};
-
-module.exports = generateSchemasDefinitions;