@forestadmin/agent 1.0.0-beta.24 → 1.0.0-beta.27

package/CHANGELOG.md

@@ -1,3 +1,32 @@
+# @forestadmin/agent [1.0.0-beta.27](https://github.com/ForestAdmin/agent-nodejs/compare/@forestadmin/agent@1.0.0-beta.26...@forestadmin/agent@1.0.0-beta.27) (2022-05-17)
+
+
+### Features
+
+* add support for standalone mode ([#304](https://github.com/ForestAdmin/agent-nodejs/issues/304)) ([c2bca75](https://github.com/ForestAdmin/agent-nodejs/commit/c2bca75a882c1591ad7560583ba0c56fb8020e12))
+
+# @forestadmin/agent [1.0.0-beta.26](https://github.com/ForestAdmin/agent-nodejs/compare/@forestadmin/agent@1.0.0-beta.25...@forestadmin/agent@1.0.0-beta.26) (2022-05-16)
+
+
+### Features
+
+* autocomplete on field names ([#263](https://github.com/ForestAdmin/agent-nodejs/issues/263)) ([e2025d5](https://github.com/ForestAdmin/agent-nodejs/commit/e2025d57d930edf6d326bd0c6d7fffcd4aad728d))
+
+
+
+
+
+### Dependencies
+
+* **@forestadmin/datasource-toolkit:** upgraded to 1.0.0-beta.16
+
+# @forestadmin/agent [1.0.0-beta.25](https://github.com/ForestAdmin/agent-nodejs/compare/@forestadmin/agent@1.0.0-beta.24...@forestadmin/agent@1.0.0-beta.25) (2022-05-16)
+
+
+### Features
+
+* **builder:** create one method per relation type in the collection customizer ([#302](https://github.com/ForestAdmin/agent-nodejs/issues/302)) ([df5438d](https://github.com/ForestAdmin/agent-nodejs/commit/df5438d641bd8c4f8ad7c114120189d9dda26c44))
+
 # @forestadmin/agent [1.0.0-beta.24](https://github.com/ForestAdmin/agent-nodejs/compare/@forestadmin/agent@1.0.0-beta.23...@forestadmin/agent@1.0.0-beta.24) (2022-05-16)
 
 

package/dist/agent/forestadmin-http-driver.d.ts

@@ -1,34 +1,12 @@
-/// <reference types="node" />
+/// <reference types="koa__router" />
 import { DataSource } from '@forestadmin/datasource-toolkit';
-import { IncomingMessage, ServerResponse } from 'http';
-import { AgentOptions } from '../types';
+import Router from '@koa/router';
 import { AgentOptionsWithDefaults } from './types';
-import BaseRoute from './routes/base-route';
-import { ForestAdminHttpDriverServices } from './services';
-/** Native Node.js callback that can be passed to an HTTP Server */
-export declare type HttpCallback = (req: IncomingMessage, res: ServerResponse) => void;
 export default class ForestAdminHttpDriver {
     readonly dataSource: DataSource;
     readonly options: AgentOptionsWithDefaults;
-    readonly services: ForestAdminHttpDriverServices;
-    routes: BaseRoute[];
-    private readonly app;
-    private status;
-    /**
-     * Native request handler.
-     * Can be used directly with express.js or the Node.js http module.
-     * Other frameworks will require adapters.
-     */
-    get handler(): HttpCallback;
-    constructor(dataSource: DataSource, options: AgentOptions);
-    /**
-     * Builds the underlying application from the datasource.
-     * This method can only be called once.
-     */
-    start(): Promise<void>;
-    /**
-     * Tear down all routes (close open sockets, ...)
-     */
-    stop(): Promise<void>;
+    constructor(dataSource: DataSource, options: AgentOptionsWithDefaults);
+    getRouter(): Promise<Router>;
+    sendSchema(): Promise<void>;
 }
 //# sourceMappingURL=forestadmin-http-driver.d.ts.map

package/dist/agent/forestadmin-http-driver.js

@@ -3,81 +3,41 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const koa_1 = __importDefault(require("koa"));
 const router_1 = __importDefault(require("@koa/router"));
 const koa_bodyparser_1 = __importDefault(require("koa-bodyparser"));
 const cors_1 = __importDefault(require("@koa/cors"));
-const path_1 = __importDefault(require("path"));
 const forest_http_api_1 = __importDefault(require("./utils/forest-http-api"));
-const http_driver_options_1 = __importDefault(require("./utils/http-driver-options"));
 const emitter_1 = __importDefault(require("./utils/forest-schema/emitter"));
 const routes_1 = __importDefault(require("./routes"));
 const services_1 = __importDefault(require("./services"));
 class ForestAdminHttpDriver {
     constructor(dataSource, options) {
-        this.routes = [];
-        this.app = new koa_1.default();
-        this.status = 'waiting';
         this.dataSource = dataSource;
-        this.options = http_driver_options_1.default.withDefaults(options);
-        this.services = (0, services_1.default)(this.options);
-        http_driver_options_1.default.validate(this.options);
+        this.options = options;
     }
-    /**
-     * Native request handler.
-     * Can be used directly with express.js or the Node.js http module.
-     * Other frameworks will require adapters.
-     */
-    get handler() {
-        return this.app.callback();
+    async getRouter() {
+        // Bootstrap app
+        const services = (0, services_1.default)(this.options);
+        const routes = (0, routes_1.default)(this.dataSource, this.options, services);
+        await Promise.all(routes.map(route => route.bootstrap()));
+        // Build router
+        const router = new router_1.default();
+        router.all('(.*)', (0, cors_1.default)({ credentials: true, maxAge: 24 * 3600, privateNetworkAccess: true }));
+        router.use((0, koa_bodyparser_1.default)({ jsonLimit: '50mb' }));
+        routes.forEach(route => route.setupRoutes(router));
+        return router;
     }
-    /**
-     * Builds the underlying application from the datasource.
-     * This method can only be called once.
-     */
-    async start() {
-        if (this.status !== 'waiting') {
-            throw new Error('Agent cannot be restarted.');
+    async sendSchema() {
+        const schema = await emitter_1.default.getSerializedSchema(this.options, this.dataSource);
+        const schemaIsKnown = await forest_http_api_1.default.hasSchema(this.options, schema.meta.schemaFileHash);
+        if (!schemaIsKnown) {
+            this.options.logger('Info', 'Schema was updated, sending new version');
+            await forest_http_api_1.default.uploadSchema(this.options, schema);
         }
-        try {
-            this.status = 'running';
-            // Build http application
-            const router = new router_1.default({ prefix: path_1.default.join('/', this.options.prefix) });
-            this.routes = (0, routes_1.default)(this.dataSource, this.options, this.services);
-            this.routes.forEach(route => route.setupRoutes(router));
-            await Promise.all(this.routes.map(route => route.bootstrap()));
-            this.app
-                .use((0, cors_1.default)({ credentials: true, maxAge: 24 * 3600, privateNetworkAccess: true }))
-                .use((0, koa_bodyparser_1.default)({ jsonLimit: '50mb' }))
-                .use(router.routes());
-            // Send schema to forestadmin-server (if relevant).
-            const schema = await emitter_1.default.getSerializedSchema(this.options, this.dataSource);
-            const schemaIsKnown = await forest_http_api_1.default.hasSchema(this.options, schema.meta.schemaFileHash);
-            if (!schemaIsKnown) {
-                this.options.logger('Info', 'Schema was updated, sending new version');
-                await forest_http_api_1.default.uploadSchema(this.options, schema);
-            }
-            else {
-                this.options.logger('Info', 'Schema was not updated since last run');
-            }
-            this.options.logger('Info', 'Started');
+        else {
+            this.options.logger('Info', 'Schema was not updated since last run');
         }
-        catch (e) {
-            this.options.logger('Error', e.message);
-            this.status = 'done';
-            throw e;
-        }
-    }
-    /**
-     * Tear down all routes (close open sockets, ...)
-     */
-    async stop() {
-        if (this.status !== 'running') {
-            throw new Error('Agent is not running.');
-        }
-        this.status = 'done';
-        await Promise.all(this.routes.map(route => route.tearDown()));
     }
 }
 exports.default = ForestAdminHttpDriver;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9yZXN0YWRtaW4taHR0cC1kcml2ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYWdlbnQvZm9yZXN0YWRtaW4taHR0cC1kcml2ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFFQSw4Q0FBc0I7QUFDdEIseURBQWlDO0FBQ2pDLG9FQUF3QztBQUN4QyxxREFBNkI7QUFDN0IsZ0RBQXdCO0FBS3hCLDhFQUFvRDtBQUNwRCxzRkFBdUQ7QUFDdkQsNEVBQTBEO0FBQzFELHNEQUFrQztBQUNsQywwREFBeUU7QUFLekUsTUFBcUIscUJBQXFCO0lBa0J4QyxZQUFZLFVBQXNCLEVBQUUsT0FBcUI7UUFkbEQsV0FBTSxHQUFnQixFQUFFLENBQUM7UUFFZixRQUFHLEdBQUcsSUFBSSxhQUFHLEVBQUUsQ0FBQztRQUN6QixXQUFNLEdBQW1DLFNBQVMsQ0FBQztRQVl6RCxJQUFJLENBQUMsVUFBVSxHQUFHLFVBQVUsQ0FBQztRQUM3QixJQUFJLENBQUMsT0FBTyxHQUFHLDZCQUFZLENBQUMsWUFBWSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ2xELElBQUksQ0FBQyxRQUFRLEdBQUcsSUFBQSxrQkFBWSxFQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUUzQyw2QkFBWSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDdEMsQ0FBQztJQWZEOzs7O09BSUc7SUFDSCxJQUFJLE9BQU87UUFDVCxPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsUUFBUSxFQUFFLENBQUM7SUFDN0IsQ0FBQztJQVVEOzs7T0FHRztJQUNILEtBQUssQ0FBQyxLQUFLO1FBQ1QsSUFBSSxJQUFJLENBQUMsTUFBTSxLQUFLLFNBQVMsRUFBRTtZQUM3QixNQUFNLElBQUksS0FBSyxDQUFDLDRCQUE0QixDQUFDLENBQUM7U0FDL0M7UUFFRCxJQUFJO1lBQ0YsSUFBSSxDQUFDLE1BQU0sR0FBRyxTQUFTLENBQUM7WUFFeEIseUJBQXlCO1lBQ3pCLE1BQU0sTUFBTSxHQUFHLElBQUksZ0JBQU0sQ0FBQyxFQUFFLE1BQU0sRUFBRSxjQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsQ0FBQztZQUMzRSxJQUFJLENBQUMsTUFBTSxHQUFHLElBQUEsZ0JBQVUsRUFBQyxJQUFJLENBQUMsVUFBVSxFQUFFLElBQUksQ0FBQyxPQUFPLEVBQUUsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1lBQ3ZFLElBQUksQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUMsS0FBSyxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO1lBQ3hELE1BQU0sT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxTQUFTLEVBQUUsQ0FBQyxDQUFDLENBQUM7WUFFL0QsSUFBSSxDQUFDLEdBQUc7aUJBQ0wsR0FBRyxDQUFDLElBQUEsY0FBSSxFQUFDLEVBQUUsV0FBVyxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsRUFBRSxHQUFHLElBQUksRUFBRSxvQkFBb0IsRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO2lCQUMvRSxHQUFHLENBQUMsSUFBQSx3QkFBVSxFQUFDLEVBQUUsU0FBUyxFQUFFLE1BQU0sRUFBRSxDQUFDLENBQUM7aUJBQ3RDLEdBQUcsQ0FBQyxNQUFNLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQztZQUV4QixtREFBbUQ7WUFDbkQsTUFBTSxNQUFNLEdBQUcsTUFBTSxpQkFBYSxDQUFDLG1CQUFtQixDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFDO1lBQ3RGLE1BQU0sYUFBYSxHQUFHLE1BQU0seUJBQWEsQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxNQUFNLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxDQUFDO1lBRTlGLElBQUksQ0FBQyxhQUFhLEVBQUU7Z0JBQ2xCLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLE1BQU0sRUFBRSx5Q0FBeUMsQ0FBQyxDQUFDO2dCQUN2RSxNQUFNLHlCQUFhLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsTUFBTSxDQUFDLENBQUM7YUFDeEQ7aUJBQU07Z0JBQ0wsSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsTUFBTSxFQUFFLHVDQUF1QyxDQUFDLENBQUM7YUFDdEU7WUFFRCxJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUUsU0FBUyxDQUFDLENBQUM7U0FDeEM7UUFBQyxPQUFPLENBQUMsRUFBRTtZQUNWLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLE9BQU8sRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUM7WUFDeEMsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUM7WUFDckIsTUFBTSxDQUFDLENBQUM7U0FDVDtJQUNILENBQUM7SUFFRDs7T0FFRztJQUNILEtBQUssQ0FBQyxJQUFJO1FBQ1IsSUFBSSxJQUFJLENBQUMsTUFBTSxLQUFLLFNBQVMsRUFBRTtZQUM3QixNQUFNLElBQUksS0FBSyxDQUFDLHVCQUF1QixDQUFDLENBQUM7U0FDMUM7UUFFRCxJQUFJLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQztRQUNyQixNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQyxLQUFLLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQyxDQUFDO0lBQ2hFLENBQUM7Q0FDRjtBQS9FRCx3Q0ErRUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9yZXN0YWRtaW4taHR0cC1kcml2ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYWdlbnQvZm9yZXN0YWRtaW4taHR0cC1kcml2ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFDQSx5REFBaUM7QUFDakMsb0VBQXdDO0FBQ3hDLHFEQUE2QjtBQUc3Qiw4RUFBb0Q7QUFDcEQsNEVBQTBEO0FBQzFELHNEQUFrQztBQUNsQywwREFBc0M7QUFFdEMsTUFBcUIscUJBQXFCO0lBSXhDLFlBQVksVUFBc0IsRUFBRSxPQUFpQztRQUNuRSxJQUFJLENBQUMsVUFBVSxHQUFHLFVBQVUsQ0FBQztRQUM3QixJQUFJLENBQUMsT0FBTyxHQUFHLE9BQU8sQ0FBQztJQUN6QixDQUFDO0lBRUQsS0FBSyxDQUFDLFNBQVM7UUFDYixnQkFBZ0I7UUFDaEIsTUFBTSxRQUFRLEdBQUcsSUFBQSxrQkFBWSxFQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUM1QyxNQUFNLE1BQU0sR0FBRyxJQUFBLGdCQUFVLEVBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRSxJQUFJLENBQUMsT0FBTyxFQUFFLFFBQVEsQ0FBQyxDQUFDO1FBQ25FLE1BQU0sT0FBTyxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUMsS0FBSyxDQUFDLFNBQVMsRUFBRSxDQUFDLENBQUMsQ0FBQztRQUUxRCxlQUFlO1FBQ2YsTUFBTSxNQUFNLEdBQUcsSUFBSSxnQkFBTSxFQUFFLENBQUM7UUFDNUIsTUFBTSxDQUFDLEdBQUcsQ0FBQyxNQUFNLEVBQUUsSUFBQSxjQUFJLEVBQUMsRUFBRSxXQUFXLEVBQUUsSUFBSSxFQUFFLE1BQU0sRUFBRSxFQUFFLEdBQUcsSUFBSSxFQUFFLG9CQUFvQixFQUFFLElBQUksRUFBRSxDQUFDLENBQUMsQ0FBQztRQUMvRixNQUFNLENBQUMsR0FBRyxDQUFDLElBQUEsd0JBQVUsRUFBQyxFQUFFLFNBQVMsRUFBRSxNQUFNLEVBQUUsQ0FBQyxDQUFDLENBQUM7UUFDOUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQztRQUVuRCxPQUFPLE1BQU0sQ0FBQztJQUNoQixDQUFDO0lBRUQsS0FBSyxDQUFDLFVBQVU7UUFDZCxNQUFNLE1BQU0sR0FBRyxNQUFNLGlCQUFhLENBQUMsbUJBQW1CLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDdEYsTUFBTSxhQUFhLEdBQUcsTUFBTSx5QkFBYSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUM7UUFFOUYsSUFBSSxDQUFDLGFBQWEsRUFBRTtZQUNsQixJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUUseUNBQXlDLENBQUMsQ0FBQztZQUN2RSxNQUFNLHlCQUFhLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsTUFBTSxDQUFDLENBQUM7U0FDeEQ7YUFBTTtZQUNMLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLE1BQU0sRUFBRSx1Q0FBdUMsQ0FBQyxDQUFDO1NBQ3RFO0lBQ0gsQ0FBQztDQUNGO0FBbkNELHdDQW1DQyJ9

package/dist/agent/routes/base-route.d.ts

@@ -8,7 +8,6 @@ export default abstract class BaseRoute {
     abstract get type(): RouteType;
     constructor(services: ForestAdminHttpDriverServices, options: AgentOptionsWithDefaults);
     bootstrap(): Promise<void>;
-    tearDown(): Promise<void>;
     abstract setupRoutes(router: Router): void;
 }
 //# sourceMappingURL=base-route.d.ts.map

package/dist/agent/routes/base-route.js

@@ -8,9 +8,6 @@ class BaseRoute {
     async bootstrap() {
         // Do nothing by default
     }
-    async tearDown() {
-        // Do nothing by default
-    }
 }
 exports.default = BaseRoute;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZS1yb3V0ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9hZ2VudC9yb3V0ZXMvYmFzZS1yb3V0ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUtBLE1BQThCLFNBQVM7SUFNckMsWUFBWSxRQUF1QyxFQUFFLE9BQWlDO1FBQ3BGLElBQUksQ0FBQyxRQUFRLEdBQUcsUUFBUSxDQUFDO1FBQ3pCLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO0lBQ3pCLENBQUM7SUFFRCxLQUFLLENBQUMsU0FBUztRQUNiLHdCQUF3QjtJQUMxQixDQUFDO0lBRUQsS0FBSyxDQUFDLFFBQVE7UUFDWix3QkFBd0I7SUFDMUIsQ0FBQztDQUdGO0FBcEJELDRCQW9CQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZS1yb3V0ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9hZ2VudC9yb3V0ZXMvYmFzZS1yb3V0ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUtBLE1BQThCLFNBQVM7SUFNckMsWUFBWSxRQUF1QyxFQUFFLE9BQWlDO1FBQ3BGLElBQUksQ0FBQyxRQUFRLEdBQUcsUUFBUSxDQUFDO1FBQ3pCLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO0lBQ3pCLENBQUM7SUFFRCxLQUFLLENBQUMsU0FBUztRQUNiLHdCQUF3QjtJQUMxQixDQUFDO0NBR0Y7QUFoQkQsNEJBZ0JDIn0=

package/dist/builder/agent.d.ts

@@ -1,7 +1,6 @@
-import { ChartDefinition, DataSourceFactory } from '@forestadmin/datasource-toolkit';
+import { ChartDefinition, DataSourceFactory, TCollectionName, TSchema } from '@forestadmin/datasource-toolkit';
 import { AgentOptions } from '../types';
 import CollectionBuilder from './collection';
-import { HttpCallback } from '../agent/forestadmin-http-driver';
 /**
  * Allow to create a new Forest Admin agent from scratch.
  * Builds the application by composing and configuring all the collection decorators.
@@ -12,19 +11,13 @@ import { HttpCallback } from '../agent/forestadmin-http-driver';
  *  .addDataSource(new SomeDataSource())
  *  .start();
  */
-export default class AgentBuilder {
-    private readonly forestAdminHttpDriver;
+export default class AgentBuilder<S extends TSchema = TSchema> {
     private readonly compositeDataSource;
     private readonly stack;
-    private tasks;
-    /**
-     * Native nodejs HttpCallback object
-     * @example
-     * import http from 'http';
-     * ...
-     * const server = http.createServer(agent.httpCallback);
-     */
-    get httpCallback(): HttpCallback;
+    private readonly options;
+    private customizations;
+    private mounts;
+    private termination;
     /**
      * Create a new Agent Builder.
      * If any options are missing, the default will be applied:
@@ -60,7 +53,7 @@ export default class AgentBuilder {
      *   }
      * })
      */
-    addChart(name: string, definition: ChartDefinition): this;
+    addChart(name: string, definition: ChartDefinition<S>): this;
     /**
      * Allow to interact with a decorated collection
      * @param name the name of the collection to manipulate
@@ -69,14 +62,17 @@ export default class AgentBuilder {
      * @example
      * .customizeCollection('books', books => books.renameField('xx', 'yy'))
      */
-    customizeCollection(name: string, handle: (collection: CollectionBuilder) => unknown): this;
+    customizeCollection<N extends TCollectionName<S>>(name: N, handle: (collection: CollectionBuilder<S, N>) => unknown): this;
     /**
-     * Start the agent.
+     * Expose the agent on a given port and host
+     * @param port port that should be used.
+     * @param host host that should be used.
      */
-    start(): Promise<void>;
+    mountStandalone(port?: number, host?: string): this;
     /**
-     * Stop the agent gracefully.
+     * Start the agent.
      */
+    start(): Promise<void>;
     stop(): Promise<void>;
 }
 //# sourceMappingURL=agent.d.ts.map

package/dist/builder/agent.js

@@ -4,9 +4,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const datasource_toolkit_1 = require("@forestadmin/datasource-toolkit");
+const promises_1 = require("fs/promises");
+const koa_1 = __importDefault(require("koa"));
+const router_1 = __importDefault(require("@koa/router"));
+const http_1 = __importDefault(require("http"));
 const collection_1 = __importDefault(require("./collection"));
 const decorators_stack_1 = __importDefault(require("./decorators-stack"));
 const forestadmin_http_driver_1 = __importDefault(require("../agent/forestadmin-http-driver"));
+const options_validator_1 = __importDefault(require("./utils/options-validator"));
+const typing_generator_1 = __importDefault(require("./utils/typing-generator"));
 /**
  * Allow to create a new Forest Admin agent from scratch.
  * Builds the application by composing and configuring all the collection decorators.
@@ -36,28 +42,20 @@ class AgentBuilder {
      *  .start();
      */
     constructor(options) {
-        this.tasks = [];
+        this.customizations = [];
+        this.mounts = [];
+        this.termination = [];
+        this.options = options_validator_1.default.withDefaults(options);
         this.compositeDataSource = new datasource_toolkit_1.BaseDataSource();
         this.stack = new decorators_stack_1.default(this.compositeDataSource);
-        this.forestAdminHttpDriver = new forestadmin_http_driver_1.default(this.stack.dataSource, options);
-    }
-    /**
-     * Native nodejs HttpCallback object
-     * @example
-     * import http from 'http';
-     * ...
-     * const server = http.createServer(agent.httpCallback);
-     */
-    get httpCallback() {
-        return this.forestAdminHttpDriver.handler;
     }
     /**
      * Add a datasource
      * @param factory the datasource to add
      */
     addDataSource(factory) {
-        this.tasks.push(async () => {
-            const datasource = await factory(this.forestAdminHttpDriver.options.logger);
+        this.customizations.push(async () => {
+            const datasource = await factory(this.options.logger);
             datasource.collections.forEach(collection => {
                 this.compositeDataSource.addCollection(collection);
             });
@@ -77,7 +75,7 @@ class AgentBuilder {
      * })
      */
     addChart(name, definition) {
-        this.tasks.push(async () => {
+        this.customizations.push(async () => {
             this.stack.chart.addChart(name, definition);
         });
         return this;
@@ -91,29 +89,58 @@ class AgentBuilder {
      * .customizeCollection('books', books => books.renameField('xx', 'yy'))
      */
     customizeCollection(name, handle) {
-        this.tasks.push(async () => {
+        this.customizations.push(async () => {
             if (this.stack.dataSource.getCollection(name)) {
                 handle(new collection_1.default(this.stack, name));
             }
         });
         return this;
     }
+    /**
+     * Expose the agent on a given port and host
+     * @param port port that should be used.
+     * @param host host that should be used.
+     */
+    mountStandalone(port = 3351, host = 'localhost') {
+        let server;
+        this.mounts.push(async (router) => {
+            const koa = new koa_1.default();
+            const parentRouter = new router_1.default({ prefix: '/forest' });
+            parentRouter.use(router.routes());
+            koa.use(parentRouter.routes());
+            server = http_1.default.createServer(koa.callback());
+            server.listen(port, host);
+            this.options.logger('Info', `Agent mounted at http://${host}:${port} (Standalone)`);
+        });
+        this.termination.push(async () => {
+            server.close();
+        });
+        return this;
+    }
     /**
      * Start the agent.
      */
     async start() {
-        for (const task of this.tasks) {
-            // eslint-disable-next-line no-await-in-loop
-            await task();
+        // Customize agent
+        for (const task of this.customizations)
+            await task(); // eslint-disable-line no-await-in-loop
+        // Check that options are valid
+        const options = options_validator_1.default.validate(this.options);
+        // Write typings file
+        if (!options.isProduction && options.typingsPath) {
+            const types = typing_generator_1.default.generateTypes(this.stack.action, options.typingsMaxDepth);
+            await (0, promises_1.writeFile)(options.typingsPath, types, { encoding: 'utf-8' });
         }
-        await this.forestAdminHttpDriver.start();
+        const httpDriver = new forestadmin_http_driver_1.default(this.stack.dataSource, options);
+        await httpDriver.sendSchema();
+        const router = await httpDriver.getRouter();
+        for (const task of this.mounts)
+            await task(router); // eslint-disable-line no-await-in-loop
     }
-    /**
-     * Stop the agent gracefully.
-     */
     async stop() {
-        return this.forestAdminHttpDriver.stop();
+        for (const task of this.termination)
+            await task(); // eslint-disable-line no-await-in-loop
     }
 }
 exports.default = AgentBuilder;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYnVpbGRlci9hZ2VudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLHdFQUt5QztBQUd6Qyw4REFBNkM7QUFDN0MsMEVBQWlEO0FBQ2pELCtGQUF1RjtBQUV2Rjs7Ozs7Ozs7O0dBU0c7QUFDSCxNQUFxQixZQUFZO0lBaUIvQjs7Ozs7Ozs7Ozs7Ozs7OztPQWdCRztJQUNILFlBQVksT0FBcUI7UUE5QnpCLFVBQUssR0FBNEIsRUFBRSxDQUFDO1FBK0IxQyxJQUFJLENBQUMsbUJBQW1CLEdBQUcsSUFBSSxtQ0FBYyxFQUFjLENBQUM7UUFDNUQsSUFBSSxDQUFDLEtBQUssR0FBRyxJQUFJLDBCQUFlLENBQUMsSUFBSSxDQUFDLG1CQUFtQixDQUFDLENBQUM7UUFFM0QsSUFBSSxDQUFDLHFCQUFxQixHQUFHLElBQUksaUNBQXFCLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxVQUFVLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDekYsQ0FBQztJQWpDRDs7Ozs7O09BTUc7SUFDSCxJQUFJLFlBQVk7UUFDZCxPQUFPLElBQUksQ0FBQyxxQkFBcUIsQ0FBQyxPQUFPLENBQUM7SUFDNUMsQ0FBQztJQTBCRDs7O09BR0c7SUFDSCxhQUFhLENBQUMsT0FBMEI7UUFDdEMsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsS0FBSyxJQUFJLEVBQUU7WUFDekIsTUFBTSxVQUFVLEdBQUcsTUFBTSxPQUFPLENBQUMsSUFBSSxDQUFDLHFCQUFxQixDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztZQUM1RSxVQUFVLENBQUMsV0FBVyxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsRUFBRTtnQkFDMUMsSUFBSSxDQUFDLG1CQUFtQixDQUFDLGFBQWEsQ0FBQyxVQUFVLENBQUMsQ0FBQztZQUNyRCxDQUFDLENBQUMsQ0FBQztRQUNMLENBQUMsQ0FBQyxDQUFDO1FBRUgsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7O09BV0c7SUFDSCxRQUFRLENBQUMsSUFBWSxFQUFFLFVBQTJCO1FBQ2hELElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssSUFBSSxFQUFFO1lBQ3pCLElBQUksQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxJQUFJLEVBQUUsVUFBVSxDQUFDLENBQUM7UUFDOUMsQ0FBQyxDQUFDLENBQUM7UUFFSCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0gsbUJBQW1CLENBQUMsSUFBWSxFQUFFLE1BQWtEO1FBQ2xGLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssSUFBSSxFQUFFO1lBQ3pCLElBQUksSUFBSSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxFQUFFO2dCQUM3QyxNQUFNLENBQUMsSUFBSSxvQkFBaUIsQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLElBQUksQ0FBQyxDQUFDLENBQUM7YUFDakQ7UUFDSCxDQUFDLENBQUMsQ0FBQztRQUVILE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOztPQUVHO0lBQ0gsS0FBSyxDQUFDLEtBQUs7UUFDVCxLQUFLLE1BQU0sSUFBSSxJQUFJLElBQUksQ0FBQyxLQUFLLEVBQUU7WUFDN0IsNENBQTRDO1lBQzVDLE1BQU0sSUFBSSxFQUFFLENBQUM7U0FDZDtRQUVELE1BQU0sSUFBSSxDQUFDLHFCQUFxQixDQUFDLEtBQUssRUFBRSxDQUFDO0lBQzNDLENBQUM7SUFFRDs7T0FFRztJQUNILEtBQUssQ0FBQyxJQUFJO1FBQ1IsT0FBTyxJQUFJLENBQUMscUJBQXFCLENBQUMsSUFBSSxFQUFFLENBQUM7SUFDM0MsQ0FBQztDQUNGO0FBaEhELCtCQWdIQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYnVpbGRlci9hZ2VudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLHdFQU95QztBQUN6QywwQ0FBd0M7QUFDeEMsOENBQXNCO0FBQ3RCLHlEQUFpQztBQUNqQyxnREFBd0I7QUFHeEIsOERBQTZDO0FBQzdDLDBFQUFpRDtBQUNqRCwrRkFBcUU7QUFDckUsa0ZBQXlEO0FBQ3pELGdGQUF1RDtBQUV2RDs7Ozs7Ozs7O0dBU0c7QUFDSCxNQUFxQixZQUFZO0lBUS9COzs7Ozs7Ozs7Ozs7Ozs7O09BZ0JHO0lBQ0gsWUFBWSxPQUFxQjtRQXJCekIsbUJBQWMsR0FBNEIsRUFBRSxDQUFDO1FBQzdDLFdBQU0sR0FBMEMsRUFBRSxDQUFDO1FBQ25ELGdCQUFXLEdBQTRCLEVBQUUsQ0FBQztRQW9CaEQsSUFBSSxDQUFDLE9BQU8sR0FBRywyQkFBZ0IsQ0FBQyxZQUFZLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDdEQsSUFBSSxDQUFDLG1CQUFtQixHQUFHLElBQUksbUNBQWMsRUFBYyxDQUFDO1FBQzVELElBQUksQ0FBQyxLQUFLLEdBQUcsSUFBSSwwQkFBZSxDQUFDLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDO0lBQzdELENBQUM7SUFFRDs7O09BR0c7SUFDSCxhQUFhLENBQUMsT0FBMEI7UUFDdEMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUMsS0FBSyxJQUFJLEVBQUU7WUFDbEMsTUFBTSxVQUFVLEdBQUcsTUFBTSxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztZQUN0RCxVQUFVLENBQUMsV0FBVyxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsRUFBRTtnQkFDMUMsSUFBSSxDQUFDLG1CQUFtQixDQUFDLGFBQWEsQ0FBQyxVQUFVLENBQUMsQ0FBQztZQUNyRCxDQUFDLENBQUMsQ0FBQztRQUNMLENBQUMsQ0FBQyxDQUFDO1FBRUgsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7O09BV0c7SUFDSCxRQUFRLENBQUMsSUFBWSxFQUFFLFVBQThCO1FBQ25ELElBQUksQ0FBQyxjQUFjLENBQUMsSUFBSSxDQUFDLEtBQUssSUFBSSxFQUFFO1lBQ2xDLElBQUksQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxJQUFJLEVBQUUsVUFBVSxDQUFDLENBQUM7UUFDOUMsQ0FBQyxDQUFDLENBQUM7UUFFSCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0gsbUJBQW1CLENBQ2pCLElBQU8sRUFDUCxNQUF3RDtRQUV4RCxJQUFJLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQyxLQUFLLElBQUksRUFBRTtZQUNsQyxJQUFJLElBQUksQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsRUFBRTtnQkFDN0MsTUFBTSxDQUFDLElBQUksb0JBQWlCLENBQU8sSUFBSSxDQUFDLEtBQUssRUFBRSxJQUFJLENBQUMsQ0FBQyxDQUFDO2FBQ3ZEO1FBQ0gsQ0FBQyxDQUFDLENBQUM7UUFFSCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsZUFBZSxDQUFDLElBQUksR0FBRyxJQUFJLEVBQUUsSUFBSSxHQUFHLFdBQVc7UUFDN0MsSUFBSSxNQUFtQixDQUFDO1FBRXhCLElBQUksQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBQyxNQUFNLEVBQUMsRUFBRTtZQUM5QixNQUFNLEdBQUcsR0FBRyxJQUFJLGFBQUcsRUFBRSxDQUFDO1lBQ3RCLE1BQU0sWUFBWSxHQUFHLElBQUksZ0JBQU0sQ0FBQyxFQUFFLE1BQU0sRUFBRSxTQUFTLEVBQUUsQ0FBQyxDQUFDO1lBQ3ZELFlBQVksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUM7WUFDbEMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQztZQUUvQixNQUFNLEdBQUcsY0FBSSxDQUFDLFlBQVksQ0FBQyxHQUFHLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQztZQUMzQyxNQUFNLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQztZQUMxQixJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUUsMkJBQTJCLElBQUksSUFBSSxJQUFJLGVBQWUsQ0FBQyxDQUFDO1FBQ3RGLENBQUMsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsS0FBSyxJQUFJLEVBQUU7WUFDL0IsTUFBTSxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQ2pCLENBQUMsQ0FBQyxDQUFDO1FBRUgsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7O09BRUc7SUFDSCxLQUFLLENBQUMsS0FBSztRQUNULGtCQUFrQjtRQUNsQixLQUFLLE1BQU0sSUFBSSxJQUFJLElBQUksQ0FBQyxjQUFjO1lBQUUsTUFBTSxJQUFJLEVBQUUsQ0FBQyxDQUFDLHVDQUF1QztRQUU3RiwrQkFBK0I7UUFDL0IsTUFBTSxPQUFPLEdBQUcsMkJBQWdCLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUV4RCxxQkFBcUI7UUFDckIsSUFBSSxDQUFDLE9BQU8sQ0FBQyxZQUFZLElBQUksT0FBTyxDQUFDLFdBQVcsRUFBRTtZQUNoRCxNQUFNLEtBQUssR0FBRywwQkFBZSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sRUFBRSxPQUFPLENBQUMsZUFBZSxDQUFDLENBQUM7WUFDeEYsTUFBTSxJQUFBLG9CQUFTLEVBQUMsT0FBTyxDQUFDLFdBQVcsRUFBRSxLQUFLLEVBQUUsRUFBRSxRQUFRLEVBQUUsT0FBTyxFQUFFLENBQUMsQ0FBQztTQUNwRTtRQUVELE1BQU0sVUFBVSxHQUFHLElBQUksaUNBQXFCLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxVQUFVLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDN0UsTUFBTSxVQUFVLENBQUMsVUFBVSxFQUFFLENBQUM7UUFFOUIsTUFBTSxNQUFNLEdBQUcsTUFBTSxVQUFVLENBQUMsU0FBUyxFQUFFLENBQUM7UUFDNUMsS0FBSyxNQUFNLElBQUksSUFBSSxJQUFJLENBQUMsTUFBTTtZQUFFLE1BQU0sSUFBSSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsdUNBQXVDO0lBQzdGLENBQUM7SUFFRCxLQUFLLENBQUMsSUFBSTtRQUNSLEtBQUssTUFBTSxJQUFJLElBQUksSUFBSSxDQUFDLFdBQVc7WUFBRSxNQUFNLElBQUksRUFBRSxDQUFDLENBQUMsdUNBQXVDO0lBQzVGLENBQUM7Q0FDRjtBQTNJRCwrQkEySUMifQ==

package/dist/builder/collection.d.ts

@@ -1,7 +1,7 @@
-import { ActionDefinition, Operator, OperatorDefinition, PlainSortClause, RelationDefinition, SegmentDefinition, WriteDefinition } from '@forestadmin/datasource-toolkit';
+import { ActionDefinition, Operator, OperatorDefinition, PlainSortClause, SegmentDefinition, TCollectionName, TColumnName, TFieldName, TSchema, WriteDefinition } from '@forestadmin/datasource-toolkit';
 import { FieldDefinition } from './types';
 import DecoratorsStack from './decorators-stack';
-export default class CollectionBuilder {
+export default class CollectionBuilder<S extends TSchema = TSchema, N extends TCollectionName<S> = TCollectionName<S>> {
     private readonly name;
     private readonly stack;
     constructor(stack: DecoratorsStack, name: string);
@@ -14,7 +14,7 @@ export default class CollectionBuilder {
      * .importField('authorName', { path: 'author:fullName' })
      */
     importField(name: string, options: {
-        path: string;
+        path: TFieldName<S, N>;
         beforeRelations?: boolean;
     }): this;
     /**
@@ -24,14 +24,14 @@ export default class CollectionBuilder {
      * @example
      * .renameField('theCurrentNameOfTheField', 'theNewNameOfTheField');
      */
-    renameField(oldName: string, newName: string): this;
+    renameField(oldName: TColumnName<S, N>, newName: string): this;
     /**
      * Remove field by setting its visibility to false.
      * @param names the fields to remove
      * @example
      * .removeField('aFieldToRemove', 'anOtherFieldToRemove');
      */
-    removeField(...names: string[]): this;
+    removeField(...names: TColumnName<S, N>[]): this;
     /**
      * Add a new action on the collection.
      * @param name the name of the action
@@ -44,7 +44,7 @@ export default class CollectionBuilder {
      *    },
      *  })
      */
-    addAction(name: string, definition: ActionDefinition): this;
+    addAction(name: string, definition: ActionDefinition<S, N>): this;
     /**
      * Add a new field on the collection.
      * @param name the name of the field
@@ -56,19 +56,61 @@ export default class CollectionBuilder {
      *    getValues: (records) => records.map(record => `${record.lastName} ${record.firstName}`),
      * });
      */
-    addField(name: string, definition: FieldDefinition): this;
+    addField(name: string, definition: FieldDefinition<S, N>): this;
     /**
-     * Add a relation between two collections.
+     * Add a many to one relation to the collection
      * @param name name of the new relation
-     * @param definition definition of the new relation
+     * @param foreignCollection name of the targeted collection
+     * @param options extra information about the relation
      * @example
-     * .addRelation('author', {
-     *   type: 'ManyToOne',
-     *   foreignCollection: 'persons',
-     *   foreignKey: 'authorId'
-     * });
+     * books.addManyToOne('myAuthor', 'persons', { foreignKey: 'author_id' })
+     */
+    addManyToOne<T extends TCollectionName<S>>(name: string, foreignCollection: T, options: {
+        foreignKey: TColumnName<S, N>;
+        foreignKeyTarget?: TColumnName<S, T>;
+    }): this;
+    /**
+     * Add a one to many relation to the collection
+     * @param name name of the new relation
+     * @param foreignCollection name of the targeted collection
+     * @param options extra information about the relation
+     * @example
+     * persons.addOneToMany('writtenBooks', 'books', { originKey: 'author_id' })
+     */
+    addOneToMany<T extends TCollectionName<S>>(name: string, foreignCollection: T, options: {
+        originKey: TColumnName<S, T>;
+        originKeyTarget?: TColumnName<S, N>;
+    }): this;
+    /**
+     * Add a one to one relation to the collection
+     * @param name name of the new relation
+     * @param foreignCollection name of the targeted collection
+     * @param options extra information about the relation
+     * @example
+     * persons.addOneToOne('bestFriend', 'persons', { originKey: 'best_friend_id' })
      */
-    addRelation(name: string, definition: RelationDefinition): this;
+    addOneToOne<T extends TCollectionName<S>>(name: string, foreignCollection: T, options: {
+        originKey: TColumnName<S, T>;
+        originKeyTarget?: TColumnName<S, N>;
+    }): this;
+    /**
+     * Add a many to many relation to the collection
+     * @param name name of the new relation
+     * @param foreignCollection name of the targeted collection
+     * @param throughCollection name of the intermediary collection
+     * @param options extra information about the relation
+     * @example
+     * dvds.addManyToMany('rentalsOfThisDvd', 'rentals', 'dvd_rentals', {
+     *   originKey: 'dvd_id',
+     *   foreignKey: 'rental_id'
+     * })
+     */
+    addManyToMany<Foreign extends TCollectionName<S>, Through extends TCollectionName<S>>(name: string, foreignCollection: Foreign, throughCollection: Through, options: {
+        originKey: TColumnName<S, Through>;
+        foreignKey: TColumnName<S, Through>;
+        originKeyTarget?: TColumnName<S, N>;
+        foreignKeyTarget?: TColumnName<S, Foreign>;
+    }): this;
     /**
      * Add a new segment on the collection.
      * @param name the name of the segment
@@ -77,10 +119,10 @@ export default class CollectionBuilder {
      * @example
      * .addSegment(
      *    'Wrote more than 2 books',
-     *    new ConditionTreeLeaf('booksCount', 'GreaterThan', 2),
+     *    {field: 'booksCount', operator: 'GreaterThan', value: 2}
      * );
      */
-    addSegment(name: string, definition: SegmentDefinition): this;
+    addSegment(name: string, definition: SegmentDefinition<S, N>): this;
     /**
      * Enable sorting on a specific field using emulation.
      * As for all the emulation method, the field sorting will be done in-memory.
@@ -88,7 +130,7 @@ export default class CollectionBuilder {
      * @example
      * .emulateFieldSorting('fullName');
      */
-    emulateFieldSorting(name: string): this;
+    emulateFieldSorting(name: TColumnName<S, N>): this;
     /**
      * Replace an implementation for the sorting.
      * The field sorting will be done by the datasource.
@@ -103,7 +145,7 @@ export default class CollectionBuilder {
      *   ]
      * )
      */
-    replaceFieldSorting(name: string, equivalentSort: PlainSortClause[]): this;
+    replaceFieldSorting(name: TColumnName<S, N>, equivalentSort: PlainSortClause<S, N>[]): this;
     /**
      * Enable filtering on a specific field using emulation.
      * As for all the emulation method, the field filtering will be done in-memory.
@@ -111,7 +153,7 @@ export default class CollectionBuilder {
      * @example
      * .emulateFieldFiltering('aField');
      */
-    emulateFieldFiltering(name: string): this;
+    emulateFieldFiltering(name: TColumnName<S, N>): this;
     /**
      * Enable filtering on a specific field with a specific operator using emulation.
      * As for all the emulation method, the field filtering will be done in-memory.
@@ -120,7 +162,7 @@ export default class CollectionBuilder {
      * @example
      * .emulateFieldOperator('aField', 'In');
      */
-    emulateFieldOperator(name: string, operator: Operator): this;
+    emulateFieldOperator(name: TColumnName<S, N>, operator: Operator): this;
     /**
      * Replace an implementation for a specific operator on a specific field.
      * The operator replacement will be done by the datasource.
@@ -132,7 +174,7 @@ export default class CollectionBuilder {
      *   new ConditionTreeLeaf('booksCount', 'Equal', value),
      * ));
      */
-    replaceFieldOperator(name: string, operator: Operator, replacer: OperatorDefinition): this;
+    replaceFieldOperator<C extends TColumnName<S, N>>(name: C, operator: Operator, replacer: OperatorDefinition<S, N, C>): this;
     /**
      * Replace the write behavior of a field.
      * @param name the name of the field
@@ -143,6 +185,18 @@ export default class CollectionBuilder {
      *   return { firstName, lastName };
      * });
      */
-    replaceFieldWriting(name: string, definition: WriteDefinition): this;
+    replaceFieldWriting<C extends TColumnName<S, N>>(name: C, definition: WriteDefinition<S, N, C>): this;
+    /**
+     * Add a relation between two collections.
+     * @param name name of the new relation
+     * @param definition definition of the new relation
+     * @example
+     * .addRelation('author', {
+     *   type: 'ManyToOne',
+     *   foreignCollection: 'persons',
+     *   foreignKey: 'authorId'
+     * });
+     */
+    private addRelation;
 }
 //# sourceMappingURL=collection.d.ts.map

package/dist/builder/collection.js

@@ -30,11 +30,13 @@ class CollectionBuilder {
             enumValues: schema.enumValues,
         });
         for (const operator of schema.filterOperators) {
-            const handler = (value) => ({ field: options.path, operator, value });
+            const handler = value => ({ field: options.path, operator, value });
             this.replaceFieldOperator(name, operator, handler);
         }
         if (schema.isSortable) {
-            this.replaceFieldSorting(name, [{ field: options.path, ascending: true }]);
+            this.replaceFieldSorting(name, [
+                { field: options.path, ascending: true },
+            ]);
         }
         return this;
     }
@@ -74,7 +76,10 @@ class CollectionBuilder {
      *  })
      */
     addAction(name, definition) {
-        this.stack.action.getCollection(this.name).addAction(name, definition);
+        this.stack.action
+            .getCollection(this.name)
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            .addAction(name, definition);
         return this;
     }
     /**
@@ -97,18 +102,78 @@ class CollectionBuilder {
         return this;
     }
     /**
-     * Add a relation between two collections.
+     * Add a many to one relation to the collection
      * @param name name of the new relation
-     * @param definition definition of the new relation
+     * @param foreignCollection name of the targeted collection
+     * @param options extra information about the relation
      * @example
-     * .addRelation('author', {
-     *   type: 'ManyToOne',
-     *   foreignCollection: 'persons',
-     *   foreignKey: 'authorId'
-     * });
+     * books.addManyToOne('myAuthor', 'persons', { foreignKey: 'author_id' })
      */
-    addRelation(name, definition) {
-        this.stack.relation.getCollection(this.name).addRelation(name, definition);
+    addManyToOne(name, foreignCollection, options) {
+        this.addRelation(name, {
+            type: 'ManyToOne',
+            foreignCollection,
+            foreignKey: options.foreignKey,
+            foreignKeyTarget: options.foreignKeyTarget,
+        });
+        return this;
+    }
+    /**
+     * Add a one to many relation to the collection
+     * @param name name of the new relation
+     * @param foreignCollection name of the targeted collection
+     * @param options extra information about the relation
+     * @example
+     * persons.addOneToMany('writtenBooks', 'books', { originKey: 'author_id' })
+     */
+    addOneToMany(name, foreignCollection, options) {
+        this.addRelation(name, {
+            type: 'OneToMany',
+            foreignCollection,
+            originKey: options.originKey,
+            originKeyTarget: options.originKeyTarget,
+        });
+        return this;
+    }
+    /**
+     * Add a one to one relation to the collection
+     * @param name name of the new relation
+     * @param foreignCollection name of the targeted collection
+     * @param options extra information about the relation
+     * @example
+     * persons.addOneToOne('bestFriend', 'persons', { originKey: 'best_friend_id' })
+     */
+    addOneToOne(name, foreignCollection, options) {
+        this.addRelation(name, {
+            type: 'OneToOne',
+            foreignCollection,
+            originKey: options.originKey,
+            originKeyTarget: options.originKeyTarget,
+        });
+        return this;
+    }
+    /**
+     * Add a many to many relation to the collection
+     * @param name name of the new relation
+     * @param foreignCollection name of the targeted collection
+     * @param throughCollection name of the intermediary collection
+     * @param options extra information about the relation
+     * @example
+     * dvds.addManyToMany('rentalsOfThisDvd', 'rentals', 'dvd_rentals', {
+     *   originKey: 'dvd_id',
+     *   foreignKey: 'rental_id'
+     * })
+     */
+    addManyToMany(name, foreignCollection, throughCollection, options) {
+        this.addRelation(name, {
+            type: 'ManyToMany',
+            foreignCollection,
+            throughCollection,
+            originKey: options.originKey,
+            originKeyTarget: options.originKeyTarget,
+            foreignKey: options.foreignKey,
+            foreignKeyTarget: options.foreignKeyTarget,
+        });
         return this;
     }
     /**
@@ -119,7 +184,7 @@ class CollectionBuilder {
      * @example
      * .addSegment(
      *    'Wrote more than 2 books',
-     *    new ConditionTreeLeaf('booksCount', 'GreaterThan', 2),
+     *    {field: 'booksCount', operator: 'GreaterThan', value: 2}
      * );
      */
     addSegment(name, definition) {
@@ -152,7 +217,9 @@ class CollectionBuilder {
      * )
      */
     replaceFieldSorting(name, equivalentSort) {
-        this.stack.sortEmulate.getCollection(this.name).replaceFieldSorting(name, equivalentSort);
+        this.stack.sortEmulate
+            .getCollection(this.name)
+            .replaceFieldSorting(name, equivalentSort);
         return this;
     }
     /**
@@ -219,6 +286,21 @@ class CollectionBuilder {
         this.stack.write.getCollection(this.name).replaceFieldWriting(name, definition);
         return this;
     }
+    /**
+     * Add a relation between two collections.
+     * @param name name of the new relation
+     * @param definition definition of the new relation
+     * @example
+     * .addRelation('author', {
+     *   type: 'ManyToOne',
+     *   foreignCollection: 'persons',
+     *   foreignKey: 'authorId'
+     * });
+     */
+    addRelation(name, definition) {
+        this.stack.relation.getCollection(this.name).addRelation(name, definition);
+        return this;
+    }
 }
 exports.default = CollectionBuilder;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29sbGVjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9idWlsZGVyL2NvbGxlY3Rpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSx3RUFXeUM7QUFHekMseUZBQThFO0FBRTlFLE1BQXFCLGlCQUFpQjtJQUlwQyxZQUFZLEtBQXNCLEVBQUUsSUFBWTtRQUM5QyxJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQztRQUNqQixJQUFJLENBQUMsS0FBSyxHQUFHLEtBQUssQ0FBQztJQUNyQixDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNILFdBQVcsQ0FBQyxJQUFZLEVBQUUsT0FBb0Q7UUFDNUUsTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxZQUFZLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUNwRSxNQUFNLE1BQU0sR0FBRyxvQ0FBZSxDQUFDLGNBQWMsQ0FBQyxVQUFVLEVBQUUsT0FBTyxDQUFDLElBQUksQ0FBaUIsQ0FBQztRQUV4RixJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksRUFBRTtZQUNsQixlQUFlLEVBQUUsT0FBTyxDQUFDLGVBQWU7WUFDeEMsVUFBVSxFQUFFLE1BQU0sQ0FBQyxVQUFVO1lBQzdCLFlBQVksRUFBRSxNQUFNLENBQUMsWUFBWTtZQUNqQyxZQUFZLEVBQUUsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDO1lBQzVCLFNBQVMsRUFBRSxPQUFPLENBQUMsRUFBRSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxnQ0FBVyxDQUFDLGFBQWEsQ0FBQyxDQUFDLEVBQUUsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ2xGLFVBQVUsRUFBRSxNQUFNLENBQUMsVUFBVTtTQUM5QixDQUFDLENBQUM7UUFFSCxLQUFLLE1BQU0sUUFBUSxJQUFJLE1BQU0sQ0FBQyxlQUFlLEVBQUU7WUFDN0MsTUFBTSxPQUFPLEdBQUcsQ0FBQyxLQUFjLEVBQUUsRUFBRSxDQUFDLENBQUMsRUFBRSxLQUFLLEVBQUUsT0FBTyxDQUFDLElBQUksRUFBRSxRQUFRLEVBQUUsS0FBSyxFQUFFLENBQUMsQ0FBQztZQUMvRSxJQUFJLENBQUMsb0JBQW9CLENBQUMsSUFBSSxFQUFFLFFBQVEsRUFBRSxPQUFPLENBQUMsQ0FBQztTQUNwRDtRQUVELElBQUksTUFBTSxDQUFDLFVBQVUsRUFBRTtZQUNyQixJQUFJLENBQUMsbUJBQW1CLENBQUMsSUFBSSxFQUFFLENBQUMsRUFBRSxLQUFLLEVBQUUsT0FBTyxDQUFDLElBQUksRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQyxDQUFDO1NBQzVFO1FBRUQsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsV0FBVyxDQUFDLE9BQWUsRUFBRSxPQUFlO1FBQzFDLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsV0FBVyxDQUFDLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQztRQUV6RSxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILFdBQVcsQ0FBQyxHQUFHLEtBQWU7UUFDNUIsTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxXQUFXLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUNuRSxLQUFLLE1BQU0sSUFBSSxJQUFJLEtBQUs7WUFBRSxVQUFVLENBQUMscUJBQXFCLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBRXhFLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7Ozs7OztPQVdHO0lBQ0gsU0FBUyxDQUFDLElBQVksRUFBRSxVQUE0QjtRQUNsRCxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLFNBQVMsQ0FBQyxJQUFJLEVBQUUsVUFBVSxDQUFDLENBQUM7UUFFdkUsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNILFFBQVEsQ0FBQyxJQUFZLEVBQUUsVUFBMkI7UUFDaEQsTUFBTSxFQUFFLGVBQWUsRUFBRSxHQUFHLGtCQUFrQixFQUFFLEdBQUcsVUFBVSxDQUFDO1FBQzlELE1BQU0sVUFBVSxHQUFHLFVBQVUsQ0FBQyxlQUFlO1lBQzNDLENBQUMsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLGFBQWEsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQztZQUNuRCxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxZQUFZLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUVyRCxVQUFVLENBQUMsZ0JBQWdCLENBQUMsSUFBSSxFQUFFLGtCQUFrQixDQUFDLENBQUM7UUFFdEQsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNILFdBQVcsQ0FBQyxJQUFZLEVBQUUsVUFBOEI7UUFDdEQsSUFBSSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxXQUFXLENBQUMsSUFBSSxFQUFFLFVBQVUsQ0FBQyxDQUFDO1FBRTNFLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7Ozs7O09BVUc7SUFDSCxVQUFVLENBQUMsSUFBWSxFQUFFLFVBQTZCO1FBQ3BELElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsVUFBVSxDQUFDLElBQUksRUFBRSxVQUFVLENBQUMsQ0FBQztRQUV6RSxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSCxtQkFBbUIsQ0FBQyxJQUFZO1FBQzlCLElBQUksQ0FBQyxLQUFLLENBQUMsV0FBVyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsbUJBQW1CLENBQUMsSUFBSSxDQUFDLENBQUM7UUFFMUUsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7Ozs7T0FhRztJQUNILG1CQUFtQixDQUFDLElBQVksRUFBRSxjQUFpQztRQUNqRSxJQUFJLENBQUMsS0FBSyxDQUFDLFdBQVcsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLG1CQUFtQixDQUFDLElBQUksRUFBRSxjQUFjLENBQUMsQ0FBQztRQUUxRixPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSCxxQkFBcUIsQ0FBQyxJQUFZO1FBQ2hDLE1BQU0sVUFBVSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDckUsTUFBTSxLQUFLLEdBQUcsVUFBVSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFpQixDQUFDO1FBRTdELEtBQUssTUFBTSxRQUFRLElBQUksb0JBQXVCLENBQUMsb0JBQW9CLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxFQUFFO1lBQ3JGLElBQUksQ0FBQyxLQUFLLENBQUMsZUFBZSxFQUFFLEdBQUcsQ0FBQyxRQUFRLENBQUMsRUFBRTtnQkFDekMsSUFBSSxDQUFDLG9CQUFvQixDQUFDLElBQUksRUFBRSxRQUFRLENBQUMsQ0FBQzthQUMzQztTQUNGO1FBRUQsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNILG9CQUFvQixDQUFDLElBQVksRUFBRSxRQUFrQjtRQUNuRCxNQUFNLFVBQVUsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLGNBQWMsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDO1lBQ3ZGLENBQUMsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLGNBQWMsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQztZQUNwRCxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxhQUFhLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUV0RCxVQUFVLENBQUMsb0JBQW9CLENBQUMsSUFBSSxFQUFFLFFBQVEsQ0FBQyxDQUFDO1FBRWhELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7Ozs7O09BVUc7SUFDSCxvQkFBb0IsQ0FBQyxJQUFZLEVBQUUsUUFBa0IsRUFBRSxRQUE0QjtRQUNqRixNQUFNLFVBQVUsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLGNBQWMsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDO1lBQ3ZGLENBQUMsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLGNBQWMsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQztZQUNwRCxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxhQUFhLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUV0RCxVQUFVLENBQUMsb0JBQW9CLENBQUMsSUFBSSxFQUFFLFFBQVEsRUFBRSxRQUFRLENBQUMsQ0FBQztRQUUxRCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7Ozs7O09BU0c7SUFDSCxtQkFBbUIsQ0FBQyxJQUFZLEVBQUUsVUFBMkI7UUFDM0QsSUFBSSxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsVUFBVSxDQUFDLENBQUM7UUFFaEYsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0NBQ0Y7QUF6UEQsb0NBeVBDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29sbGVjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9idWlsZGVyL2NvbGxlY3Rpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSx3RUFleUM7QUFHekMseUZBQThFO0FBRTlFLE1BQXFCLGlCQUFpQjtJQU9wQyxZQUFZLEtBQXNCLEVBQUUsSUFBWTtRQUM5QyxJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQztRQUNqQixJQUFJLENBQUMsS0FBSyxHQUFHLEtBQUssQ0FBQztJQUNyQixDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNILFdBQVcsQ0FBQyxJQUFZLEVBQUUsT0FBOEQ7UUFDdEYsTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxZQUFZLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUNwRSxNQUFNLE1BQU0sR0FBRyxvQ0FBZSxDQUFDLGNBQWMsQ0FBQyxVQUFVLEVBQUUsT0FBTyxDQUFDLElBQUksQ0FBaUIsQ0FBQztRQUV4RixJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksRUFBRTtZQUNsQixlQUFlLEVBQUUsT0FBTyxDQUFDLGVBQWU7WUFDeEMsVUFBVSxFQUFFLE1BQU0sQ0FBQyxVQUFVO1lBQzdCLFlBQVksRUFBRSxNQUFNLENBQUMsWUFBWTtZQUNqQyxZQUFZLEVBQUUsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDO1lBQzVCLFNBQVMsRUFBRSxPQUFPLENBQUMsRUFBRSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxnQ0FBVyxDQUFDLGFBQWEsQ0FBQyxDQUFDLEVBQUUsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ2xGLFVBQVUsRUFBRSxNQUFNLENBQUMsVUFBVTtTQUM5QixDQUFDLENBQUM7UUFFSCxLQUFLLE1BQU0sUUFBUSxJQUFJLE1BQU0sQ0FBQyxlQUFlLEVBQUU7WUFDN0MsTUFBTSxPQUFPLEdBQUcsS0FBSyxDQUFDLEVBQUUsQ0FBQyxDQUFDLEVBQUUsS0FBSyxFQUFFLE9BQU8sQ0FBQyxJQUFJLEVBQUUsUUFBUSxFQUFFLEtBQUssRUFBRSxDQUFDLENBQUM7WUFDcEUsSUFBSSxDQUFDLG9CQUFvQixDQUN2QixJQUF3QixFQUN4QixRQUFRLEVBQ1IsT0FBbUMsQ0FDcEMsQ0FBQztTQUNIO1FBRUQsSUFBSSxNQUFNLENBQUMsVUFBVSxFQUFFO1lBQ3JCLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxJQUF3QixFQUFFO2dCQUNqRCxFQUFFLEtBQUssRUFBRSxPQUFPLENBQUMsSUFBSSxFQUFFLFNBQVMsRUFBRSxJQUFJLEVBQUU7YUFDekMsQ0FBQyxDQUFDO1NBQ0o7UUFFRCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSCxXQUFXLENBQUMsT0FBMEIsRUFBRSxPQUFlO1FBQ3JELElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsV0FBVyxDQUFDLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQztRQUV6RSxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILFdBQVcsQ0FBQyxHQUFHLEtBQTBCO1FBQ3ZDLE1BQU0sVUFBVSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsV0FBVyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDbkUsS0FBSyxNQUFNLElBQUksSUFBSSxLQUFLO1lBQUUsVUFBVSxDQUFDLHFCQUFxQixDQUFDLElBQUksRUFBRSxLQUFLLENBQUMsQ0FBQztRQUV4RSxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7T0FXRztJQUNILFNBQVMsQ0FBQyxJQUFZLEVBQUUsVUFBa0M7UUFDeEQsSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNO2FBQ2QsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUM7WUFDekIsOERBQThEO2FBQzdELFNBQVMsQ0FBQyxJQUFJLEVBQUUsVUFBd0MsQ0FBQyxDQUFDO1FBRTdELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7Ozs7O09BVUc7SUFDSCxRQUFRLENBQUMsSUFBWSxFQUFFLFVBQWlDO1FBQ3RELE1BQU0sRUFBRSxlQUFlLEVBQUUsR0FBRyxrQkFBa0IsRUFBRSxHQUFHLFVBQVUsQ0FBQztRQUM5RCxNQUFNLFVBQVUsR0FBRyxVQUFVLENBQUMsZUFBZTtZQUMzQyxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxhQUFhLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUM7WUFDbkQsQ0FBQyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsWUFBWSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFFckQsVUFBVSxDQUFDLGdCQUFnQixDQUFDLElBQUksRUFBRSxrQkFBa0IsQ0FBQyxDQUFDO1FBRXRELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDSCxZQUFZLENBQ1YsSUFBWSxFQUNaLGlCQUFvQixFQUNwQixPQUFnRjtRQUVoRixJQUFJLENBQUMsV0FBVyxDQUFDLElBQUksRUFBRTtZQUNyQixJQUFJLEVBQUUsV0FBVztZQUNqQixpQkFBaUI7WUFDakIsVUFBVSxFQUFFLE9BQU8sQ0FBQyxVQUFVO1lBQzlCLGdCQUFnQixFQUFFLE9BQU8sQ0FBQyxnQkFBZ0I7U0FDM0MsQ0FBQyxDQUFDO1FBRUgsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNILFlBQVksQ0FDVixJQUFZLEVBQ1osaUJBQW9CLEVBQ3BCLE9BQThFO1FBRTlFLElBQUksQ0FBQyxXQUFXLENBQUMsSUFBSSxFQUFFO1lBQ3JCLElBQUksRUFBRSxXQUFXO1lBQ2pCLGlCQUFpQjtZQUNqQixTQUFTLEVBQUUsT0FBTyxDQUFDLFNBQVM7WUFDNUIsZUFBZSxFQUFFLE9BQU8sQ0FBQyxlQUFlO1NBQ3pDLENBQUMsQ0FBQztRQUVILE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDSCxXQUFXLENBQ1QsSUFBWSxFQUNaLGlCQUFvQixFQUNwQixPQUE4RTtRQUU5RSxJQUFJLENBQUMsV0FBVyxDQUFDLElBQUksRUFBRTtZQUNyQixJQUFJLEVBQUUsVUFBVTtZQUNoQixpQkFBaUI7WUFDakIsU0FBUyxFQUFFLE9BQU8sQ0FBQyxTQUFTO1lBQzVCLGVBQWUsRUFBRSxPQUFPLENBQUMsZUFBZTtTQUN6QyxDQUFDLENBQUM7UUFFSCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7T0FXRztJQUNILGFBQWEsQ0FDWCxJQUFZLEVBQ1osaUJBQTBCLEVBQzFCLGlCQUEwQixFQUMxQixPQUtDO1FBRUQsSUFBSSxDQUFDLFdBQVcsQ0FBQyxJQUFJLEVBQUU7WUFDckIsSUFBSSxFQUFFLFlBQVk7WUFDbEIsaUJBQWlCO1lBQ2pCLGlCQUFpQjtZQUNqQixTQUFTLEVBQUUsT0FBTyxDQUFDLFNBQVM7WUFDNUIsZUFBZSxFQUFFLE9BQU8sQ0FBQyxlQUFlO1lBQ3hDLFVBQVUsRUFBRSxPQUFPLENBQUMsVUFBVTtZQUM5QixnQkFBZ0IsRUFBRSxPQUFPLENBQUMsZ0JBQWdCO1NBQzNDLENBQUMsQ0FBQztRQUVILE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7Ozs7O09BVUc7SUFDSCxVQUFVLENBQUMsSUFBWSxFQUFFLFVBQW1DO1FBQzFELElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsVUFBVSxDQUFDLElBQUksRUFBRSxVQUErQixDQUFDLENBQUM7UUFFOUYsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsbUJBQW1CLENBQUMsSUFBdUI7UUFDekMsSUFBSSxDQUFDLEtBQUssQ0FBQyxXQUFXLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxtQkFBbUIsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUUxRSxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7OztPQWFHO0lBQ0gsbUJBQW1CLENBQUMsSUFBdUIsRUFBRSxjQUF1QztRQUNsRixJQUFJLENBQUMsS0FBSyxDQUFDLFdBQVc7YUFDbkIsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUM7YUFDeEIsbUJBQW1CLENBQUMsSUFBSSxFQUFFLGNBQW1DLENBQUMsQ0FBQztRQUVsRSxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSCxxQkFBcUIsQ0FBQyxJQUF1QjtRQUMzQyxNQUFNLFVBQVUsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLGFBQWEsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ3JFLE1BQU0sS0FBSyxHQUFHLFVBQVUsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBaUIsQ0FBQztRQUU3RCxLQUFLLE1BQU0sUUFBUSxJQUFJLG9CQUF1QixDQUFDLG9CQUFvQixDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsRUFBRTtZQUNyRixJQUFJLENBQUMsS0FBSyxDQUFDLGVBQWUsRUFBRSxHQUFHLENBQUMsUUFBUSxDQUFDLEVBQUU7Z0JBQ3pDLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxJQUFJLEVBQUUsUUFBUSxDQUFDLENBQUM7YUFDM0M7U0FDRjtRQUVELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDSCxvQkFBb0IsQ0FBQyxJQUF1QixFQUFFLFFBQWtCO1FBQzlELE1BQU0sVUFBVSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsY0FBYyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUM7WUFDdkYsQ0FBQyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsY0FBYyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDO1lBQ3BELENBQUMsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLGFBQWEsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBRXRELFVBQVUsQ0FBQyxvQkFBb0IsQ0FBQyxJQUFJLEVBQUUsUUFBUSxDQUFDLENBQUM7UUFFaEQsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNILG9CQUFvQixDQUNsQixJQUFPLEVBQ1AsUUFBa0IsRUFDbEIsUUFBcUM7UUFFckMsTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxjQUFjLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQztZQUN2RixDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxjQUFjLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUM7WUFDcEQsQ0FBQyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFFdEQsVUFBVSxDQUFDLG9CQUFvQixDQUFDLElBQUksRUFBRSxRQUFRLEVBQUUsUUFBOEIsQ0FBQyxDQUFDO1FBRWhGLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7Ozs7T0FTRztJQUNILG1CQUFtQixDQUNqQixJQUFPLEVBQ1AsVUFBb0M7UUFFcEMsSUFBSSxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsVUFBVSxDQUFDLENBQUM7UUFFaEYsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNLLFdBQVcsQ0FBQyxJQUFZLEVBQUUsVUFBOEI7UUFDOUQsSUFBSSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxXQUFXLENBQUMsSUFBSSxFQUFFLFVBQVUsQ0FBQyxDQUFDO1FBRTNFLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztDQUNGO0FBdlhELG9DQXVYQyJ9

package/dist/builder/types.d.ts

@@ -1,5 +1,5 @@
-import { ComputedDefinition } from '@forestadmin/datasource-toolkit';
-export declare type FieldDefinition = ComputedDefinition & {
+import { ComputedDefinition, TCollectionName, TSchema } from '@forestadmin/datasource-toolkit';
+export declare type FieldDefinition<S extends TSchema = TSchema, N extends TCollectionName<S> = TCollectionName<S>> = ComputedDefinition<S, N> & {
     beforeRelations?: boolean;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/builder/utils/options-validator.d.ts

@@ -0,0 +1,13 @@
+import { AgentOptions } from '../../types';
+import { AgentOptionsWithDefaults } from '../../agent/types';
+export default class OptionsValidator {
+    private static loggerPrefix;
+    static withDefaults(options: AgentOptions): AgentOptions;
+    static validate(options: AgentOptions): AgentOptionsWithDefaults;
+    private static checkForestServerOptions;
+    private static checkAuthOptions;
+    private static checkOtherOptions;
+    private static isExistingPath;
+    private static isUrl;
+}
+//# sourceMappingURL=options-validator.d.ts.map

package/dist/builder/utils/options-validator.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
+const path_1 = require("path");
+class OptionsValidator {
+    static withDefaults(options) {
+        const copyOptions = { ...options };
+        const defaultLogger = (level, data) => {
+            const loggerLevel = options.loggerLevel ?? 'Info';
+            const levels = Object.keys(this.loggerPrefix);
+            if (levels.indexOf(level) >= levels.indexOf(loggerLevel)) {
+                console.error(OptionsValidator.loggerPrefix[level], data);
+            }
+        };
+        copyOptions.logger = copyOptions.logger || defaultLogger;
+        copyOptions.schemaPath = copyOptions.schemaPath || '.forestadmin-schema.json';
+        copyOptions.forestServerUrl = copyOptions.forestServerUrl || 'https://api.forestadmin.com';
+        copyOptions.typingsMaxDepth = copyOptions.typingsMaxDepth ?? 5;
+        const parsed = new URL(options.agentUrl);
+        copyOptions.prefix ?? (copyOptions.prefix = (0, path_1.join)('/', parsed.pathname, 'forest'));
+        return {
+            clientId: null,
+            loggerLevel: 'Info',
+            prefix: '/forest',
+            permissionsCacheDurationInSeconds: 15 * 60,
+            ...copyOptions,
+        };
+    }
+    static validate(options) {
+        OptionsValidator.checkForestServerOptions(options);
+        OptionsValidator.checkAuthOptions(options);
+        OptionsValidator.checkOtherOptions(options);
+        return options;
+    }
+    static checkForestServerOptions(options) {
+        if (typeof options.envSecret !== 'string' || !/^[0-9a-f]{64}$/.test(options.envSecret)) {
+            throw new Error('options.envSecret is invalid. You can retrieve its value from ' +
+                'https://www.forestadmin.com');
+        }
+        if (!OptionsValidator.isUrl(options.forestServerUrl)) {
+            throw new Error('options.forestServerUrl is invalid. It should contain an URL ' +
+                '(i.e. "https://api.forestadmin.com")');
+        }
+        if (!OptionsValidator.isExistingPath(options.schemaPath)) {
+            throw new Error('options.schemaPath is invalid. It should contain a relative filepath ' +
+                'where the schema should be loaded/updated (i.e. "./.forestadmin-schema.json")');
+        }
+        if (options.typingsPath && !OptionsValidator.isExistingPath(options.typingsPath)) {
+            throw new Error('options.typingsPath is invalid. It should contain a relative filepath ' +
+                'where the schema should be loaded/updated (i.e. "./src/typings.ts")');
+        }
+    }
+    static checkAuthOptions(options) {
+        if (!OptionsValidator.isUrl(options.agentUrl)) {
+            throw new Error('options.agentUrl is invalid. It should contain an url where your agent is reachable ' +
+                '(i.e. "https://api-forestadmin.mycompany.com")');
+        }
+        if (typeof options.authSecret !== 'string') {
+            throw new Error('options.authSecret is invalid. Any long random string should work ' +
+                '(i.e. "OfpssLrbgF3P4vHJTTpb"');
+        }
+        if (options.clientId === null) {
+            options.logger?.('Warn', 'options.clientId was not provided. Using Node.js cluster mode, ' +
+                'or multiple instances of the agent will break authentication');
+        }
+        else if (typeof options.clientId !== 'string') {
+            throw new Error('options.clientId is invalid.');
+        }
+    }
+    static checkOtherOptions(options) {
+        if (typeof options.prefix !== 'string' || !/[-/a-z+]/.test(options.prefix)) {
+            throw new Error('options.prefix is invalid. It should contain the prefix on which ' +
+                'forest admin routes should be mounted (i.e. "/forest")');
+        }
+    }
+    static isExistingPath(string) {
+        if (typeof string !== 'string') {
+            return false;
+        }
+        const parsed = (0, path_1.parse)(string);
+        return parsed.dir.length ? (0, fs_1.existsSync)(parsed.dir) : true;
+    }
+    static isUrl(string) {
+        if (typeof string !== 'string') {
+            return false;
+        }
+        try {
+            const url = new URL(string);
+            return url.protocol === 'http:' || url.protocol === 'https:';
+        }
+        catch (_) {
+            return false;
+        }
+    }
+}
+exports.default = OptionsValidator;
+OptionsValidator.loggerPrefix = {
+    Debug: '\x1b[34mdebug:\x1b[0m',
+    Info: '\x1b[32minfo:\x1b[0m',
+    Warn: '\x1b[33mwarning:\x1b[0m',
+    Error: '\x1b[31merror:\x1b[0m',
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3B0aW9ucy12YWxpZGF0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvYnVpbGRlci91dGlscy9vcHRpb25zLXZhbGlkYXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDJCQUFnQztBQUNoQywrQkFBNEQ7QUFLNUQsTUFBcUIsZ0JBQWdCO0lBUW5DLE1BQU0sQ0FBQyxZQUFZLENBQUMsT0FBcUI7UUFDdkMsTUFBTSxXQUFXLEdBQUcsRUFBRSxHQUFHLE9BQU8sRUFBRSxDQUFDO1FBRW5DLE1BQU0sYUFBYSxHQUFHLENBQUMsS0FBSyxFQUFFLElBQUksRUFBRSxFQUFFO1lBQ3BDLE1BQU0sV0FBVyxHQUFHLE9BQU8sQ0FBQyxXQUFXLElBQUksTUFBTSxDQUFDO1lBQ2xELE1BQU0sTUFBTSxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxDQUFDO1lBRTlDLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsSUFBSSxNQUFNLENBQUMsT0FBTyxDQUFDLFdBQVcsQ0FBQyxFQUFFO2dCQUN4RCxPQUFPLENBQUMsS0FBSyxDQUFDLGdCQUFnQixDQUFDLFlBQVksQ0FBQyxLQUFLLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQzthQUMzRDtRQUNILENBQUMsQ0FBQztRQUVGLFdBQVcsQ0FBQyxNQUFNLEdBQUcsV0FBVyxDQUFDLE1BQU0sSUFBSSxhQUFhLENBQUM7UUFDekQsV0FBVyxDQUFDLFVBQVUsR0FBRyxXQUFXLENBQUMsVUFBVSxJQUFJLDBCQUEwQixDQUFDO1FBQzlFLFdBQVcsQ0FBQyxlQUFlLEdBQUcsV0FBVyxDQUFDLGVBQWUsSUFBSSw2QkFBNkIsQ0FBQztRQUMzRixXQUFXLENBQUMsZUFBZSxHQUFHLFdBQVcsQ0FBQyxlQUFlLElBQUksQ0FBQyxDQUFDO1FBRS9ELE1BQU0sTUFBTSxHQUFHLElBQUksR0FBRyxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUN6QyxXQUFXLENBQUMsTUFBTSxLQUFsQixXQUFXLENBQUMsTUFBTSxHQUFLLElBQUEsV0FBUSxFQUFDLEdBQUcsRUFBRSxNQUFNLENBQUMsUUFBUSxFQUFFLFFBQVEsQ0FBQyxFQUFDO1FBRWhFLE9BQU87WUFDTCxRQUFRLEVBQUUsSUFBSTtZQUNkLFdBQVcsRUFBRSxNQUFNO1lBQ25CLE1BQU0sRUFBRSxTQUFTO1lBQ2pCLGlDQUFpQyxFQUFFLEVBQUUsR0FBRyxFQUFFO1lBQzFDLEdBQUcsV0FBVztTQUNmLENBQUM7SUFDSixDQUFDO0lBRUQsTUFBTSxDQUFDLFFBQVEsQ0FBQyxPQUFxQjtRQUNuQyxnQkFBZ0IsQ0FBQyx3QkFBd0IsQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUNuRCxnQkFBZ0IsQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUMzQyxnQkFBZ0IsQ0FBQyxpQkFBaUIsQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUU1QyxPQUFPLE9BQW1DLENBQUM7SUFDN0MsQ0FBQztJQUVPLE1BQU0sQ0FBQyx3QkFBd0IsQ0FBQyxPQUFxQjtRQUMzRCxJQUFJLE9BQU8sT0FBTyxDQUFDLFNBQVMsS0FBSyxRQUFRLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFO1lBQ3RGLE1BQU0sSUFBSSxLQUFLLENBQ2IsZ0VBQWdFO2dCQUM5RCw2QkFBNkIsQ0FDaEMsQ0FBQztTQUNIO1FBRUQsSUFBSSxDQUFDLGdCQUFnQixDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsZUFBZSxDQUFDLEVBQUU7WUFDcEQsTUFBTSxJQUFJLEtBQUssQ0FDYiwrREFBK0Q7Z0JBQzdELHNDQUFzQyxDQUN6QyxDQUFDO1NBQ0g7UUFFRCxJQUFJLENBQUMsZ0JBQWdCLENBQUMsY0FBYyxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsRUFBRTtZQUN4RCxNQUFNLElBQUksS0FBSyxDQUNiLHVFQUF1RTtnQkFDckUsK0VBQStFLENBQ2xGLENBQUM7U0FDSDtRQUVELElBQUksT0FBTyxDQUFDLFdBQVcsSUFBSSxDQUFDLGdCQUFnQixDQUFDLGNBQWMsQ0FBQyxPQUFPLENBQUMsV0FBVyxDQUFDLEVBQUU7WUFDaEYsTUFBTSxJQUFJLEtBQUssQ0FDYix3RUFBd0U7Z0JBQ3RFLHFFQUFxRSxDQUN4RSxDQUFDO1NBQ0g7SUFDSCxDQUFDO0lBRU8sTUFBTSxDQUFDLGdCQUFnQixDQUFDLE9BQXFCO1FBQ25ELElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxFQUFFO1lBQzdDLE1BQU0sSUFBSSxLQUFLLENBQ2Isc0ZBQXNGO2dCQUNwRixnREFBZ0QsQ0FDbkQsQ0FBQztTQUNIO1FBRUQsSUFBSSxPQUFPLE9BQU8sQ0FBQyxVQUFVLEtBQUssUUFBUSxFQUFFO1lBQzFDLE1BQU0sSUFBSSxLQUFLLENBQ2Isb0VBQW9FO2dCQUNsRSw4QkFBOEIsQ0FDakMsQ0FBQztTQUNIO1FBRUQsSUFBSSxPQUFPLENBQUMsUUFBUSxLQUFLLElBQUksRUFBRTtZQUM3QixPQUFPLENBQUMsTUFBTSxFQUFFLENBQ2QsTUFBTSxFQUNOLGlFQUFpRTtnQkFDL0QsOERBQThELENBQ2pFLENBQUM7U0FDSDthQUFNLElBQUksT0FBTyxPQUFPLENBQUMsUUFBUSxLQUFLLFFBQVEsRUFBRTtZQUMvQyxNQUFNLElBQUksS0FBSyxDQUFDLDhCQUE4QixDQUFDLENBQUM7U0FDakQ7SUFDSCxDQUFDO0lBRU8sTUFBTSxDQUFDLGlCQUFpQixDQUFDLE9BQXFCO1FBQ3BELElBQUksT0FBTyxPQUFPLENBQUMsTUFBTSxLQUFLLFFBQVEsSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFO1lBQzFFLE1BQU0sSUFBSSxLQUFLLENBQ2IsbUVBQW1FO2dCQUNqRSx3REFBd0QsQ0FDM0QsQ0FBQztTQUNIO0lBQ0gsQ0FBQztJQUVPLE1BQU0sQ0FBQyxjQUFjLENBQUMsTUFBZTtRQUMzQyxJQUFJLE9BQU8sTUFBTSxLQUFLLFFBQVEsRUFBRTtZQUM5QixPQUFPLEtBQUssQ0FBQztTQUNkO1FBRUQsTUFBTSxNQUFNLEdBQUcsSUFBQSxZQUFTLEVBQUMsTUFBTSxDQUFDLENBQUM7UUFFakMsT0FBTyxNQUFNLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsSUFBQSxlQUFVLEVBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUM7SUFDM0QsQ0FBQztJQUVPLE1BQU0sQ0FBQyxLQUFLLENBQUMsTUFBZTtRQUNsQyxJQUFJLE9BQU8sTUFBTSxLQUFLLFFBQVEsRUFBRTtZQUM5QixPQUFPLEtBQUssQ0FBQztTQUNkO1FBRUQsSUFBSTtZQUNGLE1BQU0sR0FBRyxHQUFHLElBQUksR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBRTVCLE9BQU8sR0FBRyxDQUFDLFFBQVEsS0FBSyxPQUFPLElBQUksR0FBRyxDQUFDLFFBQVEsS0FBSyxRQUFRLENBQUM7U0FDOUQ7UUFBQyxPQUFPLENBQUMsRUFBRTtZQUNWLE9BQU8sS0FBSyxDQUFDO1NBQ2Q7SUFDSCxDQUFDOztBQXBJSCxtQ0FxSUM7QUFwSWdCLDZCQUFZLEdBQUc7SUFDNUIsS0FBSyxFQUFFLHVCQUF1QjtJQUM5QixJQUFJLEVBQUUsc0JBQXNCO0lBQzVCLElBQUksRUFBRSx5QkFBeUI7SUFDL0IsS0FBSyxFQUFFLHVCQUF1QjtDQUMvQixDQUFDIn0=

package/dist/builder/utils/typing-generator.d.ts

@@ -0,0 +1,10 @@
+import { DataSource } from '@forestadmin/datasource-toolkit';
+export default class TypingGenerator {
+    static generateTypes(dataSource: DataSource, maxDepth: number): string;
+    private static getRow;
+    private static getRelations;
+    private static getFlatRelations;
+    private static getFieldsRec;
+    private static getType;
+}
+//# sourceMappingURL=typing-generator.d.ts.map

package/dist/builder/utils/typing-generator.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const datasource_toolkit_1 = require("@forestadmin/datasource-toolkit");
+class TypingGenerator {
+    static generateTypes(dataSource, maxDepth) {
+        const collections = [...dataSource.collections].sort((a, b) => a.name.localeCompare(b.name));
+        return [
+            `/* eslint-disable */`,
+            'export type Schema = {',
+            ...collections.map(collection => [
+                `  ${collection.name}: {`,
+                this.getRow(collection),
+                this.getRelations(collection),
+                this.getFlatRelations(collection, maxDepth),
+                '  };',
+            ].join(`\n`)),
+            '};\n',
+        ].join('\n');
+    }
+    static getRow(collection) {
+        const content = Object.entries(collection.schema.fields).reduce((memo, [name, field]) => {
+            return field.type === 'Column' ? [...memo, `      ${name}: ${this.getType(field)};`] : memo;
+        }, []);
+        return `    plain: {\n${content.join('\n')}\n    };`;
+    }
+    static getRelations(collection) {
+        const content = Object.entries(collection.schema.fields).reduce((memo, [name, field]) => {
+            if (field.type === 'ManyToOne' || field.type === 'OneToOne') {
+                const relation = field.foreignCollection;
+                return [
+                    ...memo,
+                    `      ${name}: Schema['${relation}']['plain'] & Schema['${relation}']['nested'];`,
+                ];
+            }
+            return memo;
+        }, []);
+        return content.length ? `    nested: {\n${content.join('\n')}\n    };` : `    nested: {};`;
+    }
+    static getFlatRelations(collection, maxDepth) {
+        const fields = this.getFieldsRec(collection, maxDepth, []);
+        return fields.length
+            ? `    flat: {\n      ${fields.join('\n      ')}\n    };`
+            : `    flat: {};`;
+    }
+    static getFieldsRec(collection, maxDepth, traversed) {
+        const columns = traversed.length > 0
+            ? Object.entries(collection.schema.fields)
+                .filter(([, schema]) => schema.type === 'Column')
+                .map(([name, schema]) => `'${name}': ${this.getType(schema)};`)
+            : [];
+        const relations = Object.entries(collection.schema.fields).reduce((memo, [name, schema]) => {
+            if (schema.type !== 'ManyToOne' && schema.type !== 'OneToOne')
+                return memo;
+            const subCollection = collection.dataSource.getCollection(schema.foreignCollection);
+            const inverse = datasource_toolkit_1.CollectionUtils.getInverseRelation(collection, name);
+            // Do not expand inverse relations, as those create useless cycles
+            const expand = traversed.length < maxDepth &&
+                !traversed.find(({ c, r }) => c === subCollection && r === inverse);
+            if (!expand)
+                return memo;
+            // Manually expand the field type (cycles are not allowed in template literal types)
+            return [
+                ...memo,
+                ...this.getFieldsRec(subCollection, maxDepth, [
+                    ...traversed,
+                    { c: collection, r: name },
+                ]).map(f => `'${name}:${f.slice(1)}`),
+            ];
+        }, []);
+        return [...columns, ...relations];
+    }
+    static getType(field) {
+        if (Array.isArray(field.columnType)) {
+            return `Array<${this.getType({ columnType: field.columnType[0] })}>`;
+        }
+        if (field.columnType === 'Enum') {
+            return field.enumValues.map(v => `'${v.replace(/'/g, "\\'")}'`).join(' | ');
+        }
+        if (typeof field.columnType === 'string') {
+            return {
+                Boolean: 'boolean',
+                Date: 'string',
+                Dateonly: 'string',
+                Json: 'any',
+                Number: 'number',
+                Point: '[number, number]',
+                String: 'string',
+                Timeonly: 'string',
+                Uuid: 'string',
+            }[field.columnType];
+        }
+        return `{${Object.entries(field.columnType)
+            .map(([key, subType]) => `${key}: ${this.getType({ columnType: subType })}`)
+            .join('; ')}}`;
+    }
+}
+exports.default = TypingGenerator;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwaW5nLWdlbmVyYXRvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9idWlsZGVyL3V0aWxzL3R5cGluZy1nZW5lcmF0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSx3RUFNeUM7QUFFekMsTUFBcUIsZUFBZTtJQUNsQyxNQUFNLENBQUMsYUFBYSxDQUFDLFVBQXNCLEVBQUUsUUFBZ0I7UUFDM0QsTUFBTSxXQUFXLEdBQUcsQ0FBQyxHQUFHLFVBQVUsQ0FBQyxXQUFXLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztRQUU3RixPQUFPO1lBQ0wsc0JBQXNCO1lBQ3RCLHdCQUF3QjtZQUN4QixHQUFHLFdBQVcsQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLEVBQUUsQ0FDOUI7Z0JBQ0UsS0FBSyxVQUFVLENBQUMsSUFBSSxLQUFLO2dCQUN6QixJQUFJLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQztnQkFDdkIsSUFBSSxDQUFDLFlBQVksQ0FBQyxVQUFVLENBQUM7Z0JBQzdCLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxVQUFVLEVBQUUsUUFBUSxDQUFDO2dCQUMzQyxNQUFNO2FBQ1AsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQ2I7WUFDRCxNQUFNO1NBQ1AsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDZixDQUFDO0lBRU8sTUFBTSxDQUFDLE1BQU0sQ0FBQyxVQUFzQjtRQUMxQyxNQUFNLE9BQU8sR0FBRyxNQUFNLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxFQUFFLEVBQUU7WUFDdEYsT0FBTyxLQUFLLENBQUMsSUFBSSxLQUFLLFFBQVEsQ0FBQyxDQUFDLENBQUMsQ0FBQyxHQUFHLElBQUksRUFBRSxTQUFTLElBQUksS0FBSyxJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDO1FBQzlGLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQztRQUVQLE9BQU8saUJBQWlCLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQztJQUN2RCxDQUFDO0lBRU8sTUFBTSxDQUFDLFlBQVksQ0FBQyxVQUFzQjtRQUNoRCxNQUFNLE9BQU8sR0FBRyxNQUFNLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxFQUFFLEVBQUU7WUFDdEYsSUFBSSxLQUFLLENBQUMsSUFBSSxLQUFLLFdBQVcsSUFBSSxLQUFLLENBQUMsSUFBSSxLQUFLLFVBQVUsRUFBRTtnQkFDM0QsTUFBTSxRQUFRLEdBQUcsS0FBSyxDQUFDLGlCQUFpQixDQUFDO2dCQUV6QyxPQUFPO29CQUNMLEdBQUcsSUFBSTtvQkFDUCxTQUFTLElBQUksYUFBYSxRQUFRLHlCQUF5QixRQUFRLGVBQWU7aUJBQ25GLENBQUM7YUFDSDtZQUVELE9BQU8sSUFBSSxDQUFDO1FBQ2QsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBRVAsT0FBTyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxrQkFBa0IsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQztJQUM3RixDQUFDO0lBRU8sTUFBTSxDQUFDLGdCQUFnQixDQUFDLFVBQXNCLEVBQUUsUUFBZ0I7UUFDdEUsTUFBTSxNQUFNLEdBQUcsSUFBSSxDQUFDLFlBQVksQ0FBQyxVQUFVLEVBQUUsUUFBUSxFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBRTNELE9BQU8sTUFBTSxDQUFDLE1BQU07WUFDbEIsQ0FBQyxDQUFDLHNCQUFzQixNQUFNLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxVQUFVO1lBQ3pELENBQUMsQ0FBQyxlQUFlLENBQUM7SUFDdEIsQ0FBQztJQUVPLE1BQU0sQ0FBQyxZQUFZLENBQ3pCLFVBQXNCLEVBQ3RCLFFBQWdCLEVBQ2hCLFNBQXlDO1FBRXpDLE1BQU0sT0FBTyxHQUNYLFNBQVMsQ0FBQyxNQUFNLEdBQUcsQ0FBQztZQUNsQixDQUFDLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQztpQkFDckMsTUFBTSxDQUFDLENBQUMsQ0FBQyxFQUFFLE1BQU0sQ0FBQyxFQUFFLEVBQUUsQ0FBQyxNQUFNLENBQUMsSUFBSSxLQUFLLFFBQVEsQ0FBQztpQkFDaEQsR0FBRyxDQUFDLENBQUMsQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLEVBQUUsRUFBRSxDQUFDLElBQUksSUFBSSxNQUFNLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBc0IsQ0FBQyxHQUFHLENBQUM7WUFDbkYsQ0FBQyxDQUFDLEVBQUUsQ0FBQztRQUVULE1BQU0sU0FBUyxHQUFHLE1BQU0sQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLEVBQUUsRUFBRTtZQUN6RixJQUFJLE1BQU0sQ0FBQyxJQUFJLEtBQUssV0FBVyxJQUFJLE1BQU0sQ0FBQyxJQUFJLEtBQUssVUFBVTtnQkFBRSxPQUFPLElBQUksQ0FBQztZQUUzRSxNQUFNLGFBQWEsR0FBRyxVQUFVLENBQUMsVUFBVSxDQUFDLGFBQWEsQ0FBQyxNQUFNLENBQUMsaUJBQWlCLENBQUMsQ0FBQztZQUNwRixNQUFNLE9BQU8sR0FBRyxvQ0FBZSxDQUFDLGtCQUFrQixDQUFDLFVBQVUsRUFBRSxJQUFJLENBQUMsQ0FBQztZQUVyRSxrRUFBa0U7WUFDbEUsTUFBTSxNQUFNLEdBQ1YsU0FBUyxDQUFDLE1BQU0sR0FBRyxRQUFRO2dCQUMzQixDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDLEVBQUUsRUFBRSxFQUFFLENBQUMsQ0FBQyxLQUFLLGFBQWEsSUFBSSxDQUFDLEtBQUssT0FBTyxDQUFDLENBQUM7WUFDdEUsSUFBSSxDQUFDLE1BQU07Z0JBQUUsT0FBTyxJQUFJLENBQUM7WUFFekIsb0ZBQW9GO1lBQ3BGLE9BQU87Z0JBQ0wsR0FBRyxJQUFJO2dCQUNQLEdBQUcsSUFBSSxDQUFDLFlBQVksQ0FBQyxhQUFhLEVBQUUsUUFBUSxFQUFFO29CQUM1QyxHQUFHLFNBQVM7b0JBQ1osRUFBRSxDQUFDLEVBQUUsVUFBVSxFQUFFLENBQUMsRUFBRSxJQUFJLEVBQUU7aUJBQzNCLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxJQUFJLElBQUksSUFBSSxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUM7YUFDdEMsQ0FBQztRQUNKLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQztRQUVQLE9BQU8sQ0FBQyxHQUFHLE9BQU8sRUFBRSxHQUFHLFNBQVMsQ0FBQyxDQUFDO0lBQ3BDLENBQUM7SUFFTyxNQUFNLENBQUMsT0FBTyxDQUFDLEtBQXdEO1FBQzdFLElBQUksS0FBSyxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLEVBQUU7WUFDbkMsT0FBTyxTQUFTLElBQUksQ0FBQyxPQUFPLENBQUMsRUFBRSxVQUFVLEVBQUUsS0FBSyxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLEdBQUcsQ0FBQztTQUN0RTtRQUVELElBQUksS0FBSyxDQUFDLFVBQVUsS0FBSyxNQUFNLEVBQUU7WUFDL0IsT0FBTyxLQUFLLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQztTQUM3RTtRQUVELElBQUksT0FBTyxLQUFLLENBQUMsVUFBVSxLQUFLLFFBQVEsRUFBRTtZQUN4QyxPQUFPO2dCQUNMLE9BQU8sRUFBRSxTQUFTO2dCQUNsQixJQUFJLEVBQUUsUUFBUTtnQkFDZCxRQUFRLEVBQUUsUUFBUTtnQkFDbEIsSUFBSSxFQUFFLEtBQUs7Z0JBQ1gsTUFBTSxFQUFFLFFBQVE7Z0JBQ2hCLEtBQUssRUFBRSxrQkFBa0I7Z0JBQ3pCLE1BQU0sRUFBRSxRQUFRO2dCQUNoQixRQUFRLEVBQUUsUUFBUTtnQkFDbEIsSUFBSSxFQUFFLFFBQVE7YUFDZixDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQztTQUNyQjtRQUVELE9BQU8sSUFBSSxNQUFNLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUM7YUFDeEMsR0FBRyxDQUFDLENBQUMsQ0FBQyxHQUFHLEVBQUUsT0FBTyxDQUFDLEVBQUUsRUFBRSxDQUFDLEdBQUcsR0FBRyxLQUFLLElBQUksQ0FBQyxPQUFPLENBQUMsRUFBRSxVQUFVLEVBQUUsT0FBTyxFQUFFLENBQUMsRUFBRSxDQUFDO2FBQzNFLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDO0lBQ25CLENBQUM7Q0FDRjtBQXJIRCxrQ0FxSEMifQ==

package/dist/index.d.ts

@@ -1,7 +1,8 @@
+import { TSchema } from '@forestadmin/datasource-toolkit';
 import { AgentOptions } from './types';
 import Agent from './builder/agent';
 export { default as Collection } from './builder/collection';
 export { Agent };
 export * from './types';
-export declare function createAgent(agentoptions: AgentOptions): Agent;
+export declare function createAgent<S extends TSchema = TSchema>(options: AgentOptions): Agent<S>;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -23,8 +23,8 @@ exports.Agent = agent_1.default;
 var collection_1 = require("./builder/collection");
 Object.defineProperty(exports, "Collection", { enumerable: true, get: function () { return __importDefault(collection_1).default; } });
 __exportStar(require("./types"), exports);
-function createAgent(agentoptions) {
-    return new agent_1.default(agentoptions);
+function createAgent(options) {
+    return new agent_1.default(options);
 }
 exports.createAgent = createAgent;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFDQSw0REFBb0M7QUFHM0IsZ0JBSEYsZUFBSyxDQUdFO0FBRGQsbURBQTZEO0FBQXBELHlIQUFBLE9BQU8sT0FBYztBQUU5QiwwQ0FBd0I7QUFFeEIsU0FBZ0IsV0FBVyxDQUFDLFlBQTBCO0lBQ3BELE9BQU8sSUFBSSxlQUFLLENBQUMsWUFBWSxDQUFDLENBQUM7QUFDakMsQ0FBQztBQUZELGtDQUVDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFHQSw0REFBb0M7QUFHM0IsZ0JBSEYsZUFBSyxDQUdFO0FBRGQsbURBQTZEO0FBQXBELHlIQUFBLE9BQU8sT0FBYztBQUU5QiwwQ0FBd0I7QUFFeEIsU0FBZ0IsV0FBVyxDQUE4QixPQUFxQjtJQUM1RSxPQUFPLElBQUksZUFBSyxDQUFJLE9BQU8sQ0FBQyxDQUFDO0FBQy9CLENBQUM7QUFGRCxrQ0FFQyJ9

package/dist/types.d.ts

@@ -11,6 +11,8 @@ export declare type AgentOptions = {
     prefix?: string;
     isProduction: boolean;
     schemaPath?: string;
+    typingsPath?: string;
+    typingsMaxDepth?: number;
     permissionsCacheDurationInSeconds?: number;
 };
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forestadmin/agent",
-  "version": "1.0.0-beta.24",
+  "version": "1.0.0-beta.27",
   "main": "dist/index.js",
   "license": "GPL-3.0",
   "publishConfig": {
@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@fast-csv/format": "^4.3.5",
-    "@forestadmin/datasource-toolkit": "1.0.0-beta.15",
+    "@forestadmin/datasource-toolkit": "1.0.0-beta.16",
     "@koa/cors": "^3.3.0",
     "@koa/router": "^10.1.1",
     "forest-ip-utils": "^1.0.1",

package/dist/agent/utils/http-driver-options.d.ts

@@ -1,13 +0,0 @@
-import { AgentOptions } from '../../types';
-import { AgentOptionsWithDefaults } from '../types';
-export default class OptionsUtils {
-    private static loggerPrefix;
-    static withDefaults(options: AgentOptions): AgentOptionsWithDefaults;
-    static validate(options: AgentOptionsWithDefaults): void;
-    private static checkForestServerOptions;
-    private static checkAuthOptions;
-    private static checkOtherOptions;
-    private static isExistingPath;
-    private static isUrl;
-}
-//# sourceMappingURL=http-driver-options.d.ts.map

package/dist/agent/utils/http-driver-options.js

@@ -1,95 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = require("fs");
-const path_1 = require("path");
-class OptionsUtils {
-    static withDefaults(options) {
-        const copyOptions = { ...options };
-        const defaultLogger = (level, data) => {
-            const loggerLevel = options.loggerLevel ?? 'Info';
-            const levels = Object.keys(this.loggerPrefix);
-            if (levels.indexOf(level) >= levels.indexOf(loggerLevel)) {
-                console.error(OptionsUtils.loggerPrefix[level], data);
-            }
-        };
-        copyOptions.logger = copyOptions.logger || defaultLogger;
-        copyOptions.schemaPath = copyOptions.schemaPath || '.forestadmin-schema.json';
-        copyOptions.forestServerUrl = copyOptions.forestServerUrl || 'https://api.forestadmin.com';
-        return Object.freeze({
-            clientId: null,
-            loggerLevel: 'Info',
-            prefix: '/forest',
-            permissionsCacheDurationInSeconds: 15 * 60,
-            ...copyOptions,
-        });
-    }
-    static validate(options) {
-        OptionsUtils.checkForestServerOptions(options);
-        OptionsUtils.checkAuthOptions(options);
-        OptionsUtils.checkOtherOptions(options);
-    }
-    static checkForestServerOptions(options) {
-        if (typeof options.envSecret !== 'string' || !/^[0-9a-f]{64}$/.test(options.envSecret)) {
-            throw new Error('options.envSecret is invalid. You can retrieve its value from ' +
-                'https://www.forestadmin.com');
-        }
-        if (!OptionsUtils.isUrl(options.forestServerUrl)) {
-            throw new Error('options.forestServerUrl is invalid. It should contain an URL ' +
-                '(i.e. "https://api.forestadmin.com")');
-        }
-        if (!OptionsUtils.isExistingPath(options.schemaPath)) {
-            throw new Error('options.schemaPath is invalid. It should contain a relative filepath ' +
-                'where the schema should be loaded/updated (i.e. "./.forestadmin-schema.json")');
-        }
-    }
-    static checkAuthOptions(options) {
-        if (!OptionsUtils.isUrl(options.agentUrl)) {
-            throw new Error('options.agentUrl is invalid. It should contain an url where your agent is reachable ' +
-                '(i.e. "https://api-forestadmin.mycompany.com")');
-        }
-        if (typeof options.authSecret !== 'string') {
-            throw new Error('options.authSecret is invalid. Any long random string should work ' +
-                '(i.e. "OfpssLrbgF3P4vHJTTpb"');
-        }
-        if (options.clientId === null) {
-            options.logger?.('Warn', 'options.clientId was not provided. Using Node.js cluster mode, ' +
-                'or multiple instances of the agent will break authentication');
-        }
-        else if (typeof options.clientId !== 'string') {
-            throw new Error('options.clientId is invalid.');
-        }
-    }
-    static checkOtherOptions(options) {
-        if (typeof options.prefix !== 'string' || !/[-/a-z+]/.test(options.prefix)) {
-            throw new Error('options.prefix is invalid. It should contain the prefix on which ' +
-                'forest admin routes should be mounted (i.e. "/forest")');
-        }
-    }
-    static isExistingPath(string) {
-        if (typeof string !== 'string') {
-            return false;
-        }
-        const parsed = (0, path_1.parse)(string);
-        return parsed.dir.length ? (0, fs_1.existsSync)(parsed.dir) : true;
-    }
-    static isUrl(string) {
-        if (typeof string !== 'string') {
-            return false;
-        }
-        try {
-            const url = new URL(string);
-            return url.protocol === 'http:' || url.protocol === 'https:';
-        }
-        catch (_) {
-            return false;
-        }
-    }
-}
-exports.default = OptionsUtils;
-OptionsUtils.loggerPrefix = {
-    Debug: '\x1b[34mdebug:\x1b[0m',
-    Info: '\x1b[32minfo:\x1b[0m',
-    Warn: '\x1b[33mwarning:\x1b[0m',
-    Error: '\x1b[31merror:\x1b[0m',
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaHR0cC1kcml2ZXItb3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9hZ2VudC91dGlscy9odHRwLWRyaXZlci1vcHRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsMkJBQWdDO0FBQ2hDLCtCQUEwQztBQUsxQyxNQUFxQixZQUFZO0lBUS9CLE1BQU0sQ0FBQyxZQUFZLENBQUMsT0FBcUI7UUFDdkMsTUFBTSxXQUFXLEdBQUcsRUFBRSxHQUFHLE9BQU8sRUFBRSxDQUFDO1FBRW5DLE1BQU0sYUFBYSxHQUFHLENBQUMsS0FBSyxFQUFFLElBQUksRUFBRSxFQUFFO1lBQ3BDLE1BQU0sV0FBVyxHQUFHLE9BQU8sQ0FBQyxXQUFXLElBQUksTUFBTSxDQUFDO1lBQ2xELE1BQU0sTUFBTSxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxDQUFDO1lBRTlDLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsSUFBSSxNQUFNLENBQUMsT0FBTyxDQUFDLFdBQVcsQ0FBQyxFQUFFO2dCQUN4RCxPQUFPLENBQUMsS0FBSyxDQUFDLFlBQVksQ0FBQyxZQUFZLENBQUMsS0FBSyxDQUFDLEVBQUUsSUFBSSxDQUFDLENBQUM7YUFDdkQ7UUFDSCxDQUFDLENBQUM7UUFFRixXQUFXLENBQUMsTUFBTSxHQUFHLFdBQVcsQ0FBQyxNQUFNLElBQUksYUFBYSxDQUFDO1FBQ3pELFdBQVcsQ0FBQyxVQUFVLEdBQUcsV0FBVyxDQUFDLFVBQVUsSUFBSSwwQkFBMEIsQ0FBQztRQUM5RSxXQUFXLENBQUMsZUFBZSxHQUFHLFdBQVcsQ0FBQyxlQUFlLElBQUksNkJBQTZCLENBQUM7UUFFM0YsT0FBaUMsTUFBTSxDQUFDLE1BQU0sQ0FBQztZQUM3QyxRQUFRLEVBQUUsSUFBSTtZQUNkLFdBQVcsRUFBRSxNQUFNO1lBQ25CLE1BQU0sRUFBRSxTQUFTO1lBQ2pCLGlDQUFpQyxFQUFFLEVBQUUsR0FBRyxFQUFFO1lBQzFDLEdBQUcsV0FBVztTQUNmLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRCxNQUFNLENBQUMsUUFBUSxDQUFDLE9BQWlDO1FBQy9DLFlBQVksQ0FBQyx3QkFBd0IsQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUMvQyxZQUFZLENBQUMsZ0JBQWdCLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDdkMsWUFBWSxDQUFDLGlCQUFpQixDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQzFDLENBQUM7SUFFTyxNQUFNLENBQUMsd0JBQXdCLENBQUMsT0FBaUM7UUFDdkUsSUFBSSxPQUFPLE9BQU8sQ0FBQyxTQUFTLEtBQUssUUFBUSxJQUFJLENBQUMsZ0JBQWdCLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRTtZQUN0RixNQUFNLElBQUksS0FBSyxDQUNiLGdFQUFnRTtnQkFDOUQsNkJBQTZCLENBQ2hDLENBQUM7U0FDSDtRQUVELElBQUksQ0FBQyxZQUFZLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxlQUFlLENBQUMsRUFBRTtZQUNoRCxNQUFNLElBQUksS0FBSyxDQUNiLCtEQUErRDtnQkFDN0Qsc0NBQXNDLENBQ3pDLENBQUM7U0FDSDtRQUVELElBQUksQ0FBQyxZQUFZLENBQUMsY0FBYyxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsRUFBRTtZQUNwRCxNQUFNLElBQUksS0FBSyxDQUNiLHVFQUF1RTtnQkFDckUsK0VBQStFLENBQ2xGLENBQUM7U0FDSDtJQUNILENBQUM7SUFFTyxNQUFNLENBQUMsZ0JBQWdCLENBQUMsT0FBaUM7UUFDL0QsSUFBSSxDQUFDLFlBQVksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxFQUFFO1lBQ3pDLE1BQU0sSUFBSSxLQUFLLENBQ2Isc0ZBQXNGO2dCQUNwRixnREFBZ0QsQ0FDbkQsQ0FBQztTQUNIO1FBRUQsSUFBSSxPQUFPLE9BQU8sQ0FBQyxVQUFVLEtBQUssUUFBUSxFQUFFO1lBQzFDLE1BQU0sSUFBSSxLQUFLLENBQ2Isb0VBQW9FO2dCQUNsRSw4QkFBOEIsQ0FDakMsQ0FBQztTQUNIO1FBRUQsSUFBSSxPQUFPLENBQUMsUUFBUSxLQUFLLElBQUksRUFBRTtZQUM3QixPQUFPLENBQUMsTUFBTSxFQUFFLENBQ2QsTUFBTSxFQUNOLGlFQUFpRTtnQkFDL0QsOERBQThELENBQ2pFLENBQUM7U0FDSDthQUFNLElBQUksT0FBTyxPQUFPLENBQUMsUUFBUSxLQUFLLFFBQVEsRUFBRTtZQUMvQyxNQUFNLElBQUksS0FBSyxDQUFDLDhCQUE4QixDQUFDLENBQUM7U0FDakQ7SUFDSCxDQUFDO0lBRU8sTUFBTSxDQUFDLGlCQUFpQixDQUFDLE9BQWlDO1FBQ2hFLElBQUksT0FBTyxPQUFPLENBQUMsTUFBTSxLQUFLLFFBQVEsSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFO1lBQzFFLE1BQU0sSUFBSSxLQUFLLENBQ2IsbUVBQW1FO2dCQUNqRSx3REFBd0QsQ0FDM0QsQ0FBQztTQUNIO0lBQ0gsQ0FBQztJQUVPLE1BQU0sQ0FBQyxjQUFjLENBQUMsTUFBZTtRQUMzQyxJQUFJLE9BQU8sTUFBTSxLQUFLLFFBQVEsRUFBRTtZQUM5QixPQUFPLEtBQUssQ0FBQztTQUNkO1FBRUQsTUFBTSxNQUFNLEdBQUcsSUFBQSxZQUFTLEVBQUMsTUFBTSxDQUFDLENBQUM7UUFFakMsT0FBTyxNQUFNLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsSUFBQSxlQUFVLEVBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUM7SUFDM0QsQ0FBQztJQUVPLE1BQU0sQ0FBQyxLQUFLLENBQUMsTUFBZTtRQUNsQyxJQUFJLE9BQU8sTUFBTSxLQUFLLFFBQVEsRUFBRTtZQUM5QixPQUFPLEtBQUssQ0FBQztTQUNkO1FBRUQsSUFBSTtZQUNGLE1BQU0sR0FBRyxHQUFHLElBQUksR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBRTVCLE9BQU8sR0FBRyxDQUFDLFFBQVEsS0FBSyxPQUFPLElBQUksR0FBRyxDQUFDLFFBQVEsS0FBSyxRQUFRLENBQUM7U0FDOUQ7UUFBQyxPQUFPLENBQUMsRUFBRTtZQUNWLE9BQU8sS0FBSyxDQUFDO1NBQ2Q7SUFDSCxDQUFDOztBQXZISCwrQkF3SEM7QUF2SGdCLHlCQUFZLEdBQUc7SUFDNUIsS0FBSyxFQUFFLHVCQUF1QjtJQUM5QixJQUFJLEVBQUUsc0JBQXNCO0lBQzVCLElBQUksRUFBRSx5QkFBeUI7SUFDL0IsS0FBSyxFQUFFLHVCQUF1QjtDQUMvQixDQUFDIn0=