@aligent/nx-openapi 2.1.1 → 2.1.2

package/README.md

@@ -24,7 +24,7 @@ Run `nx g @aligent/nx-openapi:client` with optional flags:
 - `--configPath` path to the redocly config file responsible for authentication when fetching a schema remotely. For more information: https://openapi-ts.dev/cli#auth.
 - `--skipValidate` If passed, this will skip schema pre-validation. Only do this if you have good reason to - not validating the schema beforehand may produce unpredictable results (either things may not generate at all or they may generate something that is incorrect).
 - `--override` Override the schema (and the generated type) of an existing client.
-- `--authMethod` Authentication method for the generated client middleware. Defaults to `api-key`. Available options:
+- `--authMethod` **(required)** Authentication method for the generated client middleware. Available options:
   - `api-key` - API key authentication using SSM Parameter Store
   - `oauth1.0a` - OAuth 1.0a authentication
   - `basic` - Basic authentication (username/password)
@@ -78,9 +78,12 @@ A `types` file that will contain several typescript interfaces depending on the
 - `operations`: The defined operations that can be performed on a given path. [More information.](https://swagger.io/docs/specification/v3_0/paths-and-operations/#operations)
 - `components`: A way of avoid duplication when paths or operations contain the same structure in their responses. Components define a structure that is used multiple time throughout the API. [More information.](https://swagger.io/docs/specification/v3_0/components/)
 
-A `client` file that will contain boilerplate code to help you get started. The client includes authentication middleware configured based on the `--authMethod` flag:
+A `client` file that will contain boilerplate code to help you get started. The client includes:
 
-- **api-key**: Configured to fetch credentials from AWS SSM Parameter Store
-- **oauth1.0a**: Configured with HMAC-SHA256 algorithm and placeholder credentials
-- **basic**: Configured with placeholder username/password credentials
-- **oauth2.0**: Configured with placeholder token and Bearer token type
+- `logMiddleware` for request/response logging
+- `retryMiddleware` for automatic retry with exponential backoff
+- Authentication middleware configured based on the `--authMethod` flag:
+  - **api-key**: Configured to fetch credentials from AWS SSM Parameter Store
+  - **oauth1.0a**: Configured with HMAC-SHA256 algorithm and placeholder credentials
+  - **basic**: Configured with placeholder username/password credentials
+  - **oauth2.0**: Configured with placeholder token and Bearer token type

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aligent/nx-openapi",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "type": "commonjs",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",

package/src/generators/client/client-specific-files/client.ts.template

@@ -6,6 +6,7 @@
  * - For more information about openapi-fetch middlewares: https://openapi-ts.dev/openapi-fetch/middleware-auth#middleware
  */
 import {
+    logMiddleware,
     retryMiddleware,
 } from '@aligent/microservice-util-lib';
 import createClient, { Client, ClientOptions } from 'openapi-fetch';
@@ -24,6 +25,7 @@ export class <%= className %> {
          */
 
         this.client.use(
+            logMiddleware('<%= className %>'),
             retryMiddleware({
                 onRetry: ({ attempt, error }) =>
                     console.log(`Retrying...${attempt} due to ${String(error)}`),

package/src/generators/client/generator.js

@@ -9,7 +9,7 @@ const VALID_EXTENSIONS = ['yaml', 'yml', 'json'];
 // We also use this as the project root for all generated clients
 const PROJECT_NAME = 'clients';
 async function clientGenerator(tree, options) {
-    const { name, schemaPath, importPath = `@clients`, skipValidate, override, authMethod = 'api-key', } = options;
+    const { name, schemaPath, importPath = `@clients`, skipValidate, override, authMethod, } = options;
     const ext = schemaPath.split('.').pop() || '';
     if (!VALID_EXTENSIONS.includes(ext)) {
         throw new Error(`Invalid schema file extension: ${ext}`);

package/src/generators/client/helpers/auth-configurations.js

@@ -141,9 +141,10 @@ function applyAuthMethodConfiguration(tree, filePath, authMethod, className) {
                 ${config.middlewareConfig.properties}
             })
         );`;
-    // Find the retryMiddleware use statement and insert before it
+    // Find the middleware use statement and insert auth before it
     const statements = constructor.getStatements();
-    const retryStatementIndex = statements.findIndex(statement => /this\.client\.use\(\s*retryMiddleware/.test(statement.getText()));
+    const retryStatementIndex = statements.findIndex(statement => /this\.client\.use\(/.test(statement.getText()) &&
+        /retryMiddleware/.test(statement.getText()));
     if (retryStatementIndex !== -1) {
         constructor.insertStatements(retryStatementIndex, middlewareCall);
     }

package/src/generators/client/schema.d.ts

@@ -5,5 +5,5 @@ export interface ClientGeneratorSchema {
     importPath?: string;
     skipValidate: boolean;
     override: boolean;
-    authMethod?: string;
+    authMethod: string;
 }

package/src/generators/client/schema.json

@@ -45,8 +45,17 @@
             "type": "string",
             "description": "Authentication method to use for the generated client middleware",
             "enum": ["api-key", "oauth1.0a", "basic", "oauth2.0"],
-            "default": "api-key"
+            "x-prompt": {
+                "message": "Which authentication method should the client use?",
+                "type": "list",
+                "items": [
+                    { "value": "api-key", "label": "API Key" },
+                    { "value": "oauth1.0a", "label": "OAuth 1.0a" },
+                    { "value": "basic", "label": "Basic Auth" },
+                    { "value": "oauth2.0", "label": "OAuth 2.0" }
+                ]
+            }
         }
     },
-    "required": ["name", "schemaPath"]
+    "required": ["name", "schemaPath", "authMethod"]
 }