@forestadmin/agent 1.0.0-beta.9 → 1.0.1

package/dist/agent.d.ts

@@ -0,0 +1,76 @@
+import { ChartDefinition, CollectionCustomizer, DataSourceOptions, TCollectionName, TSchema } from '@forestadmin/datasource-customizer';
+import { DataSourceFactory } from '@forestadmin/datasource-toolkit';
+import { AgentOptions } from './types';
+import FrameworkMounter from './framework-mounter';
+/**
+ * Allow to create a new Forest Admin agent from scratch.
+ * Builds the application by composing and configuring all the collection decorators.
+ *
+ * Minimal code to add a datasource
+ * @example
+ * new AgentBuilder(options)
+ *  .addDataSource(new SomeDataSource())
+ *  .start();
+ */
+export default class Agent<S extends TSchema = TSchema> extends FrameworkMounter {
+    private options;
+    private customizer;
+    /**
+     * Create a new Agent Builder.
+     * If any options are missing, the default will be applied:
+     * ```
+     *  forestServerUrl: 'https://api.forestadmin.com',
+     *  logger: (level, data) => console.error(level, data),
+     *  prefix: 'api/v1',
+     *  schemaPath: '.forestadmin-schema.json',
+     *  permissionsCacheDurationInSeconds: 15 * 60,
+     * ```
+     * @param options options
+     * @example
+     * new AgentBuilder(options)
+     *  .addDataSource(new DataSource())
+     *  .start();
+     */
+    constructor(options: AgentOptions);
+    /**
+     * Start the agent.
+     */
+    start(): Promise<void>;
+    /**
+     * Add a datasource
+     * @param factory the datasource to add
+     * @param options the options
+     */
+    addDataSource(factory: DataSourceFactory, options?: DataSourceOptions): this;
+    /**
+     * Create a new API chart
+     * @param name name of the chart
+     * @param definition definition of the chart
+     * @example
+     * .addChart('numCustomers', {
+     *   type: 'Value',
+     *   render: (context, resultBuilder) => {
+     *     return resultBuilder.value(123);
+     *   }
+     * })
+     */
+    addChart(name: string, definition: ChartDefinition<S>): this;
+    /**
+     * Allow to interact with a decorated collection
+     * @param name the name of the collection to manipulate
+     * @param handle a function that provide a
+     *   collection builder on the given collection name
+     * @example
+     * .customizeCollection('books', books => books.renameField('xx', 'yy'))
+     */
+    customizeCollection<N extends TCollectionName<S>>(name: N, handle: (collection: CollectionCustomizer<S, N>) => unknown): this;
+    /**
+     * Create an http handler which can respond to all queries which are expected from an agent.
+     */
+    private getRouter;
+    /**
+     * Send the apimap to forest admin server
+     */
+    private sendSchema;
+}
+//# sourceMappingURL=agent.d.ts.map

package/dist/agent.js

