Add support for converting constant size arrays into tuples

orhanhenrik · abduvaliiev · commit 96404a51e723 · 2025-01-22T15:58:52.000+02:00
diff --git a/bin/index.js b/bin/index.js
@@ -16,6 +16,7 @@ const params = program
     .option('--name <value>', 'Custom client class name')
     .option('--useOptions', 'Use options instead of arguments')
     .option('--useUnionTypes', 'Use union types instead of enums')
+    .option('--useTuples', 'Whether to convert constant size arrays to tuples.')
     .option('--exportCore <value>', 'Write core files to disk', true)
     .option('--exportServices <value>', 'Write services to disk', true)
     .option('--exportModels <value>', 'Write models to disk', true)
@@ -38,6 +39,7 @@ if (OpenAPI) {
         clientName: params.name,
         useOptions: params.useOptions,
         useUnionTypes: params.useUnionTypes,
+        useTuples: params.useTuples,
         exportCore: JSON.parse(params.exportCore) === true,
         exportServices: JSON.parse(params.exportServices) === true,
         exportModels: JSON.parse(params.exportModels) === true,
diff --git a/rollup.config.mjs b/rollup.config.mjs
@@ -39,6 +39,7 @@ const handlebarsPlugin = () => ({
                     escapeComment: true,
                     escapeDescription: true,
                     camelCase: true,
+                    repeatTimes: true,
                 },
             });
             return `export default ${templateSpec};`;
diff --git a/src/client/interfaces/Model.d.ts b/src/client/interfaces/Model.d.ts
@@ -15,4 +15,5 @@ export interface Model extends Schema {
     enum: Enum[];
     enums: Model[];
     properties: Model[];
+    isConstantSize?: boolean;
 }
