feat: use the agent to create typings (#1021)

* feat: use the agent to create typings

* test: fix test

---------

Co-authored-by: Nicolas Moreau <nicolas.moreau76@gmail.com>

packages/agent/src/agent.ts

@@ -109,6 +109,18 @@ export default class Agent<S extends TSchema = TSchema> extends FrameworkMounter
     return this;
   }
 
+  /**
+   * Update the typings files generated from your datasources
+   * @param typingsPath the path at which to write the new file
+   * @param typingsMaxDepth the max depth of relation typings
+   * @see {@link https://docs.forestadmin.com/developer-guide-agents-nodejs/getting-started/install/autocompletion-and-typings Documentation Link}
+   */
+  async updateTypesOnFileSystem(typingsPath: string, typingsMaxDepth: number): Promise<void> {
+    const { logger } = this.options;
+    await this.customizer.getDataSource(logger);
+    this.customizer.updateTypesOnFileSystem(typingsPath, typingsMaxDepth);
+  }
+
   /**
    * Create a new API chart
    * @param name name of the chart

packages/agent/test/agent.test.ts

@@ -25,6 +25,7 @@ const mockCustomizer = {
   addChart: jest.fn(),
   customizeCollection: jest.fn(),
   updateTypesOnFileSystem: jest.fn(),
+  getDataSource: jest.fn(),
   use: jest.fn(),
   getFactory: jest.fn(),
   removeCollection: jest.fn(),
@@ -309,4 +310,19 @@ describe('Agent', () => {
       expect(options.forestAdminClient.close).toHaveBeenCalledTimes(1);
     });
   });
+
+  describe('updateTypesOnFileSystem', () => {
+    test('should write/update the typings file if apimap has changed', async () => {
+      const options = factories.forestAdminHttpDriverOptions.build();
+      const agent = new Agent(options);
+
+      await agent.updateTypesOnFileSystem('the/path/to/typings.d.ts', 42);
+
+      expect(mockCustomizer.getDataSource).toHaveBeenCalledOnceWith(options.logger);
+      expect(mockCustomizer.updateTypesOnFileSystem).toHaveBeenCalledOnceWith(
+        'the/path/to/typings.d.ts',
+        42,
+      );
+    });
+  });
 });