@forestadmin/agent 1.0.0-beta.1

package/dist/builder/collection.js

@@ -0,0 +1,226 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const datasource_toolkit_1 = require("@forestadmin/datasource-toolkit");
+const filterable_1 = __importDefault(require("../agent/utils/forest-schema/filterable"));
+class CollectionBuilder {
+    constructor(agentBuilder, name) {
+        this.agentBuilder = agentBuilder;
+        this.name = name;
+    }
+    /**
+     * Import a field from a many to one or one to one relation.
+     *
+     * @param name the name of the field that will be created on the collection
+     * @param options options to import the field
+     * @example
+     * .importField('authorName', { path: 'author:fullName' })
+     */
+    importField(name, options) {
+        const collection = this.agentBuilder.lateComputed.getCollection(this.name);
+        const schema = datasource_toolkit_1.CollectionUtils.getFieldSchema(collection, options.path);
+        this.addField(name, {
+            beforeRelations: options.beforeRelations,
+            columnType: schema.columnType,
+            defaultValue: schema.defaultValue,
+            dependencies: [options.path],
+            getValues: records => records.map(r => datasource_toolkit_1.RecordUtils.getFieldValue(r, options.path)),
+            enumValues: schema.enumValues,
+        });
+        for (const operator of schema.filterOperators) {
+            const handler = (value) => ({ field: options.path, operator, value });
+            this.replaceFieldOperator(name, operator, handler);
+        }
+        if (schema.isSortable) {
+            this.replaceFieldSorting(name, [{ field: options.path, ascending: true }]);
+        }
+        return this;
+    }
+    /**
+     * Allow to rename a field of a given collection.
+     * @param {string} oldName the current name of the field in a given collection
+     * @param {string} newName the new name of the field
+     * @example
+     * .renameField('theCurrentNameOfTheField', 'theNewNameOfTheField');
+     */
+    renameField(oldName, newName) {
+        this.agentBuilder.rename.getCollection(this.name).renameField(oldName, newName);
+        return this;
+    }
+    /**
+     * Remove field by setting its visibility to false.
+     * @param {...string[]} names the fields to remove
+     * @example
+     * .removeField('aFieldToRemove', 'anOtherFieldToRemove');
+     */
+    removeField(...names) {
+        const collection = this.agentBuilder.publication.getCollection(this.name);
+        for (const name of names)
+            collection.changeFieldVisibility(name, false);
+        return this;
+    }
+    /**
+     * Add a new action on the collection.
+     * @param {string} name the name of the action
+     * @param {ActionDefinition} definition the definition of the action
+     * @example
+     * .addAction('is live', {
+     *    scope: 'Single',
+     *    execute: async (context, responseBuilder) => {
+     *      return responseBuilder.success(`Is live!`);
+     *    },
+     *  })
+     */
+    addAction(name, definition) {
+        this.agentBuilder.action.getCollection(this.name).addAction(name, definition);
+        return this;
+    }
+    /**
+     * Add a new field on the collection.
+     * @param {string} name the name of the field
+     * @param {FieldDefinition} definition The definition of the field
+     * @example
+     * .addField('fullName', {
+     *    columnType: 'String',
+     *    dependencies: ['firstName', 'lastName'],
+     *    getValues: (records) => records.map(record => `${record.lastName} ${record.firstName}`),
+     * });
+     */
+    addField(name, definition) {
+        const { beforeRelations, ...computedDefinition } = definition;
+        const collection = definition.beforeRelations
+            ? this.agentBuilder.earlyComputed.getCollection(this.name)
+            : this.agentBuilder.lateComputed.getCollection(this.name);
+        collection.registerComputed(name, computedDefinition);
+        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.agentBuilder.relation.getCollection(this.name).addRelation(name, definition);
+        return this;
+    }
+    /**
+     * Add a new segment on the collection.
+     * @param {string} name the name of the segment
+     * @param {SegmentDefinition} definition a function used to generate a condition tree
+     * or a condition tree
+     * @example
+     * .addSegment(
+     *    'Wrote more than 2 books',
+     *    new ConditionTreeLeaf('booksCount', 'GreaterThan', 2),
+     * );
+     */
+    addSegment(name, definition) {
+        this.agentBuilder.segment.getCollection(this.name).addSegment(name, definition);
+        return this;
+    }
+    /**
+     * Enable sorting on a specific field using emulation.
+     * As for all the emulation method, the field sorting will be done in-memory.
+     * @param {string} name the name of the field to enable emulation on
+     * @example
+     * .emulateFieldSorting('fullName');
+     */
+    emulateFieldSorting(name) {
+        this.agentBuilder.sortEmulate.getCollection(this.name).emulateFieldSorting(name);
+        return this;
+    }
+    /**
+     * Replace an implementation for the sorting.
+     * The field sorting will be done by the datasource.
+     * @param {string} name the name of the field to enable sort
+     * @param {SortClause[]} equivalentSort the sort equivalent
+     * @example
+     * .replaceFieldSorting(
+     *   'fullName',
+     *   [
+     *     { field: 'firstName', ascending: true },
+     *     { field: 'lastName',  ascending: true },
+     *   ]
+     * )
+     */
+    replaceFieldSorting(name, equivalentSort) {
+        this.agentBuilder.sortEmulate
+            .getCollection(this.name)
+            .replaceFieldSorting(name, equivalentSort);
+        return this;
+    }
+    /**
+     * Enable filtering on a specific field using emulation.
+     * As for all the emulation method, the field filtering will be done in-memory.
+     * @param name the name of the field to enable emulation on
+     * @example
+     * .emulateFieldFiltering('aField');
+     */
+    emulateFieldFiltering(name) {
+        const collection = this.agentBuilder.lateOpEmulate.getCollection(this.name);
+        const field = collection.schema.fields[name];
+        for (const operator of filterable_1.default.getRequiredOperators(field.columnType)) {
+            if (!field.filterOperators.has(operator)) {
+                this.emulateFieldOperator(name, operator);
+            }
+        }
+        return 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.
+     * @param {string} name the name of the field to enable emulation on
+     * @param {Operator} operator the operator to emulate
+     * @example
+     * .emulateFieldOperator('aField', 'In');
+     */
+    emulateFieldOperator(name, operator) {
+        const collection = this.agentBuilder.earlyOpEmulate.getCollection(this.name).schema.fields[name]
+            ? this.agentBuilder.earlyOpEmulate.getCollection(this.name)
+            : this.agentBuilder.lateOpEmulate.getCollection(this.name);
+        collection.emulateFieldOperator(name, operator);
+        return this;
+    }
+    /**
+     * Replace an implementation for a specific operator on a specific field.
+     * The operator replacement will be done by the datasource.
+     * @param {string} name the name of the field to filter on
+     * @param {Operator} operator the operator to replace
+     * @param {OperatorReplacer} replacer the proposed implementation
+     * @example
+     * .replaceFieldOperator('booksCount', 'Equal', ({ value }) => new ConditionTreeNot(
+     *   new ConditionTreeLeaf('booksCount', 'Equal', value),
+     * ));
+     */
+    replaceFieldOperator(name, operator, replacer) {
+        const collection = this.agentBuilder.earlyOpEmulate.getCollection(this.name).schema.fields[name]
+            ? this.agentBuilder.earlyOpEmulate.getCollection(this.name)
+            : this.agentBuilder.lateOpEmulate.getCollection(this.name);
+        collection.replaceFieldOperator(name, operator, replacer);
+        return this;
+    }
+    /**
+     * Replace the write behavior of a field.
+     * @param {string} name the name of the field
+     * @param {WriteDefinition} definition the function or a value to represent the write behavior
+     * @example
+     * .replaceFieldWriting('fullName', ({ patch: fullName }) => {
+     *   const [firstName, lastName] = fullName.split(' ');
+     *   return { firstName, lastName };
+     * });
+     */
+    replaceFieldWriting(name, definition) {
+        this.agentBuilder.write.getCollection(this.name).replaceFieldWriting(name, definition);
+        return this;
+    }
+}
+exports.default = CollectionBuilder;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29sbGVjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9idWlsZGVyL2NvbGxlY3Rpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSx3RUFXeUM7QUFHekMseUZBQThFO0FBRTlFLE1BQXFCLGlCQUFpQjtJQUlwQyxZQUFZLFlBQTBCLEVBQUUsSUFBWTtRQUNsRCxJQUFJLENBQUMsWUFBWSxHQUFHLFlBQVksQ0FBQztRQUNqQyxJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQztJQUNuQixDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNILFdBQVcsQ0FBQyxJQUFZLEVBQUUsT0FBb0Q7UUFDNUUsTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLFlBQVksQ0FBQyxZQUFZLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUMzRSxNQUFNLE1BQU0sR0FBRyxvQ0FBZSxDQUFDLGNBQWMsQ0FBQyxVQUFVLEVBQUUsT0FBTyxDQUFDLElBQUksQ0FBaUIsQ0FBQztRQUV4RixJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksRUFBRTtZQUNsQixlQUFlLEVBQUUsT0FBTyxDQUFDLGVBQWU7WUFDeEMsVUFBVSxFQUFFLE1BQU0sQ0FBQyxVQUFVO1lBQzdCLFlBQVksRUFBRSxNQUFNLENBQUMsWUFBWTtZQUNqQyxZQUFZLEVBQUUsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDO1lBQzVCLFNBQVMsRUFBRSxPQUFPLENBQUMsRUFBRSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxnQ0FBVyxDQUFDLGFBQWEsQ0FBQyxDQUFDLEVBQUUsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ2xGLFVBQVUsRUFBRSxNQUFNLENBQUMsVUFBVTtTQUM5QixDQUFDLENBQUM7UUFFSCxLQUFLLE1BQU0sUUFBUSxJQUFJLE1BQU0sQ0FBQyxlQUFlLEVBQUU7WUFDN0MsTUFBTSxPQUFPLEdBQUcsQ0FBQyxLQUFjLEVBQUUsRUFBRSxDQUFDLENBQUMsRUFBRSxLQUFLLEVBQUUsT0FBTyxDQUFDLElBQUksRUFBRSxRQUFRLEVBQUUsS0FBSyxFQUFFLENBQUMsQ0FBQztZQUMvRSxJQUFJLENBQUMsb0JBQW9CLENBQUMsSUFBSSxFQUFFLFFBQVEsRUFBRSxPQUFPLENBQUMsQ0FBQztTQUNwRDtRQUVELElBQUksTUFBTSxDQUFDLFVBQVUsRUFBRTtZQUNyQixJQUFJLENBQUMsbUJBQW1CLENBQUMsSUFBSSxFQUFFLENBQUMsRUFBRSxLQUFLLEVBQUUsT0FBTyxDQUFDLElBQUksRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQyxDQUFDO1NBQzVFO1FBRUQsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsV0FBVyxDQUFDLE9BQWUsRUFBRSxPQUFlO1FBQzFDLElBQUksQ0FBQyxZQUFZLENBQUMsTUFBTSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsV0FBVyxDQUFDLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQztRQUVoRixPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILFdBQVcsQ0FBQyxHQUFHLEtBQWU7UUFDNUIsTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLFlBQVksQ0FBQyxXQUFXLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUMxRSxLQUFLLE1BQU0sSUFBSSxJQUFJLEtBQUs7WUFBRSxVQUFVLENBQUMscUJBQXFCLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBRXhFLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7Ozs7OztPQVdHO0lBQ0gsU0FBUyxDQUFDLElBQVksRUFBRSxVQUE0QjtRQUNsRCxJQUFJLENBQUMsWUFBWSxDQUFDLE1BQU0sQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLFNBQVMsQ0FBQyxJQUFJLEVBQUUsVUFBVSxDQUFDLENBQUM7UUFFOUUsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNILFFBQVEsQ0FBQyxJQUFZLEVBQUUsVUFBMkI7UUFDaEQsTUFBTSxFQUFFLGVBQWUsRUFBRSxHQUFHLGtCQUFrQixFQUFFLEdBQUcsVUFBVSxDQUFDO1FBQzlELE1BQU0sVUFBVSxHQUFHLFVBQVUsQ0FBQyxlQUFlO1lBQzNDLENBQUMsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLGFBQWEsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQztZQUMxRCxDQUFDLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxZQUFZLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUU1RCxVQUFVLENBQUMsZ0JBQWdCLENBQUMsSUFBSSxFQUFFLGtCQUFrQixDQUFDLENBQUM7UUFFdEQsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNILFdBQVcsQ0FBQyxJQUFZLEVBQUUsVUFBaUM7UUFDekQsSUFBSSxDQUFDLFlBQVksQ0FBQyxRQUFRLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxXQUFXLENBQUMsSUFBSSxFQUFFLFVBQVUsQ0FBQyxDQUFDO1FBRWxGLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7Ozs7O09BVUc7SUFDSCxVQUFVLENBQUMsSUFBWSxFQUFFLFVBQTZCO1FBQ3BELElBQUksQ0FBQyxZQUFZLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsVUFBVSxDQUFDLElBQUksRUFBRSxVQUFVLENBQUMsQ0FBQztRQUVoRixPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSCxtQkFBbUIsQ0FBQyxJQUFZO1FBQzlCLElBQUksQ0FBQyxZQUFZLENBQUMsV0FBVyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsbUJBQW1CLENBQUMsSUFBSSxDQUFDLENBQUM7UUFFakYsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7Ozs7T0FhRztJQUNILG1CQUFtQixDQUFDLElBQVksRUFBRSxjQUFpQztRQUNqRSxJQUFJLENBQUMsWUFBWSxDQUFDLFdBQVc7YUFDMUIsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUM7YUFDeEIsbUJBQW1CLENBQUMsSUFBSSxFQUFFLGNBQWMsQ0FBQyxDQUFDO1FBRTdDLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILHFCQUFxQixDQUFDLElBQVk7UUFDaEMsTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLFlBQVksQ0FBQyxhQUFhLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUM1RSxNQUFNLEtBQUssR0FBRyxVQUFVLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQWlCLENBQUM7UUFFN0QsS0FBSyxNQUFNLFFBQVEsSUFBSSxvQkFBdUIsQ0FBQyxvQkFBb0IsQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLEVBQUU7WUFDckYsSUFBSSxDQUFDLEtBQUssQ0FBQyxlQUFlLENBQUMsR0FBRyxDQUFDLFFBQVEsQ0FBQyxFQUFFO2dCQUN4QyxJQUFJLENBQUMsb0JBQW9CLENBQUMsSUFBSSxFQUFFLFFBQVEsQ0FBQyxDQUFDO2FBQzNDO1NBQ0Y7UUFFRCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0gsb0JBQW9CLENBQUMsSUFBWSxFQUFFLFFBQWtCO1FBQ25ELE1BQU0sVUFBVSxHQUFHLElBQUksQ0FBQyxZQUFZLENBQUMsY0FBYyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUM7WUFDOUYsQ0FBQyxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUMsY0FBYyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDO1lBQzNELENBQUMsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLGFBQWEsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBRTdELFVBQVUsQ0FBQyxvQkFBb0IsQ0FBQyxJQUFJLEVBQUUsUUFBUSxDQUFDLENBQUM7UUFFaEQsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNILG9CQUFvQixDQUFDLElBQVksRUFBRSxRQUFrQixFQUFFLFFBQTBCO1FBQy9FLE1BQU0sVUFBVSxHQUFHLElBQUksQ0FBQyxZQUFZLENBQUMsY0FBYyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUM7WUFDOUYsQ0FBQyxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUMsY0FBYyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDO1lBQzNELENBQUMsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLGFBQWEsQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBRTdELFVBQVUsQ0FBQyxvQkFBb0IsQ0FBQyxJQUFJLEVBQUUsUUFBUSxFQUFFLFFBQVEsQ0FBQyxDQUFDO1FBRTFELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7Ozs7T0FTRztJQUNILG1CQUFtQixDQUFDLElBQVksRUFBRSxVQUEyQjtRQUMzRCxJQUFJLENBQUMsWUFBWSxDQUFDLEtBQUssQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLG1CQUFtQixDQUFDLElBQUksRUFBRSxVQUFVLENBQUMsQ0FBQztRQUV2RixPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7Q0FDRjtBQTNQRCxvQ0EyUEMifQ==

package/dist/builder/types.d.ts

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

package/dist/builder/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYnVpbGRlci90eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import Agent from './builder/agent';
+export * from './types';
+export { default as Collection } from './builder/collection';
+export default Agent;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 = void 0;
+const agent_1 = __importDefault(require("./builder/agent"));
+__exportStar(require("./types"), exports);
+var collection_1 = require("./builder/collection");
+Object.defineProperty(exports, "Collection", { enumerable: true, get: function () { return __importDefault(collection_1).default; } });
+exports.default = agent_1.default;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLDREQUFvQztBQUVwQywwQ0FBd0I7QUFDeEIsbURBQTZEO0FBQXBELHlIQUFBLE9BQU8sT0FBYztBQUU5QixrQkFBZSxlQUFLLENBQUMifQ==

package/dist/types.d.ts

@@ -0,0 +1,22 @@
+/** Logger Level */
+export declare enum LoggerLevel {
+    Info = "info",
+    Warn = "warn",
+    Error = "error"
+}
+/** Logger */
+export declare type Logger = (level: LoggerLevel, message: unknown) => void;
+/** Options to configure behavior of an agent's forestadmin driver */
+export declare type AgentOptions = {
+    agentUrl: string;
+    authSecret: string;
+    clientId?: string;
+    envSecret: string;
+    forestServerUrl?: string;
+    logger?: Logger;
+    prefix?: string;
+    isProduction: boolean;
+    schemaPath?: string;
+    permissionsCacheDurationInSeconds?: number;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggerLevel = void 0;
+/** Logger Level */
+var LoggerLevel;
+(function (LoggerLevel) {
+    LoggerLevel["Info"] = "info";
+    LoggerLevel["Warn"] = "warn";
+    LoggerLevel["Error"] = "error";
+})(LoggerLevel = exports.LoggerLevel || (exports.LoggerLevel = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsbUJBQW1CO0FBQ25CLElBQVksV0FJWDtBQUpELFdBQVksV0FBVztJQUNyQiw0QkFBYSxDQUFBO0lBQ2IsNEJBQWEsQ0FBQTtJQUNiLDhCQUFlLENBQUE7QUFDakIsQ0FBQyxFQUpXLFdBQVcsR0FBWCxtQkFBVyxLQUFYLG1CQUFXLFFBSXRCIn0=

package/dist/utils/csv-generator.d.ts

@@ -0,0 +1,12 @@
+import { Collection, PaginatedFilter, Projection } from '@forestadmin/datasource-toolkit';
+export declare const CHUNK_SIZE = 1000;
+export default class CsvGenerator {
+    /**
+     * Use an async generator to ensure that
+     * - backpressure is properly applied without needing to extend Readable (for slow clients)
+     * - we stop making queries to the database if the client closes the connection.
+     */
+    static generate(projection: Projection, header: string, filter: PaginatedFilter, collection: Collection, list: Collection['list']): AsyncGenerator<string>;
+    private static convert;
+}
+//# sourceMappingURL=csv-generator.d.ts.map

package/dist/utils/csv-generator.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CHUNK_SIZE = void 0;
+const datasource_toolkit_1 = require("@forestadmin/datasource-toolkit");
+const format_1 = require("@fast-csv/format");
+exports.CHUNK_SIZE = 1000;
+class CsvGenerator {
+    /**
+     * Use an async generator to ensure that
+     * - backpressure is properly applied without needing to extend Readable (for slow clients)
+     * - we stop making queries to the database if the client closes the connection.
+     */
+    static async *generate(projection, header, filter, collection, list) {
+        yield (0, format_1.writeToString)([header.split(',')], { headers: true, includeEndRowDelimiter: true });
+        const limit = filter.page?.limit;
+        let skip = filter.page?.skip || 0;
+        let areAllRecordsFetched = false;
+        const copiedFilter = { ...filter };
+        while (!areAllRecordsFetched) {
+            let currentPageSize = exports.CHUNK_SIZE;
+            if (limit < skip)
+                currentPageSize = skip - limit;
+            copiedFilter.page = new datasource_toolkit_1.Page(skip, currentPageSize);
+            if (!copiedFilter.sort || copiedFilter.sort.length === 0) {
+                copiedFilter.sort = datasource_toolkit_1.SortFactory.byPrimaryKeys(collection);
+            }
+            // eslint-disable-next-line no-await-in-loop
+            const records = await list(new datasource_toolkit_1.PaginatedFilter(copiedFilter), projection);
+            yield CsvGenerator.convert(records, projection);
+            areAllRecordsFetched = records.length < exports.CHUNK_SIZE;
+            skip += currentPageSize;
+        }
+    }
+    static convert(records, projection) {
+        return (0, format_1.writeToString)(records.map(record => projection.map(field => datasource_toolkit_1.RecordUtils.getFieldValue(record, field))));
+    }
+}
+exports.default = CsvGenerator;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY3N2LWdlbmVyYXRvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy91dGlscy9jc3YtZ2VuZXJhdG9yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLHdFQVF5QztBQUN6Qyw2Q0FBaUQ7QUFFcEMsUUFBQSxVQUFVLEdBQUcsSUFBSSxDQUFDO0FBRS9CLE1BQXFCLFlBQVk7SUFDL0I7Ozs7T0FJRztJQUNILE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxRQUFRLENBQ3BCLFVBQXNCLEVBQ3RCLE1BQWMsRUFDZCxNQUF1QixFQUN2QixVQUFzQixFQUN0QixJQUF3QjtRQUV4QixNQUFNLElBQUEsc0JBQWEsRUFBQyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsRUFBRSxFQUFFLE9BQU8sRUFBRSxJQUFJLEVBQUUsc0JBQXNCLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztRQUUxRixNQUFNLEtBQUssR0FBRyxNQUFNLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQztRQUNqQyxJQUFJLElBQUksR0FBRyxNQUFNLENBQUMsSUFBSSxFQUFFLElBQUksSUFBSSxDQUFDLENBQUM7UUFFbEMsSUFBSSxvQkFBb0IsR0FBRyxLQUFLLENBQUM7UUFDakMsTUFBTSxZQUFZLEdBQUcsRUFBRSxHQUFHLE1BQU0sRUFBRSxDQUFDO1FBRW5DLE9BQU8sQ0FBQyxvQkFBb0IsRUFBRTtZQUM1QixJQUFJLGVBQWUsR0FBRyxrQkFBVSxDQUFDO1lBQ2pDLElBQUksS0FBSyxHQUFHLElBQUk7Z0JBQUUsZUFBZSxHQUFHLElBQUksR0FBRyxLQUFLLENBQUM7WUFFakQsWUFBWSxDQUFDLElBQUksR0FBRyxJQUFJLHlCQUFJLENBQUMsSUFBSSxFQUFFLGVBQWUsQ0FBQyxDQUFDO1lBRXBELElBQUksQ0FBQyxZQUFZLENBQUMsSUFBSSxJQUFJLFlBQVksQ0FBQyxJQUFJLENBQUMsTUFBTSxLQUFLLENBQUMsRUFBRTtnQkFDeEQsWUFBWSxDQUFDLElBQUksR0FBRyxnQ0FBVyxDQUFDLGFBQWEsQ0FBQyxVQUFVLENBQUMsQ0FBQzthQUMzRDtZQUVELDRDQUE0QztZQUM1QyxNQUFNLE9BQU8sR0FBRyxNQUFNLElBQUksQ0FBQyxJQUFJLG9DQUFlLENBQUMsWUFBWSxDQUFDLEVBQUUsVUFBVSxDQUFDLENBQUM7WUFFMUUsTUFBTSxZQUFZLENBQUMsT0FBTyxDQUFDLE9BQU8sRUFBRSxVQUFVLENBQUMsQ0FBQztZQUVoRCxvQkFBb0IsR0FBRyxPQUFPLENBQUMsTUFBTSxHQUFHLGtCQUFVLENBQUM7WUFDbkQsSUFBSSxJQUFJLGVBQWUsQ0FBQztTQUN6QjtJQUNILENBQUM7SUFFTyxNQUFNLENBQUMsT0FBTyxDQUFDLE9BQXFCLEVBQUUsVUFBc0I7UUFDbEUsT0FBTyxJQUFBLHNCQUFhLEVBQ2xCLE9BQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUMsZ0NBQVcsQ0FBQyxhQUFhLENBQUMsTUFBTSxFQUFFLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FDekYsQ0FBQztJQUNKLENBQUM7Q0FDRjtBQTlDRCwrQkE4Q0MifQ==

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@forestadmin/agent",
+  "version": "1.0.0-beta.1",
+  "main": "dist/index.js",
+  "license": "GPL-3.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ForestAdmin/agent-nodejs.git",
+    "directory": "packages/agent"
+  },
+  "dependencies": {
+    "@fast-csv/format": "^4.3.5",
+    "@forestadmin/datasource-toolkit": "^1.0.0-beta.1",
+    "@koa/cors": "^3.1.0",
+    "@koa/router": "^10.1.1",
+    "forest-ip-utils": "^1.0.1",
+    "json-api-serializer": "^2.6.6",
+    "json-stringify-pretty-compact": "^3.0.0",
+    "jsonwebtoken": "^8.5.1",
+    "koa": "^2.13.4",
+    "koa-bodyparser": "^4.3.0",
+    "koa-jwt": "^4.0.3",
+    "lru-cache": "^7.3.1",
+    "luxon": "^2.3.0",
+    "object-hash": "^2.2.0",
+    "openid-client": "5.1.3",
+    "superagent": "^7.0.1",
+    "uuid": "^8.3.2"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "clean": "rm -rf coverage dist",
+    "lint": "eslint src test",
+    "test": "jest"
+  },
+  "devDependencies": {
+    "@shopify/jest-koa-mocks": "^3.1.0",
+    "@types/json-api-serializer": "2.6.3",
+    "@types/jsonwebtoken": "^8.5.8",
+    "@types/koa": "^2.13.4",
+    "@types/koa-bodyparser": "^4.3.5",
+    "@types/koa__cors": "^3.1.1",
+    "@types/koa__router": "^8.0.11",
+    "@types/superagent": "^4.1.15",
+    "fishery": "^2.1.0"
+  }
+}