@strapi2front/generators 0.3.2 → 0.4.0

package/dist/index.d.ts

@@ -136,6 +136,11 @@ interface ByFeatureGeneratorOptions {
      * @default 'typescript'
      */
     outputFormat?: "typescript" | "jsdoc";
+    /**
+     * Module type for JSDoc output: 'esm' for ES Modules, 'commonjs' for CommonJS
+     * @default 'commonjs'
+     */
+    moduleType?: "esm" | "commonjs";
 }
 /**
  * Generate all files using 'by-feature' structure

package/dist/index.js

@@ -2135,9 +2135,11 @@ async function generateByFeature(schema, locales, options) {
     blocksRendererInstalled = false,
     strapiVersion = "v5",
     apiPrefix = "/api",
-    outputFormat = "typescript"
+    outputFormat = "typescript",
+    moduleType = "commonjs"
   } = options;
   const generatedFiles = [];
+  const useESM = outputFormat === "jsdoc" && moduleType === "esm";
   const ext = outputFormat === "jsdoc" ? "js" : "ts";
   await ensureDir(path9.join(outputDir, "collections"));
   await ensureDir(path9.join(outputDir, "singles"));
@@ -2145,15 +2147,15 @@ async function generateByFeature(schema, locales, options) {
   await ensureDir(path9.join(outputDir, "shared"));
   const sharedDir = path9.join(outputDir, "shared");
   const utilsPath = path9.join(sharedDir, `utils.${ext}`);
-  const utilsContent = outputFormat === "jsdoc" ? generateUtilityTypesJSDoc(blocksRendererInstalled, strapiVersion) : generateUtilityTypes3(blocksRendererInstalled, strapiVersion);
+  const utilsContent = outputFormat === "jsdoc" ? generateUtilityTypesJSDoc(blocksRendererInstalled, strapiVersion, useESM) : generateUtilityTypes3(blocksRendererInstalled, strapiVersion);
   await writeFile(utilsPath, await formatCode(utilsContent));
   generatedFiles.push(utilsPath);
   const clientPath = path9.join(sharedDir, `client.${ext}`);
-  const clientContent = outputFormat === "jsdoc" ? generateClientJSDoc(strapiVersion, apiPrefix) : generateClient2(strapiVersion, apiPrefix);
+  const clientContent = outputFormat === "jsdoc" ? generateClientJSDoc(strapiVersion, apiPrefix, useESM) : generateClient2(strapiVersion, apiPrefix);
   await writeFile(clientPath, await formatCode(clientContent));
   generatedFiles.push(clientPath);
   const localesPath = path9.join(sharedDir, `locales.${ext}`);
-  const localesContent = outputFormat === "jsdoc" ? generateLocalesFileJSDoc(locales) : generateLocalesFile2(locales);
+  const localesContent = outputFormat === "jsdoc" ? generateLocalesFileJSDoc(locales, useESM) : generateLocalesFile2(locales);
   await writeFile(localesPath, await formatCode(localesContent));
   generatedFiles.push(localesPath);
   for (const collection of schema.collections) {
@@ -2161,13 +2163,13 @@ async function generateByFeature(schema, locales, options) {
     await ensureDir(featureDir);
     if (features.types) {
       const typesPath = path9.join(featureDir, `types.${ext}`);
-      const content = outputFormat === "jsdoc" ? generateCollectionTypesJSDoc(collection, schema) : generateCollectionTypes(collection, schema);
+      const content = outputFormat === "jsdoc" ? generateCollectionTypesJSDoc(collection, schema, useESM) : generateCollectionTypes(collection, schema);
       await writeFile(typesPath, await formatCode(content));
       generatedFiles.push(typesPath);
     }
     if (features.services) {
       const servicePath = path9.join(featureDir, `service.${ext}`);
-      const content = outputFormat === "jsdoc" ? generateCollectionServiceJSDoc(collection, strapiVersion) : generateCollectionService3(collection, strapiVersion);
+      const content = outputFormat === "jsdoc" ? generateCollectionServiceJSDoc(collection, strapiVersion, useESM) : generateCollectionService3(collection, strapiVersion);
       await writeFile(servicePath, await formatCode(content));
       generatedFiles.push(servicePath);
     }
@@ -2182,20 +2184,20 @@ async function generateByFeature(schema, locales, options) {
     await ensureDir(featureDir);
     if (features.types) {
       const typesPath = path9.join(featureDir, `types.${ext}`);
-      const content = outputFormat === "jsdoc" ? generateSingleTypesJSDoc(single, schema) : generateSingleTypes(single, schema);
+      const content = outputFormat === "jsdoc" ? generateSingleTypesJSDoc(single, schema, useESM) : generateSingleTypes(single, schema);
       await writeFile(typesPath, await formatCode(content));
       generatedFiles.push(typesPath);
     }
     if (features.services) {
       const servicePath = path9.join(featureDir, `service.${ext}`);
-      const content = outputFormat === "jsdoc" ? generateSingleServiceJSDoc(single, strapiVersion) : generateSingleService3(single, strapiVersion);
+      const content = outputFormat === "jsdoc" ? generateSingleServiceJSDoc(single, strapiVersion, useESM) : generateSingleService3(single, strapiVersion);
       await writeFile(servicePath, await formatCode(content));
       generatedFiles.push(servicePath);
     }
   }
   for (const component of schema.components) {
     const componentPath = path9.join(outputDir, "components", `${toKebabCase(component.name)}.${ext}`);
-    const content = outputFormat === "jsdoc" ? generateComponentTypesJSDoc(component, schema) : generateComponentTypes(component, schema);
+    const content = outputFormat === "jsdoc" ? generateComponentTypesJSDoc(component, schema, useESM) : generateComponentTypes(component, schema);
     await writeFile(componentPath, await formatCode(content));
     generatedFiles.push(componentPath);
   }
@@ -3166,7 +3168,7 @@ export const ${actionPrefix}Actions = {
 };
 `;
 }
-function generateUtilityTypesJSDoc(blocksRendererInstalled, strapiVersion) {
+function generateUtilityTypesJSDoc(blocksRendererInstalled, strapiVersion, useESM = false) {
   const isV4 = strapiVersion === "v4";
   const blocksContentType = isV4 ? `/**
  * Rich text content (Strapi v4)
@@ -3290,7 +3292,7 @@ function flattenV4ListResponse(items) {
   return items.map(item => flattenV4Response(item));
 }
 
-module.exports = { flattenV4Response, flattenV4ListResponse };` : "";
+${useESM ? "export { flattenV4Response, flattenV4ListResponse };" : "module.exports = { flattenV4Response, flattenV4ListResponse };"}` : "";
   return `// @ts-check
 /**
  * Strapi utility types
@@ -3340,12 +3342,13 @@ ${baseEntity}
 ${v4RawResponseTypes}
 ${blocksContentType}
 
-module.exports = {};
+${useESM ? "export {};" : "module.exports = {};"}
 `;
 }
-function generateClientJSDoc(strapiVersion, apiPrefix = "/api") {
+function generateClientJSDoc(strapiVersion, apiPrefix = "/api", useESM = false) {
   const isV4 = strapiVersion === "v4";
   const normalizedPrefix = apiPrefix.startsWith("/") ? apiPrefix : "/" + apiPrefix;
+  const importStatement = useESM ? `import Strapi from 'strapi-sdk-js';` : `const Strapi = require('strapi-sdk-js').default;`;
   if (isV4) {
     return `// @ts-check
 /**
@@ -3353,7 +3356,7 @@ function generateClientJSDoc(strapiVersion, apiPrefix = "/api") {
  * Generated by strapi2front
  */
 