diff --git a/src/index.ts b/src/index.ts
@@ -20,6 +20,7 @@ export type Options = {
     clientName?: string;
     useOptions?: boolean;
     useUnionTypes?: boolean;
+    useTuples?: boolean;
     exportCore?: boolean;
     exportServices?: boolean;
     exportModels?: boolean;
@@ -60,6 +61,7 @@ export const generate = async ({
     clientName,
     useOptions = false,
     useUnionTypes = false,
+    useTuples = false,
     exportCore = true,
     exportServices = true,
     exportModels = true,
@@ -77,6 +79,7 @@ export const generate = async ({
         httpClient,
         useUnionTypes,
         useOptions,
+        useTuples,
     });
 
     switch (openApiVersion) {
@@ -91,6 +94,7 @@ export const generate = async ({
                 httpClient,
                 useOptions,
                 useUnionTypes,
+                useTuples,
                 exportCore,
                 exportServices,
                 exportModels,
@@ -116,6 +120,7 @@ export const generate = async ({
                 httpClient,
                 useOptions,
                 useUnionTypes,
+                useTuples,
                 exportCore,
                 exportServices,
                 exportModels,
diff --git a/src/openApi/v3/parser/getModel.ts b/src/openApi/v3/parser/getModel.ts
@@ -73,26 +73,28 @@ export const getModel = (
     }
 
     if (definition.type === 'array' && definition.items) {
+        model.export = 'array';
+        model.isConstantSize = Boolean(
+            definition.minItems && definition.maxItems && definition.minItems === definition.maxItems
+        );
+
         if (definition.items.$ref) {
             const arrayItems = getType(definition.items.$ref);
-            model.export = 'array';
             model.type = arrayItems.type;
             model.base = arrayItems.base;
             model.template = arrayItems.template;
             model.imports.push(...arrayItems.imports);
             model.default = getModelDefault(definition, model);
-            return model;
         } else {
             const arrayItems = getModel(openApi, definition.items);
-            model.export = 'array';
             model.type = arrayItems.type;
             model.base = arrayItems.base;
             model.template = arrayItems.template;
             model.link = arrayItems;
             model.imports.push(...arrayItems.imports);
             model.default = getModelDefault(definition, model);
-            return model;
         }
+        return model;
     }
 
     if (
diff --git a/src/openApi/v3/parser/getModelProperties.ts b/src/openApi/v3/parser/getModelProperties.ts
@@ -98,6 +98,7 @@ export const getModelProperties = (
                     enum: model.enum,
                     enums: model.enums,
                     properties: model.properties,
+                    isConstantSize: model.isConstantSize,
                     ...propertyValues,
                 });
             }
diff --git a/src/templates/partials/type.hbs b/src/templates/partials/type.hbs
@@ -5,7 +5,17 @@
 {{else equals export 'enum'}}
 {{>typeEnum}}
 {{else equals export 'array'}}
+
+{{~#if @root.useTuples~}}
+{{~#if isConstantSize ~}}
+{{>typeTuple}}
+{{~else~}}
 {{>typeArray}}
+{{~/if~}}
+{{~else~}}
+{{>typeArray}}
+{{~/if~}}
+
 {{else equals export 'dictionary'}}
 {{>typeDictionary}}
 {{else equals export 'one-of'}}
diff --git a/src/templates/partials/typeTuple.hbs b/src/templates/partials/typeTuple.hbs
@@ -0,0 +1,21 @@
+{{~#if link~}}
+
+[
+{{~#repeatTimes minItems~}}
+{{>type link}}
+{{#unless isLast}}, {{/unless}}
+{{~/repeatTimes~}}
+]
+{{>isNullable}}
+
+{{~else~}}
+
+[
+{{~#repeatTimes minItems~}}
+{{>base}}
+{{#unless isLast}}, {{/unless}}
+{{~/repeatTimes~}}
+]
+{{>isNullable}}
+
+{{~/if~}}
diff --git a/src/utils/registerHandlebarHelpers.spec.ts b/src/utils/registerHandlebarHelpers.spec.ts
@@ -9,6 +9,7 @@ describe('registerHandlebarHelpers', () => {
             httpClient: HttpClient.FETCH,
             useOptions: false,
             useUnionTypes: false,
+            useTuples: false,
         });
         const helpers = Object.keys(Handlebars.helpers);
         expect(helpers).toContain('ifdef');
diff --git a/src/utils/registerHandlebarHelpers.ts b/src/utils/registerHandlebarHelpers.ts
@@ -11,6 +11,7 @@ export const registerHandlebarHelpers = (root: {
     httpClient: HttpClient;
     useOptions: boolean;
     useUnionTypes: boolean;
+    useTuples: boolean;
 }): void => {
     Handlebars.registerHelper('ifdef', function (this: any, ...args): string {
         const options = args.pop();
@@ -104,4 +105,16 @@ export const registerHandlebarHelpers = (root: {
     Handlebars.registerHelper('camelCase', function (value: string): string {
         return camelCase(value);
     });
+
+    Handlebars.registerHelper('repeatTimes', function (this: any, n, block) {
+        let accum = '';
+        for (let i = 0; i < n; ++i) {
+            const t = Handlebars.createFrame(this);
+            if (i == n - 1) {
+                t.isLast = true;
+            }
+            accum += block.fn(t);
+        }
+        return accum;
+    });
 };
diff --git a/src/utils/registerHandlebarTemplates.spec.ts b/src/utils/registerHandlebarTemplates.spec.ts
@@ -7,6 +7,7 @@ describe('registerHandlebarTemplates', () => {
             httpClient: HttpClient.FETCH,
             useOptions: false,
             useUnionTypes: false,
+            useTuples: false,
         });
         expect(templates.index).toBeDefined();
         expect(templates.exports.model).toBeDefined();
diff --git a/src/utils/registerHandlebarTemplates.ts b/src/utils/registerHandlebarTemplates.ts
@@ -83,6 +83,7 @@ import partialTypeGeneric from '../templates/partials/typeGeneric.hbs';
 import partialTypeInterface from '../templates/partials/typeInterface.hbs';
 import partialTypeIntersection from '../templates/partials/typeIntersection.hbs';
 import partialTypeReference from '../templates/partials/typeReference.hbs';
+import partialTypeTuple from '../templates/partials/typeTuple.hbs';
 import partialTypeUnion from '../templates/partials/typeUnion.hbs';
 import typeWithOmitReadOnly from '../templates/partials/typeWithOmitReadOnly.hbs';
 import { registerHandlebarHelpers } from './registerHandlebarHelpers';
@@ -118,6 +119,7 @@ export const registerHandlebarTemplates = (root: {
     httpClient: HttpClient;
     useOptions: boolean;
     useUnionTypes: boolean;
+    useTuples: boolean;
 }): Templates => {
     registerHandlebarHelpers(root);
 
@@ -170,6 +172,7 @@ export const registerHandlebarTemplates = (root: {
     Handlebars.registerPartial('typeGeneric', Handlebars.template(partialTypeGeneric));
     Handlebars.registerPartial('typeInterface', Handlebars.template(partialTypeInterface));
     Handlebars.registerPartial('typeReference', Handlebars.template(partialTypeReference));
+    Handlebars.registerPartial('typeTuple', Handlebars.template(partialTypeTuple));
     Handlebars.registerPartial('typeUnion', Handlebars.template(partialTypeUnion));
     Handlebars.registerPartial('typeWithOmitReadOnly', Handlebars.template(typeWithOmitReadOnly));
     Handlebars.registerPartial('typeIntersection', Handlebars.template(partialTypeIntersection));
diff --git a/src/utils/writeClient.spec.ts b/src/utils/writeClient.spec.ts
@@ -47,6 +47,7 @@ describe('writeClient', () => {
             HttpClient.FETCH,
             false,
             false,
+            false,
             true,
             true,
             true,
diff --git a/src/utils/writeClient.ts b/src/utils/writeClient.ts
@@ -42,6 +42,7 @@ export const writeClient = async (
     httpClient: HttpClient,
     useOptions: boolean,
     useUnionTypes: boolean,
+    useTuples: boolean,
     exportCore: boolean,
     exportServices: boolean,
     exportModels: boolean,
@@ -111,6 +112,7 @@ export const writeClient = async (
             outputPathModels,
             httpClient,
             useUnionTypes,
+            useTuples,
             indent,
             transformCase
         );
@@ -128,6 +130,7 @@ export const writeClient = async (
             templates,
             outputPath,
             useUnionTypes,
+            useTuples,
             exportCore,
             exportServices,
             exportModels,
diff --git a/src/utils/writeClientIndex.spec.ts b/src/utils/writeClientIndex.spec.ts
@@ -39,7 +39,7 @@ describe('writeClientIndex', () => {
             },
         };
 
-        await writeClientIndex(client, templates, '/', true, true, true, true, true, 'Service', '');
+        await writeClientIndex(client, templates, '/', true, true, true, true, true, true, 'Service', '');
 
         expect(writeFile).toBeCalledWith(resolve('/', '/index.ts'), 'index');
     });
diff --git a/src/utils/writeClientIndex.ts b/src/utils/writeClientIndex.ts
@@ -28,6 +28,7 @@ export const writeClientIndex = async (
     templates: Templates,
     outputPath: string,
     useUnionTypes: boolean,
+    useTuples: boolean,
     exportCore: boolean,
     exportServices: boolean,
     exportModels: boolean,
@@ -42,6 +43,7 @@ export const writeClientIndex = async (
         exportModels,
         exportSchemas,
         useUnionTypes,
+        useTuples,
         postfixServices,
         postfixModels,
         clientName,
diff --git a/src/utils/writeClientModels.spec.ts b/src/utils/writeClientModels.spec.ts
@@ -56,7 +56,7 @@ describe('writeClientModels', () => {
             },
         };
 
-        await writeClientModels(models, templates, '/', HttpClient.FETCH, false, Indent.SPACE_4, Case.NONE);
+        await writeClientModels(models, templates, '/', HttpClient.FETCH, false, false, Indent.SPACE_4, Case.NONE);
 
         expect(writeFile).toBeCalledWith(resolve('/', '/User.ts'), `model${EOL}`);
     });
diff --git a/src/utils/writeClientModels.ts b/src/utils/writeClientModels.ts
@@ -16,6 +16,7 @@ import type { Templates } from './registerHandlebarTemplates';
  * @param outputPath Directory to write the generated files to
  * @param httpClient The selected httpClient (fetch, xhr, node or axios)
  * @param useUnionTypes Use union types instead of enums
+ * @param useTuples Convert constant size arrays to tuples
  * @param indent Indentation options (4, 2 or tab)
  * @param transformCase Transform model case (camel, snake)
  */
@@ -25,6 +26,7 @@ export const writeClientModels = async (
     outputPath: string,
     httpClient: HttpClient,
     useUnionTypes: boolean,
+    useTuples: boolean,
     indent: Indent,
     transformCase: Case
 ): Promise<void> => {
@@ -35,6 +37,7 @@ export const writeClientModels = async (
             ...newModel,
             httpClient,
             useUnionTypes,
+            useTuples,
         });
         await writeFile(file, i(f(templateResult), indent));
     }
diff --git a/src/utils/writeClientSchemas.ts b/src/utils/writeClientSchemas.ts
@@ -31,6 +31,7 @@ export const writeClientSchemas = async (
             ...model,
             httpClient,
             useUnionTypes,
+            useTuples: true,
         });
         await writeFile(file, i(f(templateResult), indent));
     }

Original file line number	Diff line number	Diff line change
`@@ -15,4 +15,5 @@ export interface Model extends Schema {`
`15`	`15`	`enum: Enum[];`
`16`	`16`	`enums: Model[];`
`17`	`17`	`properties: Model[];`
	`18`	`+ isConstantSize?: boolean;`
`18`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,7 @@ export const getModelProperties = (`
`98`	`98`	`enum: model.enum,`
`99`	`99`	`enums: model.enums,`
`100`	`100`	`properties: model.properties,`
	`101`	`+ isConstantSize: model.isConstantSize,`
`101`	`102`	`...propertyValues,`
`102`	`103`	`});`
`103`	`104`	`}`