massimo-cli 0.4.0 → 0.5.0

package/help/help.txt

@@ -55,7 +55,7 @@ You can generate only the types with the --types-only flag.
 $ massimo http://exmaple.com/to/schema/file --name myclient --types-only
 ```
 
-Will create the single myclient.d.ts file.
+Will create the single myclient.d.ts file (or .d.mts/.d.cts depending on module format and --type-extension option).
 
 Options:
 
@@ -77,3 +77,4 @@ Options:
 * `--props-optional` - If `true`, properties will be defined as optional unless they're part of the `required` array. By default this option is `true`.
 * `--skip-config-update` - If `true`, it will not update the `platformatic|watt` config found in your repo. By default this option is `true`.
 * `--retry-timeout-ms` - If passed, the HTTP request to get an Open API schema will be retried (reference: https://undici.nodejs.org/#/docs/api/RetryHandler.md)
+* `--type-extension` - Force the use of module-specific type extensions (.d.mts for ESM, .d.cts for CJS) instead of the default logic.

package/index.js

@@ -59,19 +59,55 @@ export async function detectModuleFormat (folder, explicitFormat) {
       try {
         const packageJson = JSON.parse(await readFile(packageJsonPath, 'utf8'))
         if (packageJson.type === 'module') return 'esm'
-        // If no type field or any other value, it's CommonJS per Node.js defaults
         return 'cjs'
       } catch (err) {
-        // If we can't parse it, continue searching
       }
     }
     currentDir = dirname(currentDir)
   }
 
-  // Default to ESM
   return 'esm'
 }
 
+export async function determineTypeExtension (folder, moduleFormat, typeExtension, explicitModuleFormat, generateImplementation = true) {
+  if (typeExtension) {
+    return moduleFormat === 'esm' ? 'd.mts' : 'd.cts'
+  }
+
+  if (!explicitModuleFormat && !generateImplementation) {
+    return 'd.ts'
+  }
+
+  if (!explicitModuleFormat && generateImplementation) {
+    return 'd.ts'
+  }
+
+  let currentDir = folder
+  while (currentDir !== dirname(currentDir)) {
+    const packageJsonPath = join(currentDir, 'package.json')
+    if (await isFileAccessible(packageJsonPath)) {
+      try {
+        const packageJson = JSON.parse(await readFile(packageJsonPath, 'utf8'))
+        const parentType = packageJson.type === 'module' ? 'esm' : 'cjs'
+
+        if (moduleFormat === parentType) {
+          return 'd.ts'
+        }
+
+        return moduleFormat === 'esm' ? 'd.mts' : 'd.cts'
+      } catch (err) {
+      }
+    }
+    currentDir = dirname(currentDir)
+  }
+
+  if (explicitModuleFormat) {
+    return moduleFormat === 'esm' ? 'd.mts' : 'd.cts'
+  }
+
+  return 'd.ts'
+}
+
 async function writeOpenAPIClient (
   folder,
   name,
@@ -88,7 +124,9 @@ async function writeOpenAPIClient (
   logger,
   withCredentials,
   propsOptional,
-  moduleFormat
+  moduleFormat,
+  typeExtension,
+  explicitModuleFormat
 ) {
   await createDirectory(folder)
 
@@ -107,6 +145,7 @@ async function writeOpenAPIClient (
   }
 
   if (isFrontend) {
+    const typeExt = await determineTypeExtension(folder, moduleFormat, typeExtension, explicitModuleFormat, generateImplementation)
     const { types, implementation } = processFrontendOpenAPI({
       schema,
       name,
@@ -116,8 +155,9 @@ async function writeOpenAPIClient (
       logger,
       withCredentials,
       propsOptional,
+      typeExt
     })
-    await writeFile(join(folder, `${name}-types.d.mts`), types)
+    await writeFile(join(folder, `${name}-types.${typeExt}`), types)
     if (generateImplementation) {
       const extension = language === 'js' ? 'mjs' : 'mts'
       await writeFile(join(folder, `${name}.${extension}`), implementation)
@@ -134,7 +174,7 @@ async function writeOpenAPIClient (
       propsOptional,
       moduleFormat,
     })
-    const typeExt = moduleFormat === 'esm' ? 'd.mts' : 'd.cts'
+    const typeExt = await determineTypeExtension(folder, moduleFormat, typeExtension, explicitModuleFormat, generateImplementation)
     const implExt = moduleFormat === 'esm' ? 'mjs' : 'cjs'
     await writeFile(join(folder, `${name}.${typeExt}`), types)
     if (generateImplementation) {
@@ -144,7 +184,7 @@ async function writeOpenAPIClient (
     if (!typesOnly) {
       await writeFile(
         join(folder, 'package.json'),
-        getPackageJSON({ name, generateImplementation, moduleFormat })
+        await getPackageJSON({ name, generateImplementation, moduleFormat, folder, typeExtension, explicitModuleFormat })
       )
     }
   }
@@ -156,7 +196,9 @@ async function writeGraphQLClient (
   schema,
   url,
   generateImplementation,
-  moduleFormat
+  moduleFormat,
+  typeExtension,
+  explicitModuleFormat
 ) {
   await createDirectory(folder, { recursive: true })
   const { types, implementation } = processGraphQL({
@@ -168,7 +210,7 @@ async function writeGraphQLClient (
   })
   const clientSchema = graphql.buildClientSchema(schema)
   const sdl = graphql.printSchema(clientSchema)
-  const typeExt = moduleFormat === 'esm' ? 'd.mts' : 'd.cts'
+  const typeExt = await determineTypeExtension(folder, moduleFormat, typeExtension, explicitModuleFormat, generateImplementation)
   const implExt = moduleFormat === 'esm' ? 'mjs' : 'cjs'
   await writeFile(join(folder, `${name}.schema.graphql`), sdl)
   await writeFile(join(folder, `${name}.${typeExt}`), types)
@@ -177,7 +219,7 @@ async function writeGraphQLClient (
   }
   await writeFile(
     join(folder, 'package.json'),
-    getPackageJSON({ name, generateImplementation, moduleFormat })
+    await getPackageJSON({ name, generateImplementation, moduleFormat, folder, typeExtension, explicitModuleFormat })
   )
 }
 
@@ -199,7 +241,9 @@ async function downloadAndWriteOpenAPI (
   withCredentials,
   propsOptional,
   retryTimeoutMs,
-  moduleFormat
+  moduleFormat,
+  typeExtension,
+  explicitModuleFormat
 ) {
   logger.debug(`Trying to download OpenAPI schema from ${url}`)
   let requestOptions
@@ -237,7 +281,9 @@ async function downloadAndWriteOpenAPI (
         logger,
         withCredentials,
         propsOptional,
-        moduleFormat
+        moduleFormat,
+        typeExtension,
+        explicitModuleFormat
       )
       /* c8 ignore next 3 */
     } catch (err) {
@@ -257,7 +303,9 @@ async function downloadAndWriteGraphQL (
   folder,
   name,
   generateImplementation,
-  moduleFormat
+  moduleFormat,
+  typeExtension,
+  explicitModuleFormat
 ) {
   logger.debug(`Trying to download GraphQL schema from ${url}`)
   const query = graphql.getIntrospectionQuery()
@@ -284,7 +332,9 @@ async function downloadAndWriteGraphQL (
     schema,
     url,
     generateImplementation,
-    moduleFormat
+    moduleFormat,
+    typeExtension,
+    explicitModuleFormat
   )
   return 'graphql'
 }
@@ -305,7 +355,9 @@ async function readFromFileAndWrite (
   typesComment,
   withCredentials,
   propsOptional,
-  moduleFormat
+  moduleFormat,
+  typeExtension,
+  explicitModuleFormat
 ) {
   logger.info(`Trying to read schema from file ${file}`)
   const text = await readFile(file, 'utf8')
@@ -327,7 +379,9 @@ async function readFromFileAndWrite (
       logger,
       withCredentials,
       propsOptional,
-      moduleFormat
+      moduleFormat,
+      typeExtension,
+      explicitModuleFormat
     )
     return 'openapi'
   } catch (err) {
@@ -346,7 +400,9 @@ async function readFromFileAndWrite (
       introspectionResult,
       'http://localhost:3042/graphql',
       generateImplementation,
-      moduleFormat
+      moduleFormat,
+      typeExtension,
+      explicitModuleFormat
     )
     return 'graphql'
   }
@@ -370,7 +426,9 @@ async function downloadAndProcess (options) {
     withCredentials,
     propsOptional,
     retryTimeoutMs,
-    moduleFormat
+    moduleFormat,
+    typeExtension,
+    explicitModuleFormat
   } = options
 
   const generateImplementation = options.generateImplementation
@@ -399,7 +457,9 @@ async function downloadAndProcess (options) {
           withCredentials,
           propsOptional,
           retryTimeoutMs,
-          moduleFormat
+          moduleFormat,
+          typeExtension,
+          explicitModuleFormat
         )
       )
       toTry.push(
@@ -422,7 +482,9 @@ async function downloadAndProcess (options) {
           withCredentials,
           propsOptional,
           retryTimeoutMs,
-          moduleFormat
+          moduleFormat,
+          typeExtension,
+          explicitModuleFormat
         )
       )
     } else if (options.type === 'graphql') {
@@ -434,7 +496,9 @@ async function downloadAndProcess (options) {
           folder,
           name,
           generateImplementation,
-          moduleFormat
+          moduleFormat,
+          typeExtension,
+          explicitModuleFormat
         )
       )
       toTry.push(
@@ -445,7 +509,9 @@ async function downloadAndProcess (options) {
           folder,
           name,
           generateImplementation,
-          moduleFormat
+          moduleFormat,
+          typeExtension,
+          explicitModuleFormat
         )
       )
     } else {
@@ -470,7 +536,9 @@ async function downloadAndProcess (options) {
           withCredentials,
           propsOptional,
           retryTimeoutMs,
-          moduleFormat
+          moduleFormat,
+          typeExtension,
+          explicitModuleFormat
         )
       )
       toTry.push(
@@ -481,7 +549,9 @@ async function downloadAndProcess (options) {
           folder,
           name,
           generateImplementation,
-          moduleFormat
+          moduleFormat,
+          typeExtension,
+          explicitModuleFormat
         )
       )
       toTry.push(
@@ -504,7 +574,9 @@ async function downloadAndProcess (options) {
           withCredentials,
           propsOptional,
           retryTimeoutMs,
-          moduleFormat
+          moduleFormat,
+          typeExtension,
+          explicitModuleFormat
         )
       )
       toTry.push(
@@ -515,7 +587,9 @@ async function downloadAndProcess (options) {
           folder,
           name,
           generateImplementation,
-          moduleFormat
+          moduleFormat,
+          typeExtension,
+          explicitModuleFormat
         )
       )
     }
@@ -539,7 +613,9 @@ async function downloadAndProcess (options) {
         typesComment,
         withCredentials,
         propsOptional,
-        moduleFormat
+        moduleFormat,
+        typeExtension,
+        explicitModuleFormat
       )
     )
   }
@@ -557,11 +633,12 @@ async function downloadAndProcess (options) {
   }
 }
 
-function getPackageJSON ({ name, generateImplementation, moduleFormat }) {
+async function getPackageJSON ({ name, generateImplementation, moduleFormat, folder, typeExtension, explicitModuleFormat }) {
   const isESM = moduleFormat === 'esm'
+  const typeExt = await determineTypeExtension(folder, moduleFormat, typeExtension, explicitModuleFormat, generateImplementation)
   const obj = {
     name,
-    types: `./${name}.${isESM ? 'd.mts' : 'd.cts'}`
+    types: `./${name}.${typeExt}`
   }
 
   if (isESM) {
@@ -604,7 +681,8 @@ export async function command (argv) {
       'frontend',
       'validate-response',
       'props-optional',
-      'skip-config-update'
+      'skip-config-update',
+      'type-extension'
     ],
     default: {
       typescript: false,
@@ -672,6 +750,8 @@ export async function command (argv) {
     options.withCredentials = options['with-credentials']
     options.skipConfigUpdate = options['skip-config-update'] ?? true
     options.retryTimeoutMs = options['retry-timeout-ms']
+    options.typeExtension = options['type-extension']
+    options.explicitModuleFormat = !!options.module
     await downloadAndProcess({ url, ...options, logger })
     logger.info(`Client generated successfully into ${options.folder}`)
     logger.info('Check out the docs to know more: https://docs.platformatic.dev/docs/service/overview')

package/lib/frontend-openapi-generator.js

@@ -18,7 +18,8 @@ export function processFrontendOpenAPI ({
   fullRequest,
   logger,
   withCredentials,
-  propsOptional
+  propsOptional,
+  typeExt = 'd.mts'
 }) {
   return {
     types: generateTypesFromOpenAPI({ schema, name, fullResponse, fullRequest, propsOptional }),
@@ -29,7 +30,8 @@ export function processFrontendOpenAPI ({
       fullResponse,
       fullRequest,
       logger,
-      withCredentials
+      withCredentials,
+      typeExt
     })
   }
 }
@@ -41,7 +43,8 @@ function generateFrontendImplementationFromOpenAPI ({
   fullResponse,
   fullRequest,
   logger,
-  withCredentials
+  withCredentials,
+  typeExt = 'd.mts'
 }) {
   const camelCaseName = capitalize(camelcase(name))
   const { paths } = schema
@@ -111,13 +114,13 @@ function generateFrontendImplementationFromOpenAPI ({
     writer.write('function sanitizeUrl(url)').block(() => {
       writer.writeLine("if (url.endsWith('/')) { return url.slice(0, -1) } else { return url }")
     })
-    writer.writeLine(`/**  @type {import('./${name}-types.d.mts').${camelCaseName}['setBaseUrl']} */`)
+    writer.writeLine(`/**  @type {import('./${name}-types.${typeExt}').${camelCaseName}['setBaseUrl']} */`)
     writer.writeLine('export const setBaseUrl = (newUrl) => { baseUrl = sanitizeUrl(newUrl) }')
     writer.newLine()
-    writer.writeLine(`/**  @type {import('./${name}-types.d.mts').${camelCaseName}['setDefaultHeaders']} */`)
+    writer.writeLine(`/**  @type {import('./${name}-types.${typeExt}').${camelCaseName}['setDefaultHeaders']} */`)
     writer.writeLine('export const setDefaultHeaders = (headers) => { defaultHeaders = headers }')
     writer.newLine()
-    writer.writeLine(`/**  @type {import('./${name}-types.d.mts').${camelCaseName}['setDefaultFetchParams']} */`)
+    writer.writeLine(`/**  @type {import('./${name}-types.${typeExt}').${camelCaseName}['setDefaultFetchParams']} */`)
     writer.writeLine('export const setDefaultFetchParams = (fetchParams) => { defaultFetchParams = fetchParams }')
     writer.newLine()
     writer.write('function headersToJSON(headers) ').block(() => {
@@ -354,7 +357,7 @@ function generateFrontendImplementationFromOpenAPI ({
       // ```
       //
       writer
-        .writeLine(`/**  @type {import('./${name}-types.d.mts').${camelCaseName}['${operationId}']} */`)
+        .writeLine(`/**  @type {import('./${name}-types.${typeExt}').${camelCaseName}['${operationId}']} */`)
         .write(`export const ${operationId} = async (request) =>`)
         .block(() => {
           writer.write(`return await ${underscoredOperationId}(baseUrl, request)`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "massimo-cli",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "A client for HTTP services.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -30,7 +30,7 @@
     "pino-pretty": "^13.0.0",
     "undici": "^7.0.0",
     "yaml": "^2.4.1",
-    "massimo": "0.4.0"
+    "massimo": "0.5.0"
   },
   "devDependencies": {
     "@platformatic/composer": "3.0.0-alpha.6",