-const Strapi = require('strapi-sdk-js').default;
+${importStatement}
 
 // Initialize the Strapi client
 const strapiUrl = process.env.STRAPI_URL || 'http://localhost:1337';
@@ -3553,7 +3556,7 @@ function single(singularName) {
   };
 }
 
-module.exports = { strapi, collection, single };
+${useESM ? "export { strapi, collection, single };" : "module.exports = { strapi, collection, single };"}
 `;
   }
   return `// @ts-check
@@ -3562,7 +3565,7 @@ module.exports = { strapi, collection, single };
  * Generated by strapi2front
  */
 
-const Strapi = require('strapi-sdk-js').default;
+${importStatement}
 
 // Initialize the Strapi client
 const strapiUrl = process.env.STRAPI_URL || 'http://localhost:1337';
@@ -3705,10 +3708,10 @@ function single(singularName) {
   };
 }
 
-module.exports = { strapi, collection, single };
+${useESM ? "export { strapi, collection, single };" : "module.exports = { strapi, collection, single };"}
 `;
 }
-function generateLocalesFileJSDoc(locales) {
+function generateLocalesFileJSDoc(locales, useESM = false) {
   if (locales.length === 0) {
     return `// @ts-check
 /**
@@ -3744,7 +3747,7 @@ function getLocaleName(code) {
   return code;
 }
 
-module.exports = { locales, defaultLocale, localeNames, isValidLocale, getLocaleName };
+${useESM ? "export { locales, defaultLocale, localeNames, isValidLocale, getLocaleName };" : "module.exports = { locales, defaultLocale, localeNames, isValidLocale, getLocaleName };"}
 `;
   }
   const localeCodes = locales.map((l) => l.code);
@@ -3786,10 +3789,10 @@ function getLocaleName(code) {
   return localeNames[code] || code;
 }
 
-module.exports = { locales, defaultLocale, localeNames, isValidLocale, getLocaleName };
+${useESM ? "export { locales, defaultLocale, localeNames, isValidLocale, getLocaleName };" : "module.exports = { locales, defaultLocale, localeNames, isValidLocale, getLocaleName };"}
 `;
 }
-function generateCollectionTypesJSDoc(collection, schema) {
+function generateCollectionTypesJSDoc(collection, schema, useESM = false) {
   const typeName = toPascalCase(collection.singularName);
   const attributes = generateJSDocAttributes(collection.attributes, schema, "collection");
   return `// @ts-check
@@ -3820,10 +3823,10 @@ ${attributes}
  * @property {${typeName}Filters} [$not]
  */
 
