chore(release): v0.25.0 (#175)

Author: jonaslagoni

docs/README.md

@@ -54,3 +54,4 @@ Each protocol has its own limitations, corner cases, and features; thus, each ha
 
 
 
+

docs/contributing.md

@@ -15,6 +15,7 @@ sidebar_label: Contributing
 - [Getting started](#getting-started)
 - [Contribution recogniton](#contribution-recogniton)
 - [Summary of the contribution flow](#summary-of-the-contribution-flow)
+- [Code of Conduct](#code-of-conduct)
 - [Our Development Process](#our-development-process)
 - [Pull Requests](#pull-requests)
 - [Conventional commits](#conventional-commits)
@@ -133,3 +134,4 @@ Pull requests should have a title that follows the specification, otherwise, mer
 What about MAJOR release? just add `!` to the prefix, like `fix!: ` or `refactor!: `
 
 Prefix that follows specification is not enough though. Remember that the title must be clear and descriptive with usage of [imperative mood](https://chris.beams.io/posts/git-commit/#imperative).
+

docs/usage.md

@@ -9,7 +9,7 @@ $ npm install -g @the-codegen-project/cli
 $ codegen COMMAND
 running command...
 $ codegen (--version)
-@the-codegen-project/cli/0.24.2 linux-x64 node-v18.20.5
+@the-codegen-project/cli/0.25.0 linux-x64 node-v18.20.5
 $ codegen --help [COMMAND]
 USAGE
   $ codegen COMMAND
@@ -81,7 +81,7 @@ DESCRIPTION
   Generate code based on your configuration, use `init` to get started.
 ```
 
-_See code: [src/commands/generate.ts](https://github.com/the-codegen-project/cli/blob/v0.24.2/src/commands/generate.ts)_
+_See code: [src/commands/generate.ts](https://github.com/the-codegen-project/cli/blob/v0.25.0/src/commands/generate.ts)_
 
 ## `codegen help [COMMAND]`
 
@@ -139,7 +139,7 @@ DESCRIPTION
   Initialize The Codegen Project in your project
 ```
 
-_See code: [src/commands/init.ts](https://github.com/the-codegen-project/cli/blob/v0.24.2/src/commands/init.ts)_
+_See code: [src/commands/init.ts](https://github.com/the-codegen-project/cli/blob/v0.25.0/src/commands/init.ts)_
 
 ## `codegen version`
 

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@the-codegen-project/cli",
   "description": "CLI to work with code generation in any environment",
-  "version": "0.24.2",
+  "version": "0.25.0",
   "bin": {
     "codegen": "./bin/run.mjs"
   },

package.json

@@ -9,20 +9,24 @@
             "type": "object",
             "properties": {
                 "$schema": {
-                    "type": "string"
+                    "type": "string",
+                    "description": "For JSON and YAML configuration files this is used to force the IDE to enable auto completion and validation features"
                 },
                 "inputType": {
                     "type": "string",
-                    "const": "asyncapi"
+                    "const": "asyncapi",
+                    "description": "The type of document "
                 },
                 "inputPath": {
-                    "type": "string"
+                    "type": "string",
+                    "description": "The path to the input document "
                 },
                 "language": {
                     "type": "string",
                     "enum": [
                         "typescript"
-                    ]
+                    ],
+                    "description": "Set the global language for all generators, either one needs to be set"
                 },
                 "generators": {
                     "type": "array",
@@ -177,6 +181,43 @@
                                         "description": "In case you have multiple TypeScript payload generators, you can specify which one to use as the dependency for this channels generator.",
                                         "default": "payloads-typescript"
                                     },
+                                    "asyncapiReverseOperations": {
+                                        "type": "boolean",
+                                        "default": false,
+                                        "description": "Setting this to true generate operations with reversed meaning. So for AsyncAPI this means if an operation is defined as action: \"send\", it gets the opposite view of \"receive\"."
+                                    },
+                                    "asyncapiGenerateForOperations": {
+                                        "type": "boolean",
+                                        "default": true,
+                                        "description": "Setting this to false means we dont enforce the operations defined in the AsyncAPI document and generate more generic channels."
+                                    },
+                                    "functionTypeMapping": {
+                                        "type": "object",
+                                        "additionalProperties": {
+                                            "anyOf": [
+                                                {
+                                                    "not": {}
+                                                },
+                                                {
+                                                    "type": "array",
+                                                    "items": {
+                                                        "type": "string",
+                                                        "enum": [
+                                                            "nats_jetstream_publish",
+                                                            "nats_jetstream_pull_subscribe",
+                                                            "nats_jetstream_push_subscribe",
+                                                            "nats_subscribe",
+                                                            "nats_publish",
+                                                            "nats_request",
+                                                            "nats_reply"
+                                                        ]
+                                                    }
+                                                }
+                                            ]
+                                        },
+                                        "default": {},
+                                        "description": "Used in conjunction with AsyncAPI input, can define channel ID along side the type of functions that should be rendered."
+                                    },
                                     "language": {
                                         "type": "string",
                                         "const": "typescript",

schemas/configuration-schema-0.json

@@ -4,7 +4,13 @@ import {
   ConstrainedObjectModel,
   OutputModel
 } from '@asyncapi/modelina';
-import {AsyncAPIDocumentInterface, ChannelInterface, MessageInterface, OperationInterface, OperationReplyInterface} from '@asyncapi/parser';
+import {
+  AsyncAPIDocumentInterface,
+  ChannelInterface,
+  MessageInterface,
+  OperationInterface,
+  OperationReplyInterface
+} from '@asyncapi/parser';
 import {ChannelPayload, PayloadRenderType} from '../../types';
 import {pascalCase} from '../typescript/utils';
 import {findExtensionObject, findNameFromChannel} from '../../utils';
@@ -23,17 +29,20 @@ export async function generateAsyncAPIPayloads<GeneratorType>(
   let otherModels: ChannelPayload[] = [];
   if (asyncapiDocument.allChannels().all().length > 0) {
     for (const channel of asyncapiDocument.allChannels().all()) {
-      const processMessages = async (messagesToProcess: MessageInterface[], preId: string): Promise<{generatedMessages: any[], messageType: string} | undefined> => {
+      const processMessages = async (
+        messagesToProcess: MessageInterface[],
+        preId: string
+      ): Promise<
+        {generatedMessages: any[]; messageType: string} | undefined
+      > => {
         let schemaObj: any = {
           type: 'object',
           $schema: 'http://json-schema.org/draft-07/schema'
         };
         const messages = messagesToProcess;
         if (messages.length > 1) {
           schemaObj.oneOf = [];
-          schemaObj['$id'] = pascalCase(
-            `${preId}_Payload`
-          );
+          schemaObj['$id'] = pascalCase(`${preId}_Payload`);
           for (const message of messages) {
             const schema = AsyncAPIInputProcessor.convertToInternalSchema(
               message.payload() as any
@@ -87,25 +96,39 @@ export async function generateAsyncAPIPayloads<GeneratorType>(
         const operationMessages = operation.messages().all();
         const operationReply = operation.reply();
         if (operationReply) {
-          const operationReplyId = findReplyId(operation, operationReply, channel);
-          const operationReplyGeneratedMessages = await processMessages(operationReply.messages().all(), operationReplyId);
+          const operationReplyId = findReplyId(
+            operation,
+            operationReply,
+            channel
+          );
+          const operationReplyGeneratedMessages = await processMessages(
+            operationReply.messages().all(),
+            operationReplyId
+          );
           if (operationReplyGeneratedMessages) {
             generatedOperationPayloads[operationReplyId] = {
-              messageModel: operationReplyGeneratedMessages.generatedMessages[0],
+              messageModel:
+                operationReplyGeneratedMessages.generatedMessages[0],
               messageType: operationReplyGeneratedMessages.messageType
             };
           }
         }
         const operationId = findOperationId(operation, channel);
-        const operationGeneratedMessages = await processMessages(operationMessages, operationId);
+        const operationGeneratedMessages = await processMessages(
+          operationMessages,
+          operationId
+        );
         if (operationGeneratedMessages) {
           generatedOperationPayloads[operationId] = {
             messageModel: operationGeneratedMessages.generatedMessages[0],
             messageType: operationGeneratedMessages.messageType
           };
         }
       }
-      const channelGeneratedMessages = await processMessages(channel.messages().all(), findNameFromChannel(channel));
+      const channelGeneratedMessages = await processMessages(
+        channel.messages().all(),
+        findNameFromChannel(channel)
+      );
       if (channelGeneratedMessages) {
         generatedChannelPayloads[channel.id()] = {
           messageModel: channelGeneratedMessages.generatedMessages[0],
@@ -131,12 +154,24 @@ export async function generateAsyncAPIPayloads<GeneratorType>(
   };
 }
 
-export function findReplyId(operation: OperationInterface, reply: OperationReplyInterface, channel: ChannelInterface) {
-  return (reply.json() as any)?.id ?? `${findOperationId(operation, reply.channel() ?? channel)}_reply`;
+export function findReplyId(
+  operation: OperationInterface,
+  reply: OperationReplyInterface,
+  channel: ChannelInterface
+) {
+  return (
+    (reply.json() as any)?.id ??
+    `${findOperationId(operation, reply.channel() ?? channel)}_reply`
+  );
 }
-export function findOperationId(operation: OperationInterface, channel: ChannelInterface) {
+export function findOperationId(
+  operation: OperationInterface,
+  channel: ChannelInterface
+) {
   let operationId = operation.id();
-  operationId = operation.hasOperationId() ? operation.operationId() : operationId;
+  operationId = operation.hasOperationId()
+    ? operation.operationId()
+    : operationId;
   const userSpecificName = findExtensionObject(operation)
     ? findExtensionObject(operation)['channelName']
     : undefined;

src/codegen/generators/helpers/payloads.ts

@@ -1,6 +1,6 @@
-import { ChannelFunctionTypes } from "./types";
+import {ChannelFunctionTypes} from './types';
 
-type Action = 'send' | 'receive' | 'subscribe' | 'publish'
+type Action = 'send' | 'receive' | 'subscribe' | 'publish';
 const sendingFunctionTypes = [
   ChannelFunctionTypes.NATS_JETSTREAM_PUBLISH,
   ChannelFunctionTypes.NATS_PUBLISH,
@@ -20,21 +20,31 @@ export function shouldRenderFunctionType(
   action: Action,
   reverseOperation: boolean
 ) {
-  const listToCheck = [...(Array.isArray(functionTypesToCheckFor) ? functionTypesToCheckFor : [functionTypesToCheckFor])];
+  const listToCheck = [
+    ...(Array.isArray(functionTypesToCheckFor)
+      ? functionTypesToCheckFor
+      : [functionTypesToCheckFor])
+  ];
   const hasSendingOperation = action === 'send' || action === 'subscribe';
   const hasReceivingOperation = action === 'receive' || action === 'publish';
   const hasFunctionMappingConfig = givenFunctionTypes !== undefined;
-  const checkForSending = listToCheck.some(item => sendingFunctionTypes.includes(item));
-  const checkForReceiving = listToCheck.some(item => receivingFunctionTypes.includes(item));
-  const hasFunctionType = (givenFunctionTypes ?? []).some(item => listToCheck.includes(item));
+  const checkForSending = listToCheck.some((item) =>
+    sendingFunctionTypes.includes(item)
+  );
+  const checkForReceiving = listToCheck.some((item) =>
+    receivingFunctionTypes.includes(item)
+  );
+  const hasFunctionType = (givenFunctionTypes ?? []).some((item) =>
+    listToCheck.includes(item)
+  );
   if (hasFunctionMappingConfig) {
     if (hasFunctionType) {
       const renderForSending = checkForSending && hasSendingOperation;
-      const renderForReceiving = checkForReceiving && hasReceivingOperation; 
+      const renderForReceiving = checkForReceiving && hasReceivingOperation;
       return renderForSending || renderForReceiving;
     }
     return false;
-  } 
+  }
 
   if (reverseOperation) {
     const renderForSending = hasSendingOperation && checkForReceiving;