@strapi/typescript-utils 0.0.0-experimental.62ce06180fe9a772eaeb3d43d238b26644f39f7c → 0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282

package/.eslintrc.cjs

@@ -0,0 +1,16 @@
+// @ts-check
+
+/** @type {import('eslint').Linter.Config} */
+const config = {
+  root: true,
+  extends: ['eslint-config-custom/back'],
+  ignorePatterns: [
+    'node_modules/',
+    '.eslintrc.cjs',
+    'index.d.ts',
+    'coverage/',
+    'lint-staged.config.mjs',
+  ],
+};
+
+module.exports = config;

package/LICENSE

@@ -2,7 +2,21 @@ 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 that resides under an "ee/" directory (the “EE Software”), if that directory exists, is licensed under the license defined below.
+
+Enterprise License
+
+If you or the company you represent has entered into a written agreement referencing the Enterprise Edition of the Strapi source code available at
+https://github.com/strapi/strapi, then such agreement applies to your use of the Enterprise Edition of the Strapi Software. If you or the company you
+represent is using the Enterprise Edition of the Strapi Software in connection with a subscription to our cloud offering, then the agreement you have
+agreed to with respect to our cloud offering and the licenses included in such agreement apply to your use of the Enterprise Edition of the Strapi Software.
+Otherwise, the Strapi Enterprise Software License Agreement (found here https://strapi.io/enterprise-terms) applies to your use of the Enterprise Edition of the Strapi Software.
+
+BY ACCESSING OR USING THE ENTERPRISE EDITION OF THE STRAPI SOFTWARE, YOU ARE AGREEING TO BE BOUND BY THE RELEVANT REFERENCED AGREEMENT.
+IF YOU ARE NOT AUTHORIZED TO ACCEPT THESE TERMS ON BEHALF OF THE COMPANY YOU REPRESENT OR IF YOU DO NOT AGREE TO ALL OF THE RELEVANT TERMS AND CONDITIONS REFERENCED AND YOU
+HAVE NOT OTHERWISE EXECUTED A WRITTEN AGREEMENT WITH STRAPI, YOU ARE NOT AUTHORIZED TO ACCESS OR USE OR ALLOW ANY USER TO ACCESS OR USE ANY PART OF
+THE ENTERPRISE EDITION OF THE STRAPI SOFTWARE.  YOUR ACCESS RIGHTS ARE CONDITIONAL ON YOUR CONSENT TO THE RELEVANT REFERENCED TERMS TO THE EXCLUSION OF ALL OTHER TERMS;
+IF THE RELEVANT REFERENCED TERMS ARE CONSIDERED AN OFFER BY YOU, ACCEPTANCE IS EXPRESSLY LIMITED TO THE RELEVANT REFERENCED TERMS.
 
 * All software outside of the above-mentioned directories or restrictions above is available under the "MIT Expat" license as set forth below.
 
@@ -18,5 +32,6 @@ 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.
+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/__tests__/generators/schemas/attributes.test.js

@@ -680,18 +680,18 @@ describe('Attributes', () => {
           expect(definition.kind).toBe(ts.SyntaxKind.TypeLiteral);
           expect(definition.members).toHaveLength(2);
 
-          const [min, max] = definition.members;
-
-          expect(min.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
-          expect(min.name.escapedText).toBe('min');
-          expect(min.type.kind).toBe(ts.SyntaxKind.NumericLiteral);
-          expect(min.type.text).toBe('4');
+          const [max, min] = definition.members;
 
           expect(max.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
           expect(max.name.escapedText).toBe('max');
           expect(max.type.kind).toBe(ts.SyntaxKind.NumericLiteral);
           expect(max.type.text).toBe('12');
 
+          expect(min.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
+          expect(min.name.escapedText).toBe('min');
+          expect(min.type.kind).toBe(ts.SyntaxKind.NumericLiteral);
+          expect(min.type.text).toBe('4');
+
           // Check for number keyword on the second typeArgument
           expect(typeofMinMax.kind).toBe(ts.SyntaxKind.NumberKeyword);
         });
@@ -830,24 +830,19 @@ describe('Attributes', () => {
           expect(modifiers[0].typeArguments[0].kind).toBe(ts.SyntaxKind.TypeLiteral);
           expect(modifiers[0].typeArguments[0].members).toHaveLength(2);
 
-          // Min
-          expect(modifiers[0].typeArguments[0].members[0].kind).toBe(
-            ts.SyntaxKind.PropertyDeclaration
-          );
-          expect(modifiers[0].typeArguments[0].members[0].name.escapedText).toBe('minLength');
-          expect(modifiers[0].typeArguments[0].members[0].type.kind).toBe(
-            ts.SyntaxKind.NumericLiteral
-          );
-          expect(modifiers[0].typeArguments[0].members[0].type.text).toBe('4');
+          const [maxLength, minLength] = modifiers[0].typeArguments[0].members;
 
-          expect(modifiers[0].typeArguments[0].members[1].kind).toBe(
-            ts.SyntaxKind.PropertyDeclaration
-          );
-          expect(modifiers[0].typeArguments[0].members[1].name.escapedText).toBe('maxLength');
-          expect(modifiers[0].typeArguments[0].members[1].type.kind).toBe(
-            ts.SyntaxKind.NumericLiteral
-          );
-          expect(modifiers[0].typeArguments[0].members[1].type.text).toBe('12');
+          // Max
+          expect(maxLength.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
+          expect(maxLength.name.escapedText).toBe('maxLength');
+          expect(maxLength.type.kind).toBe(ts.SyntaxKind.NumericLiteral);
+          expect(maxLength.type.text).toBe('12');
+
+          // Min
+          expect(minLength.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
+          expect(minLength.name.escapedText).toBe('minLength');
+          expect(minLength.type.kind).toBe(ts.SyntaxKind.NumericLiteral);
+          expect(minLength.type.text).toBe('4');
         });
       });
 

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

@@ -168,10 +168,16 @@ describe('Utils', () => {
     });
 
     test('Number', () => {
-      const node = toTypeLiteral(42);
+      const nodePositive = toTypeLiteral(42);
+      const nodeNegative = toTypeLiteral(-42);
 
-      expect(node.kind).toBe(ts.SyntaxKind.FirstLiteralToken);
-      expect(node.text).toBe('42');
+      expect(nodePositive.kind).toBe(ts.SyntaxKind.FirstLiteralToken);
+      expect(nodePositive.text).toBe('42');
+
+      expect(nodeNegative.kind).toBe(ts.SyntaxKind.PrefixUnaryExpression);
+      expect(nodeNegative.operator).toBe(ts.SyntaxKind.MinusToken);
+      expect(nodeNegative.operand.kind).toBe(ts.SyntaxKind.FirstLiteralToken);
+      expect(nodeNegative.operand.text).toBe('42');
     });
 
     test('Boolean', () => {
@@ -247,13 +253,13 @@ describe('Utils', () => {
       expect(objectNode.members).toHaveLength(2);
 
       expect(objectNode.members[0].kind).toBe(ts.SyntaxKind.PropertyDeclaration);
-      expect(objectNode.members[0].name.escapedText).toBe('foo');
-      expect(objectNode.members[0].type.kind).toBe(ts.SyntaxKind.StringLiteral);
-      expect(objectNode.members[0].type.text).toBe('bar');
+      expect(objectNode.members[0].name.escapedText).toBe('bar');
+      expect(objectNode.members[0].type.kind).toBe(ts.SyntaxKind.TrueKeyword);
 
       expect(objectNode.members[1].kind).toBe(ts.SyntaxKind.PropertyDeclaration);
-      expect(objectNode.members[1].name.escapedText).toBe('bar');
-      expect(objectNode.members[1].type.kind).toBe(ts.SyntaxKind.TrueKeyword);
+      expect(objectNode.members[1].name.escapedText).toBe('foo');
+      expect(objectNode.members[1].type.kind).toBe(ts.SyntaxKind.StringLiteral);
+      expect(objectNode.members[1].type.text).toBe('bar');
     });
 
     test('Object', () => {
@@ -262,20 +268,20 @@ describe('Utils', () => {
       expect(node.kind).toBe(ts.SyntaxKind.TypeLiteral);
       expect(node.members).toHaveLength(2);
 
-      const [firstMember, secondMember] = node.members;
+      const [barMember, fooMember] = node.members;
 
-      expect(firstMember.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
-      expect(firstMember.name.escapedText).toBe('foo');
-      expect(firstMember.type.kind).toBe(ts.SyntaxKind.TupleType);
-      expect(firstMember.type.elements).toHaveLength(3);
-      expect(firstMember.type.elements[0].kind).toBe(ts.SyntaxKind.StringLiteral);
-      expect(firstMember.type.elements[1].kind).toBe(ts.SyntaxKind.TrueKeyword);
-      expect(firstMember.type.elements[2].kind).toBe(ts.SyntaxKind.FirstLiteralToken);
+      expect(barMember.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
+      expect(barMember.name.escapedText).toBe('bar');
+      expect(barMember.type.kind).toBe(ts.SyntaxKind.LiteralType);
+      expect(barMember.type.literal).toBe(ts.SyntaxKind.NullKeyword);
 
-      expect(secondMember.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
-      expect(secondMember.name.escapedText).toBe('bar');
-      expect(secondMember.type.kind).toBe(ts.SyntaxKind.LiteralType);
-      expect(secondMember.type.literal).toBe(ts.SyntaxKind.NullKeyword);
+      expect(fooMember.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
+      expect(fooMember.name.escapedText).toBe('foo');
+      expect(fooMember.type.kind).toBe(ts.SyntaxKind.TupleType);
+      expect(fooMember.type.elements).toHaveLength(3);
+      expect(fooMember.type.elements[0].kind).toBe(ts.SyntaxKind.StringLiteral);
+      expect(fooMember.type.elements[1].kind).toBe(ts.SyntaxKind.TrueKeyword);
+      expect(fooMember.type.elements[2].kind).toBe(ts.SyntaxKind.FirstLiteralToken);
     });
 
     test('Object with complex keys', () => {
@@ -284,19 +290,19 @@ describe('Utils', () => {
       expect(node.kind).toBe(ts.SyntaxKind.TypeLiteral);
       expect(node.members).toHaveLength(2);
 
-      const [firstMember, secondMember] = node.members;
+      const [fooBar, fooDashBar] = node.members;
 
-      expect(firstMember.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
-      expect(firstMember.name.kind).toBe(ts.SyntaxKind.StringLiteral);
-      expect(firstMember.name.text).toBe('foo-bar');
-      expect(firstMember.type.kind).toBe(ts.SyntaxKind.StringLiteral);
-      expect(firstMember.type.text).toBe('foobar');
+      expect(fooBar.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
+      expect(fooBar.name.kind).toBe(ts.SyntaxKind.Identifier);
+      expect(fooBar.name.escapedText).toBe('foo');
+      expect(fooBar.type.kind).toBe(ts.SyntaxKind.StringLiteral);
+      expect(fooBar.type.text).toBe('bar');
 
-      expect(secondMember.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
-      expect(secondMember.name.kind).toBe(ts.SyntaxKind.Identifier);
-      expect(secondMember.name.escapedText).toBe('foo');
-      expect(secondMember.type.kind).toBe(ts.SyntaxKind.StringLiteral);
-      expect(secondMember.type.text).toBe('bar');
+      expect(fooDashBar.kind).toBe(ts.SyntaxKind.PropertyDeclaration);
+      expect(fooDashBar.name.kind).toBe(ts.SyntaxKind.StringLiteral);
+      expect(fooDashBar.name.text).toBe('foo-bar');
+      expect(fooDashBar.type.kind).toBe(ts.SyntaxKind.StringLiteral);
+      expect(fooDashBar.type.text).toBe('foobar');
     });
 
     test('Invalid data type supplied (function)', () => {

package/lib/compilers/basic.js

@@ -44,7 +44,7 @@ module.exports = {
 
     // If the compilation failed and diagnostics are not ignored, exit early
     if (!ignoreDiagnostics && emitResults.emitSkipped) {
-      process.exit(1);
+      throw new Error('TypeScript compilation failed');
     }
   },
 };

package/lib/generators/common/imports.js

@@ -18,9 +18,9 @@ module.exports = {
   },
 
   generateImportDefinition() {
-    const formattedImports = imports.map((key) =>
-      factory.createImportSpecifier(false, undefined, factory.createIdentifier(key))
-    );
+    const formattedImports = imports
+      .sort()
+      .map((key) => factory.createImportSpecifier(false, undefined, factory.createIdentifier(key)));
 
     return [
       factory.createImportDeclaration(

package/lib/generators/common/models/schema.js

@@ -22,9 +22,11 @@ const { addImport } = require('../imports');
 const generateAttributePropertySignature = (schema) => {
   const { attributes } = schema;
 
-  const properties = Object.entries(attributes).map(([attributeName, attribute]) => {
-    return attributeToPropertySignature(schema, attributeName, attribute);
-  });
+  const properties = Object.entries(attributes)
+    .sort((a, b) => a[0].localeCompare(b[0]))
+    .map(([attributeName, attribute]) => {
+      return attributeToPropertySignature(schema, attributeName, attribute);
+    });
 
   return factory.createPropertySignature(
     undefined,

package/lib/generators/common/models/utils.js

@@ -92,7 +92,12 @@ const toTypeLiteral = (data) => {
   }
 
   if (isNumber(data)) {
-    return factory.createNumericLiteral(data);
+    return data < 0
+      ? factory.createPrefixUnaryExpression(
+          ts.SyntaxKind.MinusToken,
+          factory.createNumericLiteral(-data)
+        )
+      : factory.createNumericLiteral(data);
   }
 
   if (isBoolean(data)) {
@@ -111,7 +116,7 @@ const toTypeLiteral = (data) => {
     throw new Error(`Cannot convert to object literal. Unknown type "${typeof data}"`);
   }
 
-  const entries = Object.entries(data);
+  const entries = Object.entries(data).sort((a, b) => a[0].localeCompare(b[0]));
 
   const props = entries.reduce((acc, [key, value]) => {
     // Handle keys such as content-type-builder & co.

package/lib/generators/components/index.js

@@ -1,10 +1,16 @@
 'use strict';
 
 const { factory } = require('typescript');
+const { pipe, values, sortBy, map } = require('lodash/fp');
 
 const { models } = require('../common');
 const { emitDefinitions, format, generateSharedExtensionDefinition } = require('../utils');
 
+const NO_COMPONENT_PLACEHOLDER_COMMENT = `/*
+ * The app doesn't have any components yet.
+ */
+`;
+
 /**
  * Generate type definitions for Strapi Components
  *
@@ -18,10 +24,20 @@ const generateComponentsDefinitions = async (options = {}) => {
 
   const { components } = strapi;
 
-  const componentsDefinitions = Object.values(components).map((contentType) => ({
-    uid: contentType.uid,
-    definition: models.schema.generateSchemaDefinition(contentType),
-  }));
+  const componentsDefinitions = pipe(
+    values,
+    sortBy('uid'),
+    map((component) => ({
+      uid: component.uid,
+      definition: models.schema.generateSchemaDefinition(component),
+    }))
+  )(components);
+
+  options.logger.debug(`Found ${componentsDefinitions.length} components.`);
+
+  if (componentsDefinitions.length === 0) {
+    return { output: NO_COMPONENT_PLACEHOLDER_COMMENT, stats: {} };
+  }
 
   const formattedSchemasDefinitions = componentsDefinitions.reduce((acc, def) => {
     acc.push(

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

@@ -1,10 +1,16 @@
 '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
  *
@@ -18,10 +24,20 @@ const generateContentTypesDefinitions = async (options = {}) => {
 
   const { contentTypes } = strapi;
 
-  const contentTypesDefinitions = Object.values(contentTypes).map((contentType) => ({
-    uid: contentType.uid,
-    definition: models.schema.generateSchemaDefinition(contentType),
-  }));
+  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(

package/lib/utils/index.js

@@ -7,6 +7,7 @@ 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,
@@ -16,4 +17,5 @@ module.exports = {
   resolveConfigOptions,
   formatHost,
   resolveOutDir,
+  resolveOutDirSync,
 };

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

@@ -1,3 +1,5 @@
+// @ts-check
+
 'use strict';
 
 const fse = require('fs-extra');
@@ -13,5 +15,5 @@ const getConfigPath = require('./get-config-path');
 module.exports = (dir, filename = undefined) => {
   const filePath = getConfigPath(dir, { filename });
 
-  return fse.pathExistsSync(filePath);
+  return filePath ? fse.pathExistsSync(filePath) : false;
 };

package/lib/utils/resolve-outdir-sync.js

@@ -0,0 +1,18 @@
+'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/lint-staged.config.mjs

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

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "@strapi/typescript-utils",
-  "version": "0.0.0-experimental.62ce06180fe9a772eaeb3d43d238b26644f39f7c",
+  "version": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
   "description": "Typescript support for Strapi",
   "keywords": [
     "strapi",
     "generators"
   ],
+  "homepage": "https://strapi.io",
+  "bugs": {
+    "url": "https://github.com/strapi/strapi/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "git://github.com/strapi/strapi.git",
+    "url": "https://github.com/strapi/strapi.git",
     "directory": "packages/utils/typescript"
   },
   "license": "SEE LICENSE IN LICENSE",
@@ -36,18 +40,17 @@
   },
   "dependencies": {
     "chalk": "4.1.2",
-    "cli-table3": "0.6.2",
-    "fs-extra": "11.2.0",
-    "lodash": "4.17.21",
-    "prettier": "3.2.5",
-    "typescript": "5.3.2"
+    "cli-table3": "0.6.5",
+    "fs-extra": "11.3.4",
+    "lodash": "4.18.1",
+    "prettier": "3.3.3",
+    "typescript": "5.9.3"
   },
   "devDependencies": {
     "@types/fs-extra": "11.0.4"
   },
   "engines": {
-    "node": ">=18.0.0 <=20.x.x",
+    "node": ">=20.19.0 <=26.x.x",
     "npm": ">=6.0.0"
-  },
-  "gitHead": "62ce06180fe9a772eaeb3d43d238b26644f39f7c"
+  }
 }

package/tsconfigs/admin.json

@@ -0,0 +1,19 @@
+{
+  "$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/.eslintignore

@@ -1,3 +0,0 @@
-node_modules/
-.eslintrc.js
-index.d.ts

package/.eslintrc.js

@@ -1,4 +0,0 @@
-module.exports = {
-  root: true,
-  extends: ['custom/back'],
-};