chore(release): v0.20.0 (#133)

the-codegen-project · Oct 20, 2024 · d961aa9 · d961aa9
1 parent 6a38577
commit d961aa9
Show file tree

Hide file tree

Showing 25 changed files with 213 additions and 139 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -50,3 +50,4 @@ Each protocol has its own limitations, corner cases, and features; thus, each ha
 
 
 
+
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -139,3 +139,4 @@ Prefix that follows specification is not enough though. Remember that the title
 When you submit changes, your submissions are understood to be under the same [Apache 2.0 License](../LICENSE) that covers the project.
 
 
+
diff --git a/docs/usage.md b/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.19.3 linux-x64 node-v18.20.4
+@the-codegen-project/cli/0.20.0 linux-x64 node-v18.20.4
 $ 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.19.3/src/commands/generate.ts)_
+_See code: [src/commands/generate.ts](https://github.com/the-codegen-project/cli/blob/v0.20.0/src/commands/generate.ts)_
 
 ## `codegen help [COMMAND]`
 
@@ -137,7 +137,7 @@ DESCRIPTION
   Initialize The Codegen Project in your project
 ```
 
-_See code: [src/commands/init.ts](https://github.com/the-codegen-project/cli/blob/v0.19.3/src/commands/init.ts)_
+_See code: [src/commands/init.ts](https://github.com/the-codegen-project/cli/blob/v0.20.0/src/commands/init.ts)_
 
 ## `codegen version`
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@the-codegen-project/cli",
   "description": "CLI to work with code generation in any environment",
-  "version": "0.19.3",
+  "version": "0.20.0",
   "bin": {
     "codegen": "./bin/run.mjs"
   },

diff --git a/schemas/configuration-schema-0.json b/schemas/configuration-schema-0.json
@@ -202,6 +202,56 @@
                                 },
                                 "additionalProperties": false
                             },
+                            {
+                                "type": "object",
+                                "properties": {
+                                    "id": {
+                                        "type": "string",
+                                        "default": "client-typescript"
+                                    },
+                                    "dependencies": {
+                                        "type": "array",
+                                        "items": {
+                                            "type": "string"
+                                        },
+                                        "default": [
+                                            "channels-typescript"
+                                        ]
+                                    },
+                                    "preset": {
+                                        "type": "string",
+                                        "const": "client",
+                                        "default": "client"
+                                    },
+                                    "outputPath": {
+                                        "type": "string",
+                                        "default": "src/__gen__/clients"
+                                    },
+                                    "protocols": {
+                                        "type": "array",
+                                        "items": {
+                                            "type": "string",
+                                            "enum": [
+                                                "nats"
+                                            ]
+                                        },
+                                        "default": [
+                                            "nats"
+                                        ]
+                                    },
+                                    "language": {
+                                        "type": "string",
+                                        "const": "typescript",
+                                        "default": "typescript"
+                                    },
+                                    "channelsGeneratorId": {
+                                        "type": "string",
+                                        "description": "In case you have multiple TypeScript channels generators, you can specify which one to use as the dependency for this channels generator.",
+                                        "default": "channels-typescript"
+                                    }
+                                },
+                                "additionalProperties": false
+                            },
                             {
                                 "type": "object",
                                 "properties": {

diff --git a/src/codegen/generators/index.ts b/src/codegen/generators/index.ts
@@ -29,7 +29,7 @@ import {TypeScriptChannelsGeneratorInternal} from './typescript/channels';
 import {loadConfigFile} from '../configuration-manager';
 import {loadAsyncapi} from '../inputs/asyncapi';
 import {runGenerators} from '..';
-import { TypeScriptClientGeneratorInternal } from './typescript/client';
+import {TypeScriptClientGeneratorInternal} from './typescript/client';
 
 export {
   TypeScriptChannelsGenerator,
@@ -45,7 +45,7 @@ export {
   defaultTypeScriptClientGenerator,
   generateTypeScriptClient,
   CustomGenerator,
-  defaultCustomGenerator,
+  defaultCustomGenerator
 };
 
 export async function renderGenerator(

diff --git a/src/codegen/generators/typescript/channels/index.ts b/src/codegen/generators/typescript/channels/index.ts
@@ -28,15 +28,15 @@ import {renderJetstreamPushSubscription} from './protocols/nats/jetstreamPushSub
 import {ensureRelativePath, findNameFromChannel} from '../../../utils';
 export type SupportedProtocols = 'nats';
 
-export enum ChannelFunctionTypes { 
+export enum ChannelFunctionTypes {
   NATS_JETSTREAM_PUBLISH = 'nats_jetstream_publish',
   NATS_JETSTREAM_PULL_SUBSCRIBE = 'nats_jetstream_pull_subscribe',
   NATS_JETSTREAM_PUSH_SUBSCRIBE = 'nats_jetstream_push_subscribe',
   NATS_CORE_SUBSCRIBE = 'nats_core_subscribe',
   NATS_CORE_PUBLISH = 'nats_core_publish',
   NATS_REQUEST = 'nats_request',
-  NATS_REPLY = 'nats_reply' 
-};
+  NATS_REPLY = 'nats_reply'
+}
 
 export const zodTypescriptChannelsGenerator = z.object({
   id: z.string().optional().default('channels-typescript'),
@@ -80,17 +80,17 @@ export interface TypeScriptChannelsContext extends GenericCodegenContext {
   generator: TypeScriptChannelsGeneratorInternal;
 }
 export type renderedFunctionType = {
-  functionType: ChannelFunctionTypes, 
-  functionName: string,
-  messageType: string,
-  parameterType?: string
+  functionType: ChannelFunctionTypes;
+  functionName: string;
+  messageType: string;
+  parameterType?: string;
 };
 export interface TypeScriptChannelRenderType {
-  payloadRender: TypeScriptPayloadRenderType,
-  parameterRender: TypeScriptparameterRenderType,
-  generator: TypeScriptChannelsGeneratorInternal,
+  payloadRender: TypeScriptPayloadRenderType;
+  parameterRender: TypeScriptparameterRenderType;
+  generator: TypeScriptChannelsGeneratorInternal;
   // All the rendered functions based on protocol.
-  renderedFunctions: Record<string, renderedFunctionType[]>
+  renderedFunctions: Record<string, renderedFunctionType[]>;
 }
 
 // eslint-disable-next-line sonarjs/cognitive-complexity
@@ -106,8 +106,12 @@ export async function generateTypeScriptChannels(
       'Internal error, could not determine previous rendered outputs that is required for channel typescript generator'
     );
   }
-  const payloads = context.dependencyOutputs[generator.payloadGeneratorId] as TypeScriptPayloadRenderType;
-  const parameters = context.dependencyOutputs[generator.parameterGeneratorId] as TypeScriptparameterRenderType;
+  const payloads = context.dependencyOutputs[
+    generator.payloadGeneratorId
+  ] as TypeScriptPayloadRenderType;
+  const parameters = context.dependencyOutputs[
+    generator.parameterGeneratorId
+  ] as TypeScriptparameterRenderType;
   if (!payloads) {
     throw new Error(
       'Internal error, could not determine previous rendered payloads generator that is required for channel TypeScript generator'
@@ -120,7 +124,10 @@ export async function generateTypeScriptChannels(
   }
 
   const protocolCodeFunctions: Record<string, string[]> = {};
-  const externalProtocolFunctionInformation: Record<string, renderedFunctionType[]> = {};
+  const externalProtocolFunctionInformation: Record<
+    string,
+    renderedFunctionType[]
+  > = {};
   const protocolsToUse = generator.protocols;
   for (const protocol of protocolsToUse) {
     protocolCodeFunctions[protocol] = [];
@@ -209,10 +216,11 @@ export async function generateTypeScriptChannels(
           externalProtocolFunctionInformation[protocol].push(
             ...renders.map((value) => {
               return {
-                functionType: value.functionType as any, 
+                functionType: value.functionType as any,
                 functionName: value.functionName,
                 messageType: payload.messageType,
-                parameterType: parameter !== undefined ? parameter.model.type : undefined
+                parameterType:
+                  parameter !== undefined ? parameter.model.type : undefined
               };
             })
           );

diff --git a/src/codegen/generators/typescript/channels/protocols/nats/corePublish.ts b/src/codegen/generators/typescript/channels/protocols/nats/corePublish.ts
@@ -1,5 +1,5 @@
 /* eslint-disable sonarjs/no-nested-template-literals */
-import { ChannelFunctionTypes } from '../..';
+import {ChannelFunctionTypes} from '../..';
 import {SingleFunctionRenderType} from '../../../../../types';
 import {pascalCase} from '../../../utils';
 import {ConstrainedMetaModel, ConstrainedObjectModel} from '@asyncapi/modelina';

diff --git a/src/codegen/generators/typescript/channels/protocols/nats/coreReply.ts b/src/codegen/generators/typescript/channels/protocols/nats/coreReply.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-nested-ternary */
-import { ChannelFunctionTypes } from '../..';
+import {ChannelFunctionTypes} from '../..';
 import {SingleFunctionRenderType} from '../../../../../types';
 import {findRegexFromChannel, pascalCase} from '../../../utils';
 import {ConstrainedMetaModel, ConstrainedObjectModel} from '@asyncapi/modelina';

diff --git a/src/codegen/generators/typescript/channels/protocols/nats/coreRequest.ts b/src/codegen/generators/typescript/channels/protocols/nats/coreRequest.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-nested-ternary */
-import { ChannelFunctionTypes } from '../..';
+import {ChannelFunctionTypes} from '../..';
 import {SingleFunctionRenderType} from '../../../../../types';
 import {pascalCase} from '../../../utils';
 import {ConstrainedMetaModel, ConstrainedObjectModel} from '@asyncapi/modelina';

diff --git a/src/codegen/generators/typescript/channels/protocols/nats/coreSubscribe.ts b/src/codegen/generators/typescript/channels/protocols/nats/coreSubscribe.ts
@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-nested-template-literals */
 /* eslint-disable no-nested-ternary */
-import { ChannelFunctionTypes } from '../..';
+import {ChannelFunctionTypes} from '../..';
 import {SingleFunctionRenderType} from '../../../../../types';
 import {findRegexFromChannel, pascalCase} from '../../../utils';
 import {ConstrainedMetaModel, ConstrainedObjectModel} from '@asyncapi/modelina';

diff --git a/src/codegen/generators/typescript/channels/protocols/nats/jetstreamPublish.ts b/src/codegen/generators/typescript/channels/protocols/nats/jetstreamPublish.ts
@@ -2,7 +2,7 @@
 import {SingleFunctionRenderType} from '../../../../../types';
 import {pascalCase} from '../../../utils';
 import {ConstrainedMetaModel, ConstrainedObjectModel} from '@asyncapi/modelina';
-import {ChannelFunctionTypes } from '../../index';
+import {ChannelFunctionTypes} from '../../index';
 export function renderJetstreamPublish({
   topic,
   message,

diff --git a/src/codegen/generators/typescript/channels/protocols/nats/jetstreamPullSubscribe.ts b/src/codegen/generators/typescript/channels/protocols/nats/jetstreamPullSubscribe.ts
@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-nested-template-literals */
 /* eslint-disable no-nested-ternary */
-import { ChannelFunctionTypes } from '../..';
+import {ChannelFunctionTypes} from '../..';
 import {SingleFunctionRenderType} from '../../../../../types';
 import {findRegexFromChannel, pascalCase} from '../../../utils';
 import {ConstrainedMetaModel, ConstrainedObjectModel} from '@asyncapi/modelina';

diff --git a/src/codegen/generators/typescript/channels/protocols/nats/jetstreamPushSubscription.ts b/src/codegen/generators/typescript/channels/protocols/nats/jetstreamPushSubscription.ts
@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-nested-template-literals */
 /* eslint-disable no-nested-ternary */
-import { ChannelFunctionTypes } from '../..';
+import {ChannelFunctionTypes} from '../..';
 import {SingleFunctionRenderType} from '../../../../../types';
 import {findRegexFromChannel, pascalCase} from '../../../utils';
 import {ConstrainedMetaModel, ConstrainedObjectModel} from '@asyncapi/modelina';

diff --git a/src/codegen/generators/typescript/client/index.ts b/src/codegen/generators/typescript/client/index.ts
@@ -5,16 +5,13 @@ import {AsyncAPIDocumentInterface} from '@asyncapi/parser';
 import {mkdir, writeFile} from 'node:fs/promises';
 import path from 'node:path';
 import {z} from 'zod';
-import { defaultTypeScriptChannelsGenerator } from '../channels';
-import { generateNatsClient } from './protocols/nats';
+import {defaultTypeScriptChannelsGenerator} from '../channels';
+import {generateNatsClient} from './protocols/nats';
 export type SupportedProtocols = 'nats';
 
 export const zodTypescriptClientGenerator = z.object({
   id: z.string().optional().default('client-typescript'),
-  dependencies: z
-    .array(z.string())
-    .optional()
-    .default(['channels-typescript']),
+  dependencies: z.array(z.string()).optional().default(['channels-typescript']),
   preset: z.literal('client').default('client'),
   outputPath: z.string().default('src/__gen__/clients'),
   protocols: z.array(z.enum(['nats'])).default(['nats']),
@@ -25,7 +22,7 @@ export const zodTypescriptClientGenerator = z.object({
     .describe(
       'In case you have multiple TypeScript channels generators, you can specify which one to use as the dependency for this channels generator.'
     )
-    .default('channels-typescript'),
+    .default('channels-typescript')
 });
 
 export type TypeScriptClientGenerator = z.input<
@@ -53,7 +50,7 @@ export async function generateTypeScriptClient(
   }
 
   await mkdir(context.generator.outputPath, {recursive: true});
-  
+
   for (const protocol of generator.protocols) {
     switch (protocol) {
       case 'nats':
@@ -62,7 +59,7 @@ export async function generateTypeScriptClient(
           await generateNatsClient(context)
         );
         break;
-    
+
       default:
         break;
     }