-module.exports = {};
+${useESM ? "export {};" : "module.exports = {};"}
 `;
 }
-function generateSingleTypesJSDoc(single, schema) {
+function generateSingleTypesJSDoc(single, schema, useESM = false) {
   const typeName = toPascalCase(single.singularName);
   const attributes = generateJSDocAttributes(single.attributes, schema, "single");
   return `// @ts-check
@@ -3842,10 +3845,10 @@ function generateSingleTypesJSDoc(single, schema) {
 ${attributes}
  */
 
-module.exports = {};
+${useESM ? "export {};" : "module.exports = {};"}
 `;
 }
-function generateComponentTypesJSDoc(component, schema) {
+function generateComponentTypesJSDoc(component, schema, useESM = false) {
   const typeName = toPascalCase(component.name);
   const attributes = generateJSDocAttributes(component.attributes, schema, "component");
   return `// @ts-check
@@ -3862,7 +3865,7 @@ function generateComponentTypesJSDoc(component, schema) {
 ${attributes}
  */
 
-module.exports = {};
+${useESM ? "export {};" : "module.exports = {};"}
 `;
 }
 function generateJSDocAttributes(attributes, schema, context) {
@@ -3960,7 +3963,7 @@ function attributeToJSDocType(attr, schema, relativePrefix) {
       return "Object";
   }
 }
-function generateCollectionServiceJSDoc(collection, strapiVersion) {
+function generateCollectionServiceJSDoc(collection, strapiVersion, useESM = false) {
   const typeName = toPascalCase(collection.singularName);
   const serviceName = toCamelCase(collection.singularName) + "Service";
   const endpoint = collection.pluralName;
@@ -3969,6 +3972,7 @@ function generateCollectionServiceJSDoc(collection, strapiVersion) {
   const isV4 = strapiVersion === "v4";
   const idParam = isV4 ? "id" : "documentId";
   const idType = isV4 ? "number" : "string";
+  const importStatement = useESM ? `import { collection } from '../../shared/client.js';` : `const { collection } = require('../../shared/client');`;
   return `// @ts-check
 /**
  * ${collection.displayName} Service
@@ -3977,7 +3981,7 @@ function generateCollectionServiceJSDoc(collection, strapiVersion) {
  * Strapi version: ${strapiVersion}
  */
 
-const { collection } = require('../../shared/client');
+${importStatement}
 
 /**
  * @typedef {Object} FindManyOptions
@@ -4118,14 +4122,15 @@ ${hasSlug ? `
   },
 };
 
-module.exports = { ${serviceName} };
+${useESM ? `export { ${serviceName} };` : `module.exports = { ${serviceName} };`}
 `;
 }
-function generateSingleServiceJSDoc(single, strapiVersion) {
+function generateSingleServiceJSDoc(single, strapiVersion, useESM = false) {
   const typeName = toPascalCase(single.singularName);
   const serviceName = toCamelCase(single.singularName) + "Service";
   const endpoint = single.singularName;
   const { localized, draftAndPublish } = single;
+  const importStatement = useESM ? `import { single } from '../../shared/client.js';` : `const { single } = require('../../shared/client');`;
   return `// @ts-check
 /**
  * ${single.displayName} Service (Single Type)
@@ -4134,7 +4139,7 @@ function generateSingleServiceJSDoc(single, strapiVersion) {
  * Strapi version: ${strapiVersion}
  */
 
-const { single } = require('../../shared/client');
+${importStatement}
 
 /**
  * @typedef {Object} FindOptions
@@ -4181,7 +4186,7 @@ const ${serviceName} = {
   },
 };
 
-module.exports = { ${serviceName} };
+${useESM ? `export { ${serviceName} };` : `module.exports = { ${serviceName} };`}
 `;
 }