@forestadmin/agent 1.0.0-beta.8 → 1.0.0

package/dist/builder/collection.js

@@ -1,226 +0,0 @@
-"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

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

package/dist/builder/types.js

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