feat(types): encode min length arrays into types

Allows to encode into produced types the minnimum length of arrays.
nfroidure · Oct 9, 2023 · 4d2279f · 4d2279f
1 parent 9528d27
commit 4d2279f
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 0 deletions.
diff --git a/src/index.test.ts b/src/index.test.ts
@@ -1074,6 +1074,33 @@ describe('generateTypeDeclaration()', () => {
 `);
   });
 
+  test('should create tuples from min length arrays', async () => {
+    const schema: JSONSchema7 = {
+      title: 'FixedArrayToTupleTest',
+      type: 'object',
+      additionalProperties: false,
+      required: ['data'],
+      properties: {
+        data: {
+          type: 'array',
+          items: { type: 'string' },
+          minItems: 2,
+        },
+      },
+    };
+
+    expect(toSource(await generateTypeDeclaration(context, schema)))
+      .toMatchInlineSnapshot(`
+"export type FixedArrayToTupleTest = NonNullable<{
+    data: NonNullable<[
+        NonNullable<string>,
+        NonNullable<string>,
+        ...NonNullable<string>[]
+    ]>;
+}>;"
+`);
+  });
+
   test('should work with tuples and rest test case schemas', async () => {
     const schema: JSONSchema7 = {
       title: 'TupleTest',

diff --git a/src/index.ts b/src/index.ts
@@ -1312,6 +1312,31 @@ async function buildArrayTypeNode(
       );
     }
 
+    // Switch from arrays to tuples and spread for small min length arrays
+    if (
+      'minItems' in schema &&
+      typeof schema.minItems === 'number' &&
+      schema.minItems > 0 &&
+      schema.minItems <
+        context.jsonSchemaOptions.tuplesFromFixedArraysLengthLimit
+    ) {
+      return ts.factory.createTupleTypeNode(
+        new Array(schema.minItems)
+          .fill(
+            types.length > 1 ? ts.factory.createUnionTypeNode(types) : types[0],
+          )
+          .concat(
+            ts.factory.createRestTypeNode(
+              ts.factory.createArrayTypeNode(
+                types.length > 1
+                  ? ts.factory.createUnionTypeNode(types)
+                  : types[0],
+              ),
+            ),
+          ),
+      );
+    }
+
     return ts.factory.createArrayTypeNode(
       types.length > 1 ? ts.factory.createUnionTypeNode(types) : types[0],
     );