massimo-cli 1.0.1 → 1.2.0

package/help/help.txt

@@ -75,6 +75,6 @@ Options:
 * `--types-comment` - Add a comment at the beginning of the auto generated `.d.ts` type definition.
 * `--with-credentials` - Adds "credentials: 'include'" to all fetch requests (only for frontend clients).
 * `--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.
+* `--skip-prefixed-url` - If passed, it will avoid unnecessary extra HTTP call to check if, for instance, the `/documentation/json` Open API URL exists

package/index.js

@@ -428,7 +428,8 @@ async function downloadAndProcess (options) {
     retryTimeoutMs,
     moduleFormat,
     typeExtension,
-    explicitModuleFormat
+    explicitModuleFormat,
+    skipPrefixedUrl
   } = options
 
   const generateImplementation = options.generateImplementation
@@ -437,31 +438,33 @@ async function downloadAndProcess (options) {
   const toTry = []
   if (url.startsWith('http')) {
     if (type === 'openapi') {
-      toTry.push(
-        downloadAndWriteOpenAPI.bind(
-          null,
-          logger,
-          url + '/documentation/json',
-          folder,
-          name,
-          generateImplementation,
-          typesOnly,
-          fullRequest,
-          fullResponse,
-          optionalHeaders,
-          validateResponse,
-          isFrontend,
-          language,
-          urlAuthHeaders,
-          typesComment,
-          withCredentials,
-          propsOptional,
-          retryTimeoutMs,
-          moduleFormat,
-          typeExtension,
-          explicitModuleFormat
+      if (!skipPrefixedUrl) {
+        toTry.push(
+          downloadAndWriteOpenAPI.bind(
+            null,
+            logger,
+            url + '/documentation/json',
+            folder,
+            name,
+            generateImplementation,
+            typesOnly,
+            fullRequest,
+            fullResponse,
+            optionalHeaders,
+            validateResponse,
+            isFrontend,
+            language,
+            urlAuthHeaders,
+            typesComment,
+            withCredentials,
+            propsOptional,
+            retryTimeoutMs,
+            moduleFormat,
+            typeExtension,
+            explicitModuleFormat
+          )
         )
-      )
+      }
       toTry.push(
         downloadAndWriteOpenAPI.bind(
           null,
@@ -488,19 +491,21 @@ async function downloadAndProcess (options) {
         )
       )
     } else if (options.type === 'graphql') {
-      toTry.push(
-        downloadAndWriteGraphQL.bind(
-          null,
-          logger,
-          url + '/graphql',
-          folder,
-          name,
-          generateImplementation,
-          moduleFormat,
-          typeExtension,
-          explicitModuleFormat
+      if (!skipPrefixedUrl) {
+        toTry.push(
+          downloadAndWriteGraphQL.bind(
+            null,
+            logger,
+            url + '/graphql',
+            folder,
+            name,
+            generateImplementation,
+            moduleFormat,
+            typeExtension,
+            explicitModuleFormat
+          )
         )
-      )
+      }
       toTry.push(
         downloadAndWriteGraphQL.bind(
           null,
@@ -516,44 +521,46 @@ async function downloadAndProcess (options) {
       )
     } else {
       // add download functions only if it's an URL
-      toTry.push(
-        downloadAndWriteOpenAPI.bind(
-          null,
-          logger,
-          url + '/documentation/json',
-          folder,
-          name,
-          generateImplementation,
-          typesOnly,
-          fullRequest,
-          fullResponse,
-          optionalHeaders,
-          validateResponse,
-          isFrontend,
-          language,
-          urlAuthHeaders,
-          typesComment,
-          withCredentials,
-          propsOptional,
-          retryTimeoutMs,
-          moduleFormat,
-          typeExtension,
-          explicitModuleFormat
+      if (!skipPrefixedUrl) {
+        toTry.push(
+          downloadAndWriteOpenAPI.bind(
+            null,
+            logger,
+            url + '/documentation/json',
+            folder,
+            name,
+            generateImplementation,
+            typesOnly,
+            fullRequest,
+            fullResponse,
+            optionalHeaders,
+            validateResponse,
+            isFrontend,
+            language,
+            urlAuthHeaders,
+            typesComment,
+            withCredentials,
+            propsOptional,
+            retryTimeoutMs,
+            moduleFormat,
+            typeExtension,
+            explicitModuleFormat
+          )
         )
-      )
-      toTry.push(
-        downloadAndWriteGraphQL.bind(
-          null,
-          logger,
-          url + '/graphql',
-          folder,
-          name,
-          generateImplementation,
-          moduleFormat,
-          typeExtension,
-          explicitModuleFormat
+        toTry.push(
+          downloadAndWriteGraphQL.bind(
+            null,
+            logger,
+            url + '/graphql',
+            folder,
+            name,
+            generateImplementation,
+            moduleFormat,
+            typeExtension,
+            explicitModuleFormat
+          )
         )
-      )
+      }
       toTry.push(
         downloadAndWriteOpenAPI.bind(
           null,
@@ -681,13 +688,14 @@ export async function command (argv) {
       'frontend',
       'validate-response',
       'props-optional',
-      'skip-config-update',
-      'type-extension'
+      'type-extension',
+      'skip-prefixed-url'
     ],
     default: {
       typescript: false,
       language: 'js',
-      full: true
+      full: true,
+      'props-optional': true
     },
     alias: {
       n: 'name',
@@ -729,7 +737,7 @@ export async function command (argv) {
 
     options.fullRequest = options['full-request']
     options.fullResponse = options['full-response']
-    options.propsOptional = options['props-optional'] ?? true
+    options.propsOptional = options['props-optional']
 
     options.optionalHeaders = options['optional-headers']
       ? options['optional-headers'].split(',').map((h) => h.trim())
@@ -748,9 +756,9 @@ export async function command (argv) {
     options.urlAuthHeaders = options['url-auth-headers']
     options.typesComment = options['types-comment']
     options.withCredentials = options['with-credentials']
-    options.skipConfigUpdate = options['skip-config-update'] ?? true
     options.retryTimeoutMs = options['retry-timeout-ms']
     options.typeExtension = options['type-extension']
+    options.skipPrefixedUrl = options['skip-prefixed-url']
     options.explicitModuleFormat = !!options.module
     await downloadAndProcess({ url, ...options, logger })
     logger.info(`Client generated successfully into ${options.folder}`)

package/lib/get-type.js

@@ -65,18 +65,22 @@ export function getType (typeDef, methodType, spec) {
     return `Array<${getType(typeDef.items, methodType, spec)}>${nullable === true ? ' | null' : ''}`
   }
   if (typeDef.enum) {
+    // Note: null type represented with an enum have no types and single enum element 'null'
+    if (typeDef.type === undefined && typeDef.enum.includes('null')) {
+      // Ignore `nullable` as it is implied by the enum
+      return 'null'
+    }
     const nullable = typeDef.nullable
-    return (
-      typeDef.enum
-        .map(en => {
-          if (typeDef.type === 'string') {
-            return `'${en.replace(/'/g, "\\'")}'`
-          } else {
-            return en
-          }
-        })
-        .join(' | ') + (nullable === true ? ' | null' : '')
-    )
+    const chainedTypes = typeDef.enum
+      .map(en => {
+        if (typeDef.type === 'string') {
+          return `'${en.replace(/'/g, "\\'")}'`
+        } else {
+          return en
+        }
+      })
+      .join(' | ')
+    return nullable === true ? `${chainedTypes} | null` : chainedTypes
   }
   if (typeDef.type === 'object') {
     const additionalProps = typeDef?.additionalProperties
@@ -137,8 +141,8 @@ function JSONSchemaToTsType ({ type, format, nullable }, methodType) {
       resultType = 'boolean'
       break
     case 'null':
-      resultType = 'null'
-      break
+      // Remove duplication, no need to make it nullable later, return directly
+      return 'null'
     // TODO what other types should we support here?
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "massimo-cli",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "A client for HTTP services.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -30,13 +30,13 @@
     "pino-pretty": "^13.0.0",
     "undici": "^7.0.0",
     "yaml": "^2.4.1",
-    "massimo": "1.0.1"
+    "massimo": "1.2.0"
   },
   "devDependencies": {
-    "@platformatic/composer": "3.0.0-alpha.6",
+    "@platformatic/composer": "3.17.0",
     "@platformatic/db": "3.0.0-alpha.6",
-    "@platformatic/foundation": "3.0.0-alpha.6",
-    "@platformatic/runtime": "3.0.0-alpha.6",
+    "@platformatic/foundation": "3.17.0",
+    "@platformatic/runtime": "3.16.0",
     "@platformatic/service": "3.0.0-alpha.6",
     "@platformatic/sql-graphql": "3.0.0-alpha.6",
     "@platformatic/sql-mapper": "3.0.0-alpha.6",
@@ -54,7 +54,7 @@
     "neostandard": "^0.12.0",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
-    "scheduler": "^0.26.0",
+    "scheduler": "^0.27.0",
     "split2": "^4.2.0",
     "tsd": "^0.32.0",
     "typescript": "^5.5.4",