@@ -0,0 +1,133 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const datasource_customizer_1 = require("@forestadmin/datasource-customizer");
+const router_1 = __importDefault(require("@koa/router"));
+const koa_bodyparser_1 = __importDefault(require("koa-bodyparser"));
+const cors_1 = __importDefault(require("@koa/cors"));
+const forest_http_api_1 = __importDefault(require("./utils/forest-http-api"));
+const framework_mounter_1 = __importDefault(require("./framework-mounter"));
+const options_validator_1 = __importDefault(require("./utils/options-validator"));
+const emitter_1 = __importDefault(require("./utils/forest-schema/emitter"));
+const routes_1 = __importDefault(require("./routes"));
+const services_1 = __importDefault(require("./services"));
+/**
+ * Allow to create a new Forest Admin agent from scratch.
+ * Builds the application by composing and configuring all the collection decorators.
+ *
+ * Minimal code to add a datasource
+ * @example
+ * new AgentBuilder(options)
+ *  .addDataSource(new SomeDataSource())
+ *  .start();
+ */
+class Agent extends framework_mounter_1.default {
+    /**
+     * Create a new Agent Builder.
+     * If any options are missing, the default will be applied:
+     * ```
+     *  forestServerUrl: 'https://api.forestadmin.com',
+     *  logger: (level, data) => console.error(level, data),
+     *  prefix: 'api/v1',
+     *  schemaPath: '.forestadmin-schema.json',
+     *  permissionsCacheDurationInSeconds: 15 * 60,
+     * ```
+     * @param options options
+     * @example
+     * new AgentBuilder(options)
+     *  .addDataSource(new DataSource())
+     *  .start();
+     */
+    constructor(options) {
+        const allOptions = options_validator_1.default.validate(options_validator_1.default.withDefaults(options));
+        super(allOptions.prefix, allOptions.logger);
+        this.options = allOptions;
+        this.customizer = new datasource_customizer_1.DataSourceCustomizer();
+    }
+    /**
+     * Start the agent.
+     */
+    async start() {
+        const { logger, typingsPath, typingsMaxDepth } = this.options;
+        const dataSource = await this.customizer.getDataSource(logger);
+        const [router] = await Promise.all([
+            this.getRouter(dataSource),
+            this.sendSchema(dataSource),
+            !this.options.isProduction && typingsPath
+                ? this.customizer.updateTypesOnFileSystem(typingsPath, typingsMaxDepth)
+                : Promise.resolve(),
+        ]);
+        return super.start(router);
+    }
+    /**
+     * Add a datasource
+     * @param factory the datasource to add
+     * @param options the options
+     */
+    addDataSource(factory, options) {
+        this.customizer.addDataSource(factory, options);
+        return this;
+    }
+    /**
+     * Create a new API chart
+     * @param name name of the chart
+     * @param definition definition of the chart
+     * @example
+     * .addChart('numCustomers', {
+     *   type: 'Value',
+     *   render: (context, resultBuilder) => {
+     *     return resultBuilder.value(123);
+     *   }
+     * })
+     */
+    addChart(name, definition) {
+        this.customizer.addChart(name, definition);
+        return this;
+    }
+    /**
+     * Allow to interact with a decorated collection
+     * @param name the name of the collection to manipulate
+     * @param handle a function that provide a
+     *   collection builder on the given collection name
+     * @example
+     * .customizeCollection('books', books => books.renameField('xx', 'yy'))
+     */
+    customizeCollection(name, handle) {
+        this.customizer.customizeCollection(name, handle);
+        return this;
+    }
+    /**
+     * Create an http handler which can respond to all queries which are expected from an agent.
+     */
+    async getRouter(dataSource) {
+        // Bootstrap app
+        const services = (0, services_1.default)(this.options);
+        const routes = (0, routes_1.default)(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;
+    }
+    /**
+     * Send the apimap to forest admin server
+     */
+    async sendSchema(dataSource) {
+        const schema = await emitter_1.default.getSerializedSchema(this.options, 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');
+        }
+    }
+}
+exports.default = Agent;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvYWdlbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSx1REFBdUQ7QUFDdkQsOEVBTzRDO0FBRTVDLHlEQUFpQztBQUNqQyxvRUFBd0M7QUFDeEMscURBQTZCO0FBRzdCLDhFQUFvRDtBQUNwRCw0RUFBbUQ7QUFDbkQsa0ZBQXlEO0FBQ3pELDRFQUEwRDtBQUMxRCxzREFBa0M7QUFDbEMsMERBQXNDO0FBRXRDOzs7Ozs7Ozs7R0FTRztBQUNILE1BQXFCLEtBQW1DLFNBQVEsMkJBQWdCO0lBSTlFOzs7Ozs7Ozs7Ozs7Ozs7T0FlRztJQUNILFlBQVksT0FBcUI7UUFDL0IsTUFBTSxVQUFVLEdBQUcsMkJBQWdCLENBQUMsUUFBUSxDQUFDLDJCQUFnQixDQUFDLFlBQVksQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDO1FBQ3JGLEtBQUssQ0FBQyxVQUFVLENBQUMsTUFBTSxFQUFFLFVBQVUsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUU1QyxJQUFJLENBQUMsT0FBTyxHQUFHLFVBQVUsQ0FBQztRQUMxQixJQUFJLENBQUMsVUFBVSxHQUFHLElBQUksNENBQW9CLEVBQUssQ0FBQztJQUNsRCxDQUFDO0lBRUQ7O09BRUc7SUFDTSxLQUFLLENBQUMsS0FBSztRQUNsQixNQUFNLEVBQUUsTUFBTSxFQUFFLFdBQVcsRUFBRSxlQUFlLEVBQUUsR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDO1FBRTlELE1BQU0sVUFBVSxHQUFHLE1BQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxhQUFhLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDL0QsTUFBTSxDQUFDLE1BQU0sQ0FBQyxHQUFHLE1BQU0sT0FBTyxDQUFDLEdBQUcsQ0FBQztZQUNqQyxJQUFJLENBQUMsU0FBUyxDQUFDLFVBQVUsQ0FBQztZQUMxQixJQUFJLENBQUMsVUFBVSxDQUFDLFVBQVUsQ0FBQztZQUMzQixDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsWUFBWSxJQUFJLFdBQVc7Z0JBQ3ZDLENBQUMsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLHVCQUF1QixDQUFDLFdBQVcsRUFBRSxlQUFlLENBQUM7Z0JBQ3ZFLENBQUMsQ0FBQyxPQUFPLENBQUMsT0FBTyxFQUFFO1NBQ3RCLENBQUMsQ0FBQztRQUVILE9BQU8sS0FBSyxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUM3QixDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILGFBQWEsQ0FBQyxPQUEwQixFQUFFLE9BQTJCO1FBQ25FLElBQUksQ0FBQyxVQUFVLENBQUMsYUFBYSxDQUFDLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQztRQUVoRCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7T0FXRztJQUNILFFBQVEsQ0FBQyxJQUFZLEVBQUUsVUFBOEI7UUFDbkQsSUFBSSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsSUFBSSxFQUFFLFVBQVUsQ0FBQyxDQUFDO1FBRTNDLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDSCxtQkFBbUIsQ0FDakIsSUFBTyxFQUNQLE1BQTJEO1FBRTNELElBQUksQ0FBQyxVQUFVLENBQUMsbUJBQW1CLENBQUMsSUFBSSxFQUFFLE1BQU0sQ0FBQyxDQUFDO1FBRWxELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOztPQUVHO0lBQ0ssS0FBSyxDQUFDLFNBQVMsQ0FBQyxVQUFzQjtRQUM1QyxnQkFBZ0I7UUFDaEIsTUFBTSxRQUFRLEdBQUcsSUFBQSxrQkFBWSxFQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUM1QyxNQUFNLE1BQU0sR0FBRyxJQUFBLGdCQUFVLEVBQUMsVUFBVSxFQUFFLElBQUksQ0FBQyxPQUFPLEVBQUUsUUFBUSxDQUFDLENBQUM7UUFDOUQsTUFBTSxPQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQyxLQUFLLENBQUMsU0FBUyxFQUFFLENBQUMsQ0FBQyxDQUFDO1FBRTFELGVBQWU7UUFDZixNQUFNLE1BQU0sR0FBRyxJQUFJLGdCQUFNLEVBQUUsQ0FBQztRQUM1QixNQUFNLENBQUMsR0FBRyxDQUFDLE1BQU0sRUFBRSxJQUFBLGNBQUksRUFBQyxFQUFFLFdBQVcsRUFBRSxJQUFJLEVBQUUsTUFBTSxFQUFFLEVBQUUsR0FBRyxJQUFJLEVBQUUsb0JBQW9CLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQyxDQUFDO1FBQy9GLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBQSx3QkFBVSxFQUFDLEVBQUUsU0FBUyxFQUFFLE1BQU0sRUFBRSxDQUFDLENBQUMsQ0FBQztRQUM5QyxNQUFNLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUMsS0FBSyxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO1FBRW5ELE9BQU8sTUFBTSxDQUFDO0lBQ2hCLENBQUM7SUFFRDs7T0FFRztJQUNLLEtBQUssQ0FBQyxVQUFVLENBQUMsVUFBc0I7UUFDN0MsTUFBTSxNQUFNLEdBQUcsTUFBTSxpQkFBYSxDQUFDLG1CQUFtQixDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsVUFBVSxDQUFDLENBQUM7UUFDakYsTUFBTSxhQUFhLEdBQUcsTUFBTSx5QkFBYSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUM7UUFFOUYsSUFBSSxDQUFDLGFBQWEsRUFBRTtZQUNsQixJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUUseUNBQXlDLENBQUMsQ0FBQztZQUN2RSxNQUFNLHlCQUFhLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsTUFBTSxDQUFDLENBQUM7U0FDeEQ7YUFBTTtZQUNMLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLE1BQU0sRUFBRSx1Q0FBdUMsQ0FBQyxDQUFDO1NBQ3RFO0lBQ0gsQ0FBQztDQUNGO0FBNUhELHdCQTRIQyJ9

package/dist/framework-mounter.d.ts

@@ -0,0 +1,43 @@
+/// <reference types="koa__router" />
+import { Logger } from '@forestadmin/datasource-toolkit';
+import Router from '@koa/router';
+export default class FrameworkMounter {
+    private onStart;
+    private onStop;
+    private prefix;
+    private logger;
+    /** Compute the prefix that the main router should be mounted at in the client's application */
+    private get completeMountPrefix();
+    constructor(prefix: string, logger: Logger);
+    start(router: Router): Promise<void>;
+    stop(): Promise<void>;
+    /**
+     * Expose the agent on a given port and host
+     * @param port port that should be used.
+     * @param host host that should be used.
+     */
+    mountOnStandaloneServer(port?: number, host?: string): this;
+    /**
+     * Mount the agent on an express app.
+     * @param express instance of the express app or router.
+     */
+    mountOnExpress(express: any): this;
+    /**
+     * Mount the agent on a fastify app
+     * @param fastify instance of the fastify app, or of a fastify context
+     */
+    mountOnFastify(fastify: any): this;
+    /**
+     * Mount the agent on a koa app
+     * @param koa instance of a koa app or a koa Router.
+     */
+    mountOnKoa(koa: any): this;
+    /**
+     * Mount the agent on a NestJS app
+     * @param nestJs instance of a NestJS application
+     */
+    mountOnNestJs(nestJs: any): this;
+    private useCallbackOnFastify;
+    private getConnectCallback;
+}
+//# sourceMappingURL=framework-mounter.d.ts.map

package/dist/framework-mounter.js

@@ -0,0 +1,157 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const http_1 = require("http");
+const koa_1 = __importDefault(require("koa"));
+const router_1 = __importDefault(require("@koa/router"));
+const path_1 = __importDefault(require("path"));
+class FrameworkMounter {
+    constructor(prefix, logger) {
+        this.onStart = [];
+        this.onStop = [];
+        this.prefix = prefix;
+        this.logger = logger;
+    }
+    /** Compute the prefix that the main router should be mounted at in the client's application */
+    get completeMountPrefix() {
+        return path_1.default.posix.join('/', this.prefix, 'forest');
+    }
+    async start(router) {
+        for (const task of this.onStart)
+            await task(router); // eslint-disable-line no-await-in-loop
+    }
+    async stop() {
+        for (const task of this.onStop)
+            await task(); // eslint-disable-line no-await-in-loop
+    }
+    /**
+     * Expose the agent on a given port and host
+     * @param port port that should be used.
+     * @param host host that should be used.
+     */
+    mountOnStandaloneServer(port = 3351, host = 'localhost') {
+        const server = (0, http_1.createServer)(this.getConnectCallback(true));
+        server.listen(port, host);
+        this.logger('Info', `Successfully mounted on Standalone server (http://${host}:${port})`);
+        this.onStop.push(async () => {
+            server.close();
+        });
+        return this;
+    }
+    /**
+     * Mount the agent on an express app.
+     * @param express instance of the express app or router.
+     */
+    mountOnExpress(express) {
+        express.use(this.completeMountPrefix, this.getConnectCallback(false));
+        this.logger('Info', `Successfully mounted on Express.js`);
+        return this;
+    }
+    /**
+     * Mount the agent on a fastify app
+     * @param fastify instance of the fastify app, or of a fastify context
+     */
+    mountOnFastify(fastify) {
+        const callback = this.getConnectCallback(false);
+        this.useCallbackOnFastify(fastify, callback);
+        this.logger('Info', `Successfully mounted on Fastify`);
+        return this;
+    }
+    /**
+     * Mount the agent on a koa app
+     * @param koa instance of a koa app or a koa Router.
+     */
+    mountOnKoa(koa) {
+        const parentRouter = new router_1.default({ prefix: this.completeMountPrefix });
+        koa.use(parentRouter.routes());
+        this.logger('Info', `Successfully mounted on Koa`);
+        this.onStart.push(async (router) => {
+            parentRouter.use(router.routes());
+        });
+        return this;
+    }
+    /**
+     * Mount the agent on a NestJS app
+     * @param nestJs instance of a NestJS application
+     */
+    mountOnNestJs(nestJs) {
+        const adapter = nestJs.getHttpAdapter();
+        const callback = this.getConnectCallback(false);
+        if (adapter.constructor.name === 'ExpressAdapter') {
+            nestJs.use(this.completeMountPrefix, callback);
+        }
+        else {
+            this.useCallbackOnFastify(nestJs, callback);
+        }
+        this.logger('Info', `Successfully mounted on NestJS`);
+        return this;
+    }
+    useCallbackOnFastify(fastify, callback) {
+        try {
+            // 'fastify 2' or 'middie' or 'fastify-express'
+            fastify.use(this.completeMountPrefix, callback);
+        }
+        catch (e) {
+            // 'fastify 3'
+            if (e.code === 'FST_ERR_MISSING_MIDDLEWARE') {
+                fastify
+                    .register(Promise.resolve().then(() => __importStar(require('@fastify/express'))))
+                    .then(() => {
+                    fastify.use(this.completeMountPrefix, callback);
+                })
+                    .catch(err => {
+                    this.logger('Error', err.message);
+                });
+            }
+            else {
+                throw e;
+            }
+        }
+    }
+    getConnectCallback(nested) {
+        let handler = null;
+        this.onStart.push(async (driverRouter) => {
+            let router = driverRouter;
+            if (nested) {
+                router = new router_1.default({ prefix: this.completeMountPrefix }).use(router.routes());
+            }
+            handler = new koa_1.default().use(router.routes()).callback();
+        });
+        return (req, res) => {
+            if (handler) {
+                handler(req, res);
+            }
+            else {
+                res.writeHead(200, { 'Content-Type': 'application/json' });
+                res.end(JSON.stringify({ error: 'Agent is not started' }));
+            }
+        };
+    }
+}
+exports.default = FrameworkMounter;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZnJhbWV3b3JrLW1vdW50ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvZnJhbWV3b3JrLW1vdW50ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUVBLCtCQUFvQztBQUNwQyw4Q0FBc0I7QUFDdEIseURBQWlDO0FBQ2pDLGdEQUF3QjtBQUl4QixNQUFxQixnQkFBZ0I7SUFXbkMsWUFBWSxNQUFjLEVBQUUsTUFBYztRQVZsQyxZQUFPLEdBQTBDLEVBQUUsQ0FBQztRQUNwRCxXQUFNLEdBQTRCLEVBQUUsQ0FBQztRQVUzQyxJQUFJLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQztRQUNyQixJQUFJLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQztJQUN2QixDQUFDO0lBUkQsK0ZBQStGO0lBQy9GLElBQVksbUJBQW1CO1FBQzdCLE9BQU8sY0FBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLElBQUksQ0FBQyxNQUFNLEVBQUUsUUFBUSxDQUFDLENBQUM7SUFDckQsQ0FBQztJQU9ELEtBQUssQ0FBQyxLQUFLLENBQUMsTUFBYztRQUN4QixLQUFLLE1BQU0sSUFBSSxJQUFJLElBQUksQ0FBQyxPQUFPO1lBQUUsTUFBTSxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyx1Q0FBdUM7SUFDOUYsQ0FBQztJQUVELEtBQUssQ0FBQyxJQUFJO1FBQ1IsS0FBSyxNQUFNLElBQUksSUFBSSxJQUFJLENBQUMsTUFBTTtZQUFFLE1BQU0sSUFBSSxFQUFFLENBQUMsQ0FBQyx1Q0FBdUM7SUFDdkYsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCx1QkFBdUIsQ0FBQyxJQUFJLEdBQUcsSUFBSSxFQUFFLElBQUksR0FBRyxXQUFXO1FBQ3JELE1BQU0sTUFBTSxHQUFHLElBQUEsbUJBQVksRUFBQyxJQUFJLENBQUMsa0JBQWtCLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztRQUMzRCxNQUFNLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQztRQUUxQixJQUFJLENBQUMsTUFBTSxDQUFDLE1BQU0sRUFBRSxxREFBcUQsSUFBSSxJQUFJLElBQUksR0FBRyxDQUFDLENBQUM7UUFFMUYsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsS0FBSyxJQUFJLEVBQUU7WUFDMUIsTUFBTSxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQ2pCLENBQUMsQ0FBQyxDQUFDO1FBRUgsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsY0FBYyxDQUFDLE9BQVk7UUFDekIsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsbUJBQW1CLEVBQUUsSUFBSSxDQUFDLGtCQUFrQixDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUM7UUFDdEUsSUFBSSxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUUsb0NBQW9DLENBQUMsQ0FBQztRQUUxRCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7O09BR0c7SUFDSCxjQUFjLENBQUMsT0FBWTtRQUN6QixNQUFNLFFBQVEsR0FBRyxJQUFJLENBQUMsa0JBQWtCLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDaEQsSUFBSSxDQUFDLG9CQUFvQixDQUFDLE9BQU8sRUFBRSxRQUFRLENBQUMsQ0FBQztRQUU3QyxJQUFJLENBQUMsTUFBTSxDQUFDLE1BQU0sRUFBRSxpQ0FBaUMsQ0FBQyxDQUFDO1FBRXZELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7T0FHRztJQUNILFVBQVUsQ0FBQyxHQUFRO1FBQ2pCLE1BQU0sWUFBWSxHQUFHLElBQUksZ0JBQU0sQ0FBQyxFQUFFLE1BQU0sRUFBRSxJQUFJLENBQUMsbUJBQW1CLEVBQUUsQ0FBQyxDQUFDO1FBRXRFLEdBQUcsQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUM7UUFDL0IsSUFBSSxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUUsNkJBQTZCLENBQUMsQ0FBQztRQUVuRCxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUMsTUFBTSxFQUFDLEVBQUU7WUFDL0IsWUFBWSxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQztRQUNwQyxDQUFDLENBQUMsQ0FBQztRQUVILE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7T0FHRztJQUNILGFBQWEsQ0FBQyxNQUFXO1FBQ3ZCLE1BQU0sT0FBTyxHQUFHLE1BQU0sQ0FBQyxjQUFjLEVBQUUsQ0FBQztRQUN4QyxNQUFNLFFBQVEsR0FBRyxJQUFJLENBQUMsa0JBQWtCLENBQUMsS0FBSyxDQUFDLENBQUM7UUFFaEQsSUFBSSxPQUFPLENBQUMsV0FBVyxDQUFDLElBQUksS0FBSyxnQkFBZ0IsRUFBRTtZQUNqRCxNQUFNLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxtQkFBbUIsRUFBRSxRQUFRLENBQUMsQ0FBQztTQUNoRDthQUFNO1lBQ0wsSUFBSSxDQUFDLG9CQUFvQixDQUFDLE1BQU0sRUFBRSxRQUFRLENBQUMsQ0FBQztTQUM3QztRQUVELElBQUksQ0FBQyxNQUFNLENBQUMsTUFBTSxFQUFFLGdDQUFnQyxDQUFDLENBQUM7UUFFdEQsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRU8sb0JBQW9CLENBQUMsT0FBWSxFQUFFLFFBQXNCO1FBQy9ELElBQUk7WUFDRiwrQ0FBK0M7WUFDL0MsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsbUJBQW1CLEVBQUUsUUFBUSxDQUFDLENBQUM7U0FDakQ7UUFBQyxPQUFPLENBQUMsRUFBRTtZQUNWLGNBQWM7WUFDZCxJQUFJLENBQUMsQ0FBQyxJQUFJLEtBQUssNEJBQTRCLEVBQUU7Z0JBQzNDLE9BQU87cUJBQ0osUUFBUSxtREFBUSxrQkFBa0IsSUFBRTtxQkFDcEMsSUFBSSxDQUFDLEdBQUcsRUFBRTtvQkFDVCxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxtQkFBbUIsRUFBRSxRQUFRLENBQUMsQ0FBQztnQkFDbEQsQ0FBQyxDQUFDO3FCQUNELEtBQUssQ0FBQyxHQUFHLENBQUMsRUFBRTtvQkFDWCxJQUFJLENBQUMsTUFBTSxDQUFDLE9BQU8sRUFBRSxHQUFHLENBQUMsT0FBTyxDQUFDLENBQUM7Z0JBQ3BDLENBQUMsQ0FBQyxDQUFDO2FBQ047aUJBQU07Z0JBQ0wsTUFBTSxDQUFDLENBQUM7YUFDVDtTQUNGO0lBQ0gsQ0FBQztJQUVPLGtCQUFrQixDQUFDLE1BQWU7UUFDeEMsSUFBSSxPQUFPLEdBQUcsSUFBSSxDQUFDO1FBRW5CLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBQyxZQUFZLEVBQUMsRUFBRTtZQUNyQyxJQUFJLE1BQU0sR0FBRyxZQUFZLENBQUM7WUFFMUIsSUFBSSxNQUFNLEVBQUU7Z0JBQ1YsTUFBTSxHQUFHLElBQUksZ0JBQU0sQ0FBQyxFQUFFLE1BQU0sRUFBRSxJQUFJLENBQUMsbUJBQW1CLEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQzthQUNoRjtZQUVELE9BQU8sR0FBRyxJQUFJLGFBQUcsRUFBRSxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQyxRQUFRLEVBQUUsQ0FBQztRQUN0RCxDQUFDLENBQUMsQ0FBQztRQUVILE9BQU8sQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLEVBQUU7WUFDbEIsSUFBSSxPQUFPLEVBQUU7Z0JBQ1gsT0FBTyxDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsQ0FBQzthQUNuQjtpQkFBTTtnQkFDTCxHQUFHLENBQUMsU0FBUyxDQUFDLEdBQUcsRUFBRSxFQUFFLGNBQWMsRUFBRSxrQkFBa0IsRUFBRSxDQUFDLENBQUM7Z0JBQzNELEdBQUcsQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxFQUFFLEtBQUssRUFBRSxzQkFBc0IsRUFBRSxDQUFDLENBQUMsQ0FBQzthQUM1RDtRQUNILENBQUMsQ0FBQztJQUNKLENBQUM7Q0FDRjtBQWpKRCxtQ0FpSkMifQ==

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,26 +1,15 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Collection = exports.Agent = void 0;
-var agent_1 = require("./builder/agent");
-Object.defineProperty(exports, "Agent", { enumerable: true, get: function () { return __importDefault(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);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSx5Q0FBbUQ7QUFBMUMsK0dBQUEsT0FBTyxPQUFTO0FBQ3pCLG1EQUE2RDtBQUFwRCx5SEFBQSxPQUFPLE9BQWM7QUFDOUIsMENBQXdCIn0=
+exports.CollectionCustomizer = exports.Agent = exports.createAgent = void 0;
+const datasource_customizer_1 = require("@forestadmin/datasource-customizer");
+Object.defineProperty(exports, "CollectionCustomizer", { enumerable: true, get: function () { return datasource_customizer_1.CollectionCustomizer; } });
+const agent_1 = __importDefault(require("./agent"));
+exports.Agent = agent_1.default;
+function createAgent(options) {
+    return new agent_1.default(options);
+}
+exports.createAgent = createAgent;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsOEVBQW1GO0FBVTFFLHFHQVZBLDRDQUFvQixPQVVBO0FBUDdCLG9EQUE0QjtBQU1uQixnQkFORixlQUFLLENBTUU7QUFKZCxTQUFnQixXQUFXLENBQThCLE9BQXFCO0lBQzVFLE9BQU8sSUFBSSxlQUFLLENBQUksT0FBTyxDQUFDLENBQUM7QUFDL0IsQ0FBQztBQUZELGtDQUVDIn0=

package/dist/routes/access/api-chart.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="koa__router" />
+import { DataSource } from '@forestadmin/datasource-toolkit';
+import Router from '@koa/router';
+import { AgentOptionsWithDefaults, RouteType } from '../../types';
+import { ForestAdminHttpDriverServices } from '../../services';
+import BaseRoute from '../base-route';
+export default class ApiChartRoute extends BaseRoute {
+    readonly type = RouteType.PrivateRoute;
+    private dataSource;
+    private chartName;
+    constructor(services: ForestAdminHttpDriverServices, options: AgentOptionsWithDefaults, dataSource: DataSource, chartName: string);
+    setupRoutes(router: Router): void;
+    private handleApiChart;
+    private handleSmartChart;
+}
+//# sourceMappingURL=api-chart.d.ts.map

package/dist/routes/access/api-chart.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const uuid_1 = require("uuid");
+const path_1 = __importDefault(require("path"));
+const types_1 = require("../../types");
+const base_route_1 = __importDefault(require("../base-route"));
+const query_string_1 = __importDefault(require("../../utils/query-string"));
+class ApiChartRoute extends base_route_1.default {
+    constructor(services, options, dataSource, chartName) {
+        super(services, options);
+        this.type = types_1.RouteType.PrivateRoute;
+        this.dataSource = dataSource;
+        this.chartName = chartName;
+    }
+    setupRoutes(router) {
+        // Mount both GET and POST, respectively for smart and api charts.
+        const suffix = `/_charts/${this.chartName}`;
+        router.get(suffix, this.handleSmartChart.bind(this));
+        router.post(suffix, this.handleApiChart.bind(this));
+        // Log the route to help the customer fill the url in the frontend
+        if (!this.options.isProduction) {
+            const url = path_1.default.posix.join('/', this.options.prefix, 'forest', suffix);
+            this.options.logger('Info', `Chart '${this.chartName}' was mounted at '${url}'`);
+        }
+    }
+    async handleApiChart(context) {
+        // Api Charts need the data to be formatted in JSON-API
+        context.response.body = {
+            data: {
+                id: (0, uuid_1.v1)(),
+                type: 'stats',
+                attributes: {
+                    value: await this.dataSource.renderChart(query_string_1.default.parseCaller(context), this.chartName),
+                },
+            },
+        };
+    }
+    async handleSmartChart(context) {
+        // Smart charts need the data to be unformatted
+        context.response.body = await this.dataSource.renderChart(query_string_1.default.parseCaller(context), this.chartName);
+    }
+}
+exports.default = ApiChartRoute;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpLWNoYXJ0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3JvdXRlcy9hY2Nlc3MvYXBpLWNoYXJ0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBRUEsK0JBQW9DO0FBRXBDLGdEQUF3QjtBQUV4Qix1Q0FBa0U7QUFFbEUsK0RBQXNDO0FBQ3RDLDRFQUF5RDtBQUV6RCxNQUFxQixhQUFjLFNBQVEsb0JBQVM7SUFNbEQsWUFDRSxRQUF1QyxFQUN2QyxPQUFpQyxFQUNqQyxVQUFzQixFQUN0QixTQUFpQjtRQUVqQixLQUFLLENBQUMsUUFBUSxFQUFFLE9BQU8sQ0FBQyxDQUFDO1FBWGxCLFNBQUksR0FBRyxpQkFBUyxDQUFDLFlBQVksQ0FBQztRQWFyQyxJQUFJLENBQUMsVUFBVSxHQUFHLFVBQVUsQ0FBQztRQUM3QixJQUFJLENBQUMsU0FBUyxHQUFHLFNBQVMsQ0FBQztJQUM3QixDQUFDO0lBRUQsV0FBVyxDQUFDLE1BQWM7UUFDeEIsa0VBQWtFO1FBQ2xFLE1BQU0sTUFBTSxHQUFHLFlBQVksSUFBSSxDQUFDLFNBQVMsRUFBRSxDQUFDO1FBQzVDLE1BQU0sQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztRQUNyRCxNQUFNLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO1FBRXBELGtFQUFrRTtRQUNsRSxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxZQUFZLEVBQUU7WUFDOUIsTUFBTSxHQUFHLEdBQUcsY0FBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFLFFBQVEsRUFBRSxNQUFNLENBQUMsQ0FBQztZQUN4RSxJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUUsVUFBVSxJQUFJLENBQUMsU0FBUyxxQkFBcUIsR0FBRyxHQUFHLENBQUMsQ0FBQztTQUNsRjtJQUNILENBQUM7SUFFTyxLQUFLLENBQUMsY0FBYyxDQUFDLE9BQWdCO1FBQzNDLHVEQUF1RDtRQUN2RCxPQUFPLENBQUMsUUFBUSxDQUFDLElBQUksR0FBRztZQUN0QixJQUFJLEVBQUU7Z0JBQ0osRUFBRSxFQUFFLElBQUEsU0FBTSxHQUFFO2dCQUNaLElBQUksRUFBRSxPQUFPO2dCQUNiLFVBQVUsRUFBRTtvQkFDVixLQUFLLEVBQUUsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FDdEMsc0JBQWlCLENBQUMsV0FBVyxDQUFDLE9BQU8sQ0FBQyxFQUN0QyxJQUFJLENBQUMsU0FBUyxDQUNmO2lCQUNGO2FBQ0Y7U0FDRixDQUFDO0lBQ0osQ0FBQztJQUVPLEtBQUssQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFnQjtRQUM3QywrQ0FBK0M7UUFDL0MsT0FBTyxDQUFDLFFBQVEsQ0FBQyxJQUFJLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FDdkQsc0JBQWlCLENBQUMsV0FBVyxDQUFDLE9BQU8sQ0FBQyxFQUN0QyxJQUFJLENBQUMsU0FBUyxDQUNmLENBQUM7SUFDSixDQUFDO0NBQ0Y7QUF0REQsZ0NBc0RDIn0=

package/dist/{agent/routes → routes}/access/chart.d.ts

@@ -6,6 +6,7 @@ export default class Chart extends CollectionRoute {
     private static readonly formats;
     setupRoutes(router: Router): void;
     handleChart(context: Context): Promise<void>;
+    private makeChart;
     private makeValueChart;
     private makeObjectiveChart;
     private makePieChart;