@forestadmin/datasource-toolkit - npm Package Compare versions

Comparing version 1.0.0-beta.21 to 1.0.0-beta.22

CHANGELOG.md

@@ -0,1 +1,8 @@
+# @forestadmin/datasource-toolkit [1.0.0-beta.22](https://github.com/ForestAdmin/agent-nodejs/compare/@forestadmin/datasource-toolkit@1.0.0-beta.21...@forestadmin/datasource-toolkit@1.0.0-beta.22) (2022-06-09)
+
+
+### Bug Fixes
+
+* **decorators:** remove useless isRequired field ([#337](https://github.com/ForestAdmin/agent-nodejs/issues/337)) ([ed9dd04](https://github.com/ForestAdmin/agent-nodejs/commit/ed9dd040bea1fa9c07aaaf1bf634e45bd62827df))
+
 # @forestadmin/datasource-toolkit [1.0.0-beta.21](https://github.com/ForestAdmin/agent-nodejs/compare/@forestadmin/datasource-toolkit@1.0.0-beta.20...@forestadmin/datasource-toolkit@1.0.0-beta.21) (2022-06-01)
@@ -2,0 +9,0 @@

dist/src/context/relaxed-wrappers/collection.d.ts

@@ -14,8 +14,100 @@ import { ActionField, ActionResult } from '../../interfaces/action';
     constructor(collection: Collection, caller: Caller);
+    /**
+     * Execute a given action
+     * @param name the name of the action
+     * @param formValues the values of the form, if the action rely on an action form
+     * @param filter the filter used to represent the selected records to use the action on
+     * @example
+     * .execute(
+     *    'Refund',
+     *    { reason: 'Article is broken' },
+     *    {
+     *      conditionTree: {
+     *        field: 'id',
+     *        operator: 'Equal',
+     *        value: 1
+     *      }
+     *    }
+     * );
+     */
     execute(name: string, formValues: RecordData, filter?: PlainFilter<S, N>): Promise<ActionResult>;
     getForm(name: string, formValues?: RecordData, filter?: PlainFilter<S, N>): Promise<ActionField[]>;
+    /**
+     * Create a list of records
+     * @param data An array of records to create
+     * @example
+     * .create([
+     *    { amountInEur: 150, description: 'Buy dvd' },
+     *    { amountInEur: -100, description: 'Refund' },
+     * ]);
+     */
     create(data: TSimpleRow<S, N>[]): Promise<TSimpleRow<S, N>[]>;
+    /**
+     * List multiple records
+     * @param filter the filter used to select the records to list
+     * @param projection an array of fields name representing the data to select
+     * @example
+     * .list({
+     *    conditionTree: {
+     *      aggregator: 'And',
+     *      conditions: [{
+     *        field: 'amountInEur',
+     *        operator: 'GreaterThan',
+     *        value: 1000
+     *      }, {
+     *        field: 'description',
+     *        operator: 'Contains',
+     *        value: 'Refund',
+     *      }],
+     *      page: { limit: 10, skip: 0 },
+     *      sort: [{ field: 'id', ascending: true }]
+     *   }
+     * }, ['id', 'amountInEur', 'description']);
+     */
     list(filter: PlainPaginatedFilter<S, N>, projection: TFieldName<S, N>[]): Promise<TRow<S, N>[]>;
+    /**
+     * Update a list of records
+     * @param filter the filter that represent the list of records to update
+     * @param patch the patch to apply on the selected records
+     * @example
+     * .update({
+     *    conditionTree: {
+     *      field: 'isActive',
+     *      operator: 'Equal',
+     *      value: false
+     *    },
+     * }, { isActive: true });
+     */
     update(filter: PlainFilter<S, N>, patch: TPartialSimpleRow<S, N>): Promise<void>;
+    /**
+     * Delete a list of records
+     * @param filter the filter that represent the list of records to update
+     * @example
+     * .delete({
+     *    conditionTree: {
+     *      field: 'isBlocked',
+     *      operator: 'Equal',
+     *      value: false,
+     *    },
+     * });
+     */
     delete(filter: PlainFilter<S, N>): Promise<void>;
+    /**
+     * Aggregate a list of records
+     * @param filter the filter used to list the records to aggregate
+     * @param aggregation the aggregation to apply
+     * @param limit the maximum number of result to return
+     * @example
+     * .aggregate({
+     *    conditionTree: {
+     *      field: "user:company:id",
+     *      operator: "In",
+     *      value: records.map((r) => r.id),
+     *    },
+     * }, {
+     *    operation: "Sum",
+     *    field: "amountInEur",
+     *    groups: [{ field: "user:company:id" }],
+     * }, 10);
+     */
     aggregate(filter: PlainFilter<S, N>, aggregation: PlainAggregation<S, N>, limit?: number): Promise<AggregateResult<S, N>[]>;
@@ -22,0 +114,0 @@ private buildFilter;

dist/src/context/relaxed-wrappers/collection.js

@@ -19,2 +19,20 @@ "use strict";
     }
+    /**
+     * Execute a given action
+     * @param name the name of the action
+     * @param formValues the values of the form, if the action rely on an action form
+     * @param filter the filter used to represent the selected records to use the action on
+     * @example
+     * .execute(
+     *    'Refund',
+     *    { reason: 'Article is broken' },
+     *    {
+     *      conditionTree: {
+     *        field: 'id',
+     *        operator: 'Equal',
+     *        value: 1
+     *      }
+     *    }
+     * );
+     */
     execute(name, formValues, filter) {
@@ -28,5 +46,36 @@ const filterInstance = this.buildFilter(filter);
     }
+    /**
+     * Create a list of records
+     * @param data An array of records to create
+     * @example
+     * .create([
+     *    { amountInEur: 150, description: 'Buy dvd' },
+     *    { amountInEur: -100, description: 'Refund' },
+     * ]);
+     */
     create(data) {
         return this.collection.create(this.caller, data);
     }
+    /**
+     * List multiple records
+     * @param filter the filter used to select the records to list
+     * @param projection an array of fields name representing the data to select
+     * @example
+     * .list({
+     *    conditionTree: {
+     *      aggregator: 'And',
+     *      conditions: [{
+     *        field: 'amountInEur',
+     *        operator: 'GreaterThan',
+     *        value: 1000
+     *      }, {
+     *        field: 'description',
+     *        operator: 'Contains',
+     *        value: 'Refund',
+     *      }],
+     *      page: { limit: 10, skip: 0 },
+     *      sort: [{ field: 'id', ascending: true }]
+     *   }
+     * }, ['id', 'amountInEur', 'description']);
+     */
     list(filter, projection) {
@@ -38,2 +87,15 @@ const filterInstance = this.buildPaginatedFilter(filter);
     }
+    /**
+     * Update a list of records
+     * @param filter the filter that represent the list of records to update
+     * @param patch the patch to apply on the selected records
+     * @example
+     * .update({
+     *    conditionTree: {
+     *      field: 'isActive',
+     *      operator: 'Equal',
+     *      value: false
+     *    },
+     * }, { isActive: true });
+     */
     update(filter, patch) {
@@ -43,2 +105,14 @@ const filterInstance = this.buildFilter(filter);
     }
+    /**
+     * Delete a list of records
+     * @param filter the filter that represent the list of records to update
+     * @example
+     * .delete({
+     *    conditionTree: {
+     *      field: 'isBlocked',
+     *      operator: 'Equal',
+     *      value: false,
+     *    },
+     * });
+     */
     delete(filter) {
@@ -48,2 +122,20 @@ const filterInstance = this.buildFilter(filter);
     }
+    /**
+     * Aggregate a list of records
+     * @param filter the filter used to list the records to aggregate
+     * @param aggregation the aggregation to apply
+     * @param limit the maximum number of result to return
+     * @example
+     * .aggregate({
+     *    conditionTree: {
+     *      field: "user:company:id",
+     *      operator: "In",
+     *      value: records.map((r) => r.id),
+     *    },
+     * }, {
+     *    operation: "Sum",
+     *    field: "amountInEur",
+     *    groups: [{ field: "user:company:id" }],
+     * }, 10);
+     */
     aggregate(filter, aggregation, limit) {
@@ -82,2 +174,2 @@ const filterInstance = this.buildFilter(filter);
 exports.default = RelaxedCollection;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29sbGVjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9jb250ZXh0L3JlbGF4ZWQtd3JhcHBlcnMvY29sbGVjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQVlBLHFGQUFvRztBQUNwRyw0RkFBaUY7QUFDakYsNEZBQWdGO0FBQ2hGLHVFQUErQztBQUMvQyx3RkFBZ0c7QUFDaEcsbUZBQTJEO0FBQzNELHVFQUErQztBQUUvQyxvRUFBb0U7QUFDcEUsTUFBcUIsaUJBQWlCO0lBT3BDLFlBQVksVUFBc0IsRUFBRSxNQUFjO1FBQ2hELElBQUksQ0FBQyxVQUFVLEdBQUcsVUFBVSxDQUFDO1FBQzdCLElBQUksQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDO0lBQ3ZCLENBQUM7SUFFRCxPQUFPLENBQUMsSUFBWSxFQUFFLFVBQXNCLEVBQUUsTUFBMEI7UUFDdEUsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUVoRCxPQUFPLElBQUksQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsSUFBSSxFQUFFLFVBQVUsRUFBRSxjQUFjLENBQUMsQ0FBQztJQUNoRixDQUFDO0lBRUQsT0FBTyxDQUNMLElBQVksRUFDWixVQUF1QixFQUN2QixNQUEwQjtRQUUxQixNQUFNLGNBQWMsR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBRWhELE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLEVBQUUsVUFBVSxFQUFFLGNBQWMsQ0FBQyxDQUFDO0lBQ2hGLENBQUM7SUFFRCxNQUFNLENBQUMsSUFBd0I7UUFDN0IsT0FBTyxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLElBQUksQ0FBZ0MsQ0FBQztJQUNsRixDQUFDO0lBRUQsSUFBSSxDQUFDLE1BQWtDLEVBQUUsVUFBOEI7UUFDckUsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLG9CQUFvQixDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQ3pELE1BQU0sa0JBQWtCLEdBQUcsSUFBSSxDQUFDLGVBQWUsQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUM1RCxNQUFNLElBQUksR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLGNBQWMsRUFBRSxrQkFBa0IsQ0FBQyxDQUFDO1FBRW5GLE9BQU8sSUFBNkIsQ0FBQztJQUN2QyxDQUFDO0lBRUQsTUFBTSxDQUFDLE1BQXlCLEVBQUUsS0FBOEI7UUFDOUQsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUVoRCxPQUFPLElBQUksQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsY0FBYyxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQ3BFLENBQUM7SUFFRCxNQUFNLENBQUMsTUFBeUI7UUFDOUIsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUVoRCxPQUFPLElBQUksQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsY0FBYyxDQUFDLENBQUM7SUFDN0QsQ0FBQztJQUVELFNBQVMsQ0FDUCxNQUF5QixFQUN6QixXQUFtQyxFQUNuQyxLQUFjO1FBRWQsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUNoRCxNQUFNLG1CQUFtQixHQUFHLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUUvRCxPQUFPLElBQUksQ0FBQyxVQUFVLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsY0FBYyxFQUFFLG1CQUFtQixFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQzVGLENBQUM7SUFFTyxXQUFXLENBQUMsTUFBeUI7UUFDM0MsT0FBTyxNQUFNO1lBQ1gsQ0FBQyxDQUFDLElBQUkscUJBQU0sQ0FBQztnQkFDVCxHQUFHLE1BQU07Z0JBQ1QsYUFBYSxFQUFFLE1BQU0sQ0FBQyxhQUFhO29CQUNqQyxDQUFDLENBQUMsaUJBQW9CLENBQUMsZUFBZSxDQUFDLE1BQU0sQ0FBQyxhQUFhLENBQUM7b0JBQzVELENBQUMsQ0FBQyxTQUFTO2FBQ2QsQ0FBQztZQUNKLENBQUMsQ0FBQyxJQUFJLENBQUM7SUFDWCxDQUFDO0lBRU8sb0JBQW9CLENBQUMsTUFBa0M7UUFDN0QsT0FBTyxJQUFJLG1CQUFlLENBQUM7WUFDekIsR0FBRyxNQUFNO1lBQ1QsYUFBYSxFQUFFLE1BQU0sRUFBRSxhQUFhO2dCQUNsQyxDQUFDLENBQUMsaUJBQW9CLENBQUMsZUFBZSxDQUFDLE1BQU0sQ0FBQyxhQUFhLENBQUM7Z0JBQzVELENBQUMsQ0FBQyxTQUFTO1lBQ2IsSUFBSSxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLElBQUksY0FBSSxDQUFDLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTO1lBQ3hELElBQUksRUFBRSxNQUFNLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxJQUFJLGNBQUksQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxNQUFNLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTO1NBQzlFLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFTyxlQUFlLENBQUMsVUFBb0I7UUFDMUMsT0FBTyxJQUFJLG9CQUFVLENBQUMsR0FBRyxVQUFVLENBQUMsQ0FBQztJQUN2QyxDQUFDO0lBRU8sZ0JBQWdCLENBQUMsV0FBbUM7UUFDMUQsT0FBTyxJQUFJLHFCQUFXLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDdEMsQ0FBQztDQUNGO0FBNUZELG9DQTRGQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29sbGVjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9jb250ZXh0L3JlbGF4ZWQtd3JhcHBlcnMvY29sbGVjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQVlBLHFGQUFvRztBQUNwRyw0RkFBaUY7QUFDakYsNEZBQWdGO0FBQ2hGLHVFQUErQztBQUMvQyx3RkFBZ0c7QUFDaEcsbUZBQTJEO0FBQzNELHVFQUErQztBQUUvQyxvRUFBb0U7QUFDcEUsTUFBcUIsaUJBQWlCO0lBT3BDLFlBQVksVUFBc0IsRUFBRSxNQUFjO1FBQ2hELElBQUksQ0FBQyxVQUFVLEdBQUcsVUFBVSxDQUFDO1FBQzdCLElBQUksQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDO0lBQ3ZCLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7Ozs7Ozs7T0FpQkc7SUFDSCxPQUFPLENBQUMsSUFBWSxFQUFFLFVBQXNCLEVBQUUsTUFBMEI7UUFDdEUsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUVoRCxPQUFPLElBQUksQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsSUFBSSxFQUFFLFVBQVUsRUFBRSxjQUFjLENBQUMsQ0FBQztJQUNoRixDQUFDO0lBRUQsT0FBTyxDQUNMLElBQVksRUFDWixVQUF1QixFQUN2QixNQUEwQjtRQUUxQixNQUFNLGNBQWMsR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBRWhELE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLEVBQUUsVUFBVSxFQUFFLGNBQWMsQ0FBQyxDQUFDO0lBQ2hGLENBQUM7SUFFRDs7Ozs7Ozs7T0FRRztJQUNILE1BQU0sQ0FBQyxJQUF3QjtRQUM3QixPQUFPLElBQUksQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsSUFBSSxDQUFnQyxDQUFDO0lBQ2xGLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O09BcUJHO0lBQ0gsSUFBSSxDQUFDLE1BQWtDLEVBQUUsVUFBOEI7UUFDckUsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLG9CQUFvQixDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQ3pELE1BQU0sa0JBQWtCLEdBQUcsSUFBSSxDQUFDLGVBQWUsQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUM1RCxNQUFNLElBQUksR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLGNBQWMsRUFBRSxrQkFBa0IsQ0FBQyxDQUFDO1FBRW5GLE9BQU8sSUFBNkIsQ0FBQztJQUN2QyxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7OztPQVlHO0lBQ0gsTUFBTSxDQUFDLE1BQXlCLEVBQUUsS0FBOEI7UUFDOUQsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUVoRCxPQUFPLElBQUksQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsY0FBYyxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQ3BFLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7T0FXRztJQUNILE1BQU0sQ0FBQyxNQUF5QjtRQUM5QixNQUFNLGNBQWMsR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBRWhELE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxjQUFjLENBQUMsQ0FBQztJQUM3RCxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7Ozs7Ozs7O09BaUJHO0lBQ0gsU0FBUyxDQUNQLE1BQXlCLEVBQ3pCLFdBQW1DLEVBQ25DLEtBQWM7UUFFZCxNQUFNLGNBQWMsR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQ2hELE1BQU0sbUJBQW1CLEdBQUcsSUFBSSxDQUFDLGdCQUFnQixDQUFDLFdBQVcsQ0FBQyxDQUFDO1FBRS9ELE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxjQUFjLEVBQUUsbUJBQW1CLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFDNUYsQ0FBQztJQUVPLFdBQVcsQ0FBQyxNQUF5QjtRQUMzQyxPQUFPLE1BQU07WUFDWCxDQUFDLENBQUMsSUFBSSxxQkFBTSxDQUFDO2dCQUNULEdBQUcsTUFBTTtnQkFDVCxhQUFhLEVBQUUsTUFBTSxDQUFDLGFBQWE7b0JBQ2pDLENBQUMsQ0FBQyxpQkFBb0IsQ0FBQyxlQUFlLENBQUMsTUFBTSxDQUFDLGFBQWEsQ0FBQztvQkFDNUQsQ0FBQyxDQUFDLFNBQVM7YUFDZCxDQUFDO1lBQ0osQ0FBQyxDQUFDLElBQUksQ0FBQztJQUNYLENBQUM7SUFFTyxvQkFBb0IsQ0FBQyxNQUFrQztRQUM3RCxPQUFPLElBQUksbUJBQWUsQ0FBQztZQUN6QixHQUFHLE1BQU07WUFDVCxhQUFhLEVBQUUsTUFBTSxFQUFFLGFBQWE7Z0JBQ2xDLENBQUMsQ0FBQyxpQkFBb0IsQ0FBQyxlQUFlLENBQUMsTUFBTSxDQUFDLGFBQWEsQ0FBQztnQkFDNUQsQ0FBQyxDQUFDLFNBQVM7WUFDYixJQUFJLEVBQUUsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsSUFBSSxjQUFJLENBQUMsR0FBRyxNQUFNLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLFNBQVM7WUFDeEQsSUFBSSxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLElBQUksY0FBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLFNBQVM7U0FDOUUsQ0FBQyxDQUFDO0lBQ0wsQ0FBQztJQUVPLGVBQWUsQ0FBQyxVQUFvQjtRQUMxQyxPQUFPLElBQUksb0JBQVUsQ0FBQyxHQUFHLFVBQVUsQ0FBQyxDQUFDO0lBQ3ZDLENBQUM7SUFFTyxnQkFBZ0IsQ0FBQyxXQUFtQztRQUMxRCxPQUFPLElBQUkscUJBQVcsQ0FBQyxXQUFXLENBQUMsQ0FBQztJQUN0QyxDQUFDO0NBQ0Y7QUF4TEQsb0NBd0xDIn0=

dist/src/context/relaxed-wrappers/datasource.d.ts

@@ -10,4 +10,8 @@ import { Caller } from '../../interfaces/caller';
     constructor(dataSource: DataSource, caller: Caller);
+    /**
+     * Get a collection from a datasource
+     * @param name the name of the collection
+     */
     getCollection<N extends TCollectionName<S>>(name: N): RelaxedCollection<S, N>;
 }
 //# sourceMappingURL=datasource.d.ts.map

dist/src/context/relaxed-wrappers/datasource.js

@@ -13,2 +13,6 @@ "use strict";
     }
+    /**
+     * Get a collection from a datasource
+     * @param name the name of the collection
+     */
     getCollection(name) {
@@ -19,2 +23,2 @@ return new collection_1.default(this.dataSource.getCollection(name), this.caller);
 exports.default = RelaxedDataSource;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGF0YXNvdXJjZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9jb250ZXh0L3JlbGF4ZWQtd3JhcHBlcnMvZGF0YXNvdXJjZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUdBLDhEQUE2QztBQUU3QyxvRUFBb0U7QUFDcEUsTUFBcUIsaUJBQWlCO0lBSXBDLFlBQVksVUFBc0IsRUFBRSxNQUFjO1FBQ2hELElBQUksQ0FBQyxVQUFVLEdBQUcsVUFBVSxDQUFDO1FBQzdCLElBQUksQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDO0lBQ3ZCLENBQUM7SUFFRCxhQUFhLENBQStCLElBQU87UUFDakQsT0FBTyxJQUFJLG9CQUFpQixDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxFQUFFLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUNqRixDQUFDO0NBQ0Y7QUFaRCxvQ0FZQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGF0YXNvdXJjZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9jb250ZXh0L3JlbGF4ZWQtd3JhcHBlcnMvZGF0YXNvdXJjZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUdBLDhEQUE2QztBQUU3QyxvRUFBb0U7QUFDcEUsTUFBcUIsaUJBQWlCO0lBSXBDLFlBQVksVUFBc0IsRUFBRSxNQUFjO1FBQ2hELElBQUksQ0FBQyxVQUFVLEdBQUcsVUFBVSxDQUFDO1FBQzdCLElBQUksQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDO0lBQ3ZCLENBQUM7SUFFRDs7O09BR0c7SUFDSCxhQUFhLENBQStCLElBQU87UUFDakQsT0FBTyxJQUFJLG9CQUFpQixDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxFQUFFLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUNqRixDQUFDO0NBQ0Y7QUFoQkQsb0NBZ0JDIn0=

dist/src/decorators/actions/context/base.d.ts

@@ -13,4 +13,16 @@ import { Caller } from '../../../interfaces/caller';
     constructor(collection: Collection, caller: Caller, formValue: RecordData, filter: PlainFilter<S, N>, used?: Set<string>);
+    /**
+     * Get all the records selected by an action
+     * @param fields An array of fields needed in the response
+     * @example
+     * .getRecords(['id', 'isActive', 'name']);
+     */
     getRecords(fields: TFieldName<S, N>[]): Promise<TRow<S, N>[]>;
+    /**
+     * Get all the records ids selected by an action
+     */
     getRecordIds(): Promise<Array<string | number>>;
+    /**
+     * Get all the records ids (when the collection uses composite keys)
+     */
     getCompositeRecordIds(): Promise<CompositeId[]>;
@@ -17,0 +29,0 @@ private runQuery;

dist/src/decorators/actions/context/base.js

@@ -31,2 +31,8 @@ "use strict";
     }
+    /**
+     * Get all the records selected by an action
+     * @param fields An array of fields needed in the response
+     * @example
+     * .getRecords(['id', 'isActive', 'name']);
+     */
     async getRecords(fields) {
@@ -53,2 +59,5 @@ // This function just queues the request into this.queries, so that we can merge all calls
     }
+    /**
+     * Get all the records ids selected by an action
+     */
     async getRecordIds() {
@@ -58,2 +67,5 @@ const compositeIds = await this.getCompositeRecordIds();
     }
+    /**
+     * Get all the records ids (when the collection uses composite keys)
+     */
     async getCompositeRecordIds() {
@@ -90,2 +102,2 @@ const projection = new projection_1.default().withPks(this.realCollection);
 exports.default = ActionContext;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9kZWNvcmF0b3JzL2FjdGlvbnMvY29udGV4dC9iYXNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBS0EsNkZBQWlGO0FBQ2pGLGlFQUE0QztBQUM1QyxzRkFBOEQ7QUFDOUQsZ0ZBQWlFO0FBQ2pFLG1FQUFnRDtBQUVoRCxNQUFxQixhQUduQixTQUFRLDRCQUFvQztJQU81QyxZQUNFLFVBQXNCLEVBQ3RCLE1BQWMsRUFDZCxTQUFxQixFQUNyQixNQUF5QixFQUN6QixJQUFrQjtRQUVsQixLQUFLLENBQUMsVUFBVSxFQUFFLE1BQU0sQ0FBQyxDQUFDO1FBQzFCLElBQUksQ0FBQyxVQUFVLEdBQUcsU0FBUyxDQUFDO1FBQzVCLElBQUksQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDO1FBQ3JCLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUViLDhEQUE4RDtRQUM5RCxJQUFJLElBQUksRUFBRTtZQUNSLElBQUksQ0FBQyxVQUFVLEdBQUcsSUFBSSxLQUFLLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRTtnQkFDM0MsR0FBRyxFQUFFLENBQUMsTUFBTSxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsRUFBRTtvQkFDOUIsSUFBSSxPQUFPLElBQUksS0FBSyxRQUFRO3dCQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7b0JBRTdDLE9BQU8sT0FBTyxDQUFDLEdBQUcsQ0FBQyxNQUFNLEVBQUUsSUFBSSxFQUFFLFFBQVEsQ0FBQyxDQUFDO2dCQUM3QyxDQUFDO2dCQUNELEdBQUcsRUFBRSxHQUFHLEVBQUU7b0JBQ1IsTUFBTSxJQUFJLEtBQUssQ0FBQyx3QkFBd0IsQ0FBQyxDQUFDO2dCQUM1QyxDQUFDO2FBQ0YsQ0FBQyxDQUFDO1NBQ0o7SUFDSCxDQUFDO0lBRUQsS0FBSyxDQUFDLFVBQVUsQ0FBQyxNQUEwQjtRQUN6QywwRkFBMEY7UUFDMUYscUNBQXFDO1FBRXJDLDJGQUEyRjtRQUMzRix5RkFBeUY7UUFDekYsd0JBQXdCO1FBRXhCLCtGQUErRjtRQUMvRiwrQkFBK0I7UUFDL0Isd0RBQXdEO1FBQ3hELEVBQUU7UUFDRiw2Q0FBNkM7UUFDN0MsaUVBQWlFO1FBRWpFLG9CQUFtQixDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsY0FBYyxFQUFFLE1BQU0sQ0FBQyxDQUFDO1FBRTFELE1BQU0sUUFBUSxHQUFHLElBQUksZUFBUSxFQUFnQixDQUFDO1FBQzlDLE1BQU0sVUFBVSxHQUFHLElBQUksb0JBQVUsQ0FBQyxHQUFHLE1BQU0sQ0FBQyxDQUFDO1FBRTdDLElBQUksSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLEtBQUssQ0FBQztZQUFFLFVBQVUsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxJQUFJLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQztRQUNqRSxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxFQUFFLFVBQVUsRUFBRSxRQUFRLEVBQUUsQ0FBQyxDQUFDO1FBQzVDLElBQUksQ0FBQyxVQUFVLEdBQUcsSUFBSSxDQUFDLFVBQVUsQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLENBQUM7UUFFcEQsT0FBTyxRQUFRLENBQUMsT0FBTyxDQUFDO0lBQzFCLENBQUM7SUFFRCxLQUFLLENBQUMsWUFBWTtRQUNoQixNQUFNLFlBQVksR0FBRyxNQUFNLElBQUksQ0FBQyxxQkFBcUIsRUFBRSxDQUFDO1FBRXhELE9BQU8sWUFBWSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3ZDLENBQUM7SUFFRCxLQUFLLENBQUMscUJBQXFCO1FBQ3pCLE1BQU0sVUFBVSxHQUFHLElBQUksb0JBQVUsRUFBRSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFhLENBQUM7UUFDN0UsTUFBTSxPQUFPLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLFVBQWdDLENBQUMsQ0FBQztRQUV4RSxPQUFPLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxnQkFBVyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3BGLENBQUM7SUFFTyxLQUFLLENBQUMsUUFBUTtRQUNwQixNQUFNLEVBQUUsT0FBTyxFQUFFLFVBQVUsRUFBRSxHQUFHLElBQUksQ0FBQztRQUNyQyxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7UUFFYixJQUFJO1lBQ0YsbUZBQW1GO1lBQ25GLHlDQUF5QztZQUN6QyxNQUFNLE9BQU8sR0FBRyxNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUN4QyxJQUFJLENBQUMsTUFBTSxFQUNYLFVBQTRDLENBQzdDLENBQUM7WUFFRixrRUFBa0U7WUFDbEUsS0FBSyxNQUFNLEtBQUssSUFBSSxPQUFPO2dCQUFFLEtBQUssQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7U0FDdEY7UUFBQyxPQUFPLENBQUMsRUFBRTtZQUNWLHVDQUF1QztZQUV2Qyx1RkFBdUY7WUFDdkYseUJBQXlCO1lBQ3pCLEtBQUssTUFBTSxLQUFLLElBQUksT0FBTyxFQUFFO2dCQUMzQixPQUFPLENBQUMsUUFBUSxDQUFDLEdBQUcsRUFBRSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7YUFDbEQ7U0FDRjtJQUNILENBQUM7SUFFTyxLQUFLO1FBQ1gsSUFBSSxDQUFDLE9BQU8sR0FBRyxFQUFFLENBQUM7UUFDbEIsSUFBSSxDQUFDLFVBQVUsR0FBRyxJQUFJLG9CQUFVLEVBQUUsQ0FBQztJQUNyQyxDQUFDO0NBQ0Y7QUExR0QsZ0NBMEdDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9kZWNvcmF0b3JzL2FjdGlvbnMvY29udGV4dC9iYXNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBS0EsNkZBQWlGO0FBQ2pGLGlFQUE0QztBQUM1QyxzRkFBOEQ7QUFDOUQsZ0ZBQWlFO0FBQ2pFLG1FQUFnRDtBQUVoRCxNQUFxQixhQUduQixTQUFRLDRCQUFvQztJQU81QyxZQUNFLFVBQXNCLEVBQ3RCLE1BQWMsRUFDZCxTQUFxQixFQUNyQixNQUF5QixFQUN6QixJQUFrQjtRQUVsQixLQUFLLENBQUMsVUFBVSxFQUFFLE1BQU0sQ0FBQyxDQUFDO1FBQzFCLElBQUksQ0FBQyxVQUFVLEdBQUcsU0FBUyxDQUFDO1FBQzVCLElBQUksQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDO1FBQ3JCLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUViLDhEQUE4RDtRQUM5RCxJQUFJLElBQUksRUFBRTtZQUNSLElBQUksQ0FBQyxVQUFVLEdBQUcsSUFBSSxLQUFLLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRTtnQkFDM0MsR0FBRyxFQUFFLENBQUMsTUFBTSxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsRUFBRTtvQkFDOUIsSUFBSSxPQUFPLElBQUksS0FBSyxRQUFRO3dCQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7b0JBRTdDLE9BQU8sT0FBTyxDQUFDLEdBQUcsQ0FBQyxNQUFNLEVBQUUsSUFBSSxFQUFFLFFBQVEsQ0FBQyxDQUFDO2dCQUM3QyxDQUFDO2dCQUNELEdBQUcsRUFBRSxHQUFHLEVBQUU7b0JBQ1IsTUFBTSxJQUFJLEtBQUssQ0FBQyx3QkFBd0IsQ0FBQyxDQUFDO2dCQUM1QyxDQUFDO2FBQ0YsQ0FBQyxDQUFDO1NBQ0o7SUFDSCxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxLQUFLLENBQUMsVUFBVSxDQUFDLE1BQTBCO1FBQ3pDLDBGQUEwRjtRQUMxRixxQ0FBcUM7UUFFckMsMkZBQTJGO1FBQzNGLHlGQUF5RjtRQUN6Rix3QkFBd0I7UUFFeEIsK0ZBQStGO1FBQy9GLCtCQUErQjtRQUMvQix3REFBd0Q7UUFDeEQsRUFBRTtRQUNGLDZDQUE2QztRQUM3QyxpRUFBaUU7UUFFakUsb0JBQW1CLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxjQUFjLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFFMUQsTUFBTSxRQUFRLEdBQUcsSUFBSSxlQUFRLEVBQWdCLENBQUM7UUFDOUMsTUFBTSxVQUFVLEdBQUcsSUFBSSxvQkFBVSxDQUFDLEdBQUcsTUFBTSxDQUFDLENBQUM7UUFFN0MsSUFBSSxJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sS0FBSyxDQUFDO1lBQUUsVUFBVSxDQUFDLEdBQUcsRUFBRSxDQUFDLElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO1FBQ2pFLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEVBQUUsVUFBVSxFQUFFLFFBQVEsRUFBRSxDQUFDLENBQUM7UUFDNUMsSUFBSSxDQUFDLFVBQVUsR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUVwRCxPQUFPLFFBQVEsQ0FBQyxPQUFPLENBQUM7SUFDMUIsQ0FBQztJQUVEOztPQUVHO0lBQ0gsS0FBSyxDQUFDLFlBQVk7UUFDaEIsTUFBTSxZQUFZLEdBQUcsTUFBTSxJQUFJLENBQUMscUJBQXFCLEVBQUUsQ0FBQztRQUV4RCxPQUFPLFlBQVksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEVBQUUsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN2QyxDQUFDO0lBRUQ7O09BRUc7SUFDSCxLQUFLLENBQUMscUJBQXFCO1FBQ3pCLE1BQU0sVUFBVSxHQUFHLElBQUksb0JBQVUsRUFBRSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFhLENBQUM7UUFDN0UsTUFBTSxPQUFPLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLFVBQWdDLENBQUMsQ0FBQztRQUV4RSxPQUFPLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxnQkFBVyxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3BGLENBQUM7SUFFTyxLQUFLLENBQUMsUUFBUTtRQUNwQixNQUFNLEVBQUUsT0FBTyxFQUFFLFVBQVUsRUFBRSxHQUFHLElBQUksQ0FBQztRQUNyQyxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7UUFFYixJQUFJO1lBQ0YsbUZBQW1GO1lBQ25GLHlDQUF5QztZQUN6QyxNQUFNLE9BQU8sR0FBRyxNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUN4QyxJQUFJLENBQUMsTUFBTSxFQUNYLFVBQTRDLENBQzdDLENBQUM7WUFFRixrRUFBa0U7WUFDbEUsS0FBSyxNQUFNLEtBQUssSUFBSSxPQUFPO2dCQUFFLEtBQUssQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7U0FDdEY7UUFBQyxPQUFPLENBQUMsRUFBRTtZQUNWLHVDQUF1QztZQUV2Qyx1RkFBdUY7WUFDdkYseUJBQXlCO1lBQ3pCLEtBQUssTUFBTSxLQUFLLElBQUksT0FBTyxFQUFFO2dCQUMzQixPQUFPLENBQUMsUUFBUSxDQUFDLEdBQUcsRUFBRSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7YUFDbEQ7U0FDRjtJQUNILENBQUM7SUFFTyxLQUFLO1FBQ1gsSUFBSSxDQUFDLE9BQU8sR0FBRyxFQUFFLENBQUM7UUFDbEIsSUFBSSxDQUFDLFVBQVUsR0FBRyxJQUFJLG9CQUFVLEVBQUUsQ0FBQztJQUNyQyxDQUFDO0NBQ0Y7QUF0SEQsZ0NBc0hDIn0=

dist/src/decorators/actions/result-builder.d.ts

@@ -5,2 +5,9 @@ /// <reference types="node" />
 export default class ResultBuilder {
+    /**
+     * Returns a success response from the action
+     * @param message the success message to return
+     * @param options available options to return
+     * @example
+     * .success('<blinkee>Success!</blinkee>', { type: 'html' });
+     */
     success(message?: string, options?: {
@@ -10,7 +17,36 @@ type?: 'html' | 'text';
     }): ActionResult;
+    /**
+     * Returns an error response from the action
+     * @param message the error message to return
+     * @example
+     * .error('Failed to refund the customer!');
+     */
     error(message?: string): ActionResult;
+    /**
+     * Returns a webhook that the UI will trigger
+     * @param url the url of the webhook
+     * @param method the HTTP method of the webhook
+     * @param headers an object representing the list of headers to send with the webhook
+     * @param body an object representing the body of the HTTP request
+     * @example
+     * .webhook('http://my-company-name', 'POST', {}, { adminToken: 'my-admin-token' });
+     */
     webhook(url: string, method?: 'GET' | 'POST', headers?: Record<string, string>, body?: unknown): ActionResult;
+    /**
+     * Returns a file that will be downloaded
+     * @param streamOrBufferOrString the actual file to download
+     * @param name the name of the file
+     * @param mimeType the mime type of the file
+     * @example
+     * .file('This is my file content', 'download.txt', 'text/plain');
+     */
     file(streamOrBufferOrString: Readable | Uint8Array | string, name?: string, mimeType?: string): ActionResult;
+    /**
+     * Returns to the UI that a redirection is needed
+     * @param path the path to redirect to
+     * @example
+     * .redirectTo('https://www.google.com');
+     */
     redirectTo(path: string): ActionResult;
 }
 //# sourceMappingURL=result-builder.d.ts.map

dist/src/decorators/actions/result-builder.js

@@ -5,2 +5,9 @@ "use strict";
 class ResultBuilder {
+    /**
+     * Returns a success response from the action
+     * @param message the success message to return
+     * @param options available options to return
+     * @example
+     * .success('<blinkee>Success!</blinkee>', { type: 'html' });
+     */
     success(message, options) {
@@ -14,2 +21,8 @@ return {
     }
+    /**
+     * Returns an error response from the action
+     * @param message the error message to return
+     * @example
+     * .error('Failed to refund the customer!');
+     */
     error(message) {
@@ -21,2 +34,11 @@ return {
     }
+    /**
+     * Returns a webhook that the UI will trigger
+     * @param url the url of the webhook
+     * @param method the HTTP method of the webhook
+     * @param headers an object representing the list of headers to send with the webhook
+     * @param body an object representing the body of the HTTP request
+     * @example
+     * .webhook('http://my-company-name', 'POST', {}, { adminToken: 'my-admin-token' });
+     */
     webhook(url, method = 'POST', headers = {}, body = {}) {
@@ -31,2 +53,10 @@ return {
     }
+    /**
+     * Returns a file that will be downloaded
+     * @param streamOrBufferOrString the actual file to download
+     * @param name the name of the file
+     * @param mimeType the mime type of the file
+     * @example
+     * .file('This is my file content', 'download.txt', 'text/plain');
+     */
     file(streamOrBufferOrString, name = 'file', mimeType = 'application/octet-stream') {
@@ -42,2 +72,8 @@ return {
     }
+    /**
+     * Returns to the UI that a redirection is needed
+     * @param path the path to redirect to
+     * @example
+     * .redirectTo('https://www.google.com');
+     */
     redirectTo(path) {
@@ -48,2 +84,2 @@ return { type: 'Redirect', path };
 exports.default = ResultBuilder;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVzdWx0LWJ1aWxkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvZGVjb3JhdG9ycy9hY3Rpb25zL3Jlc3VsdC1idWlsZGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsbUNBQWtDO0FBSWxDLE1BQXFCLGFBQWE7SUFDaEMsT0FBTyxDQUNMLE9BQWdCLEVBQ2hCLE9BQTREO1FBRTVELE9BQU87WUFDTCxJQUFJLEVBQUUsU0FBUztZQUNmLE9BQU8sRUFBRSxPQUFPLElBQUksU0FBUztZQUM3QixNQUFNLEVBQUUsT0FBTyxFQUFFLElBQUksSUFBSSxNQUFNO1lBQy9CLFdBQVcsRUFBRSxJQUFJLEdBQUcsQ0FBQyxPQUFPLEVBQUUsV0FBVyxJQUFJLEVBQUUsQ0FBQztTQUNqRCxDQUFDO0lBQ0osQ0FBQztJQUVELEtBQUssQ0FBQyxPQUFnQjtRQUNwQixPQUFPO1lBQ0wsSUFBSSxFQUFFLE9BQU87WUFDYixPQUFPLEVBQUUsT0FBTyxJQUFJLE9BQU87U0FDNUIsQ0FBQztJQUNKLENBQUM7SUFFRCxPQUFPLENBQ0wsR0FBVyxFQUNYLFNBQXlCLE1BQU0sRUFDL0IsVUFBa0MsRUFBRSxFQUNwQyxPQUFnQixFQUFFO1FBRWxCLE9BQU87WUFDTCxJQUFJLEVBQUUsU0FBUztZQUNmLEdBQUc7WUFDSCxNQUFNO1lBQ04sT0FBTztZQUNQLElBQUk7U0FDTCxDQUFDO0lBQ0osQ0FBQztJQUVELElBQUksQ0FDRixzQkFBc0QsRUFDdEQsSUFBSSxHQUFHLE1BQU0sRUFDYixRQUFRLEdBQUcsMEJBQTBCO1FBRXJDLE9BQU87WUFDTCxJQUFJLEVBQUUsTUFBTTtZQUNaLElBQUk7WUFDSixRQUFRO1lBQ1IsTUFBTSxFQUNKLHNCQUFzQixZQUFZLGlCQUFRO2dCQUN4QyxDQUFDLENBQUMsc0JBQXNCO2dCQUN4QixDQUFDLENBQUMsaUJBQVEsQ0FBQyxJQUFJLENBQUMsQ0FBQyxzQkFBc0IsQ0FBQyxDQUFDO1NBQzlDLENBQUM7SUFDSixDQUFDO0lBRUQsVUFBVSxDQUFDLElBQVk7UUFDckIsT0FBTyxFQUFFLElBQUksRUFBRSxVQUFVLEVBQUUsSUFBSSxFQUFFLENBQUM7SUFDcEMsQ0FBQztDQUNGO0FBdERELGdDQXNEQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVzdWx0LWJ1aWxkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvZGVjb3JhdG9ycy9hY3Rpb25zL3Jlc3VsdC1idWlsZGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsbUNBQWtDO0FBSWxDLE1BQXFCLGFBQWE7SUFDaEM7Ozs7OztPQU1HO0lBQ0gsT0FBTyxDQUNMLE9BQWdCLEVBQ2hCLE9BQTREO1FBRTVELE9BQU87WUFDTCxJQUFJLEVBQUUsU0FBUztZQUNmLE9BQU8sRUFBRSxPQUFPLElBQUksU0FBUztZQUM3QixNQUFNLEVBQUUsT0FBTyxFQUFFLElBQUksSUFBSSxNQUFNO1lBQy9CLFdBQVcsRUFBRSxJQUFJLEdBQUcsQ0FBQyxPQUFPLEVBQUUsV0FBVyxJQUFJLEVBQUUsQ0FBQztTQUNqRCxDQUFDO0lBQ0osQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsS0FBSyxDQUFDLE9BQWdCO1FBQ3BCLE9BQU87WUFDTCxJQUFJLEVBQUUsT0FBTztZQUNiLE9BQU8sRUFBRSxPQUFPLElBQUksT0FBTztTQUM1QixDQUFDO0lBQ0osQ0FBQztJQUVEOzs7Ozs7OztPQVFHO0lBQ0gsT0FBTyxDQUNMLEdBQVcsRUFDWCxTQUF5QixNQUFNLEVBQy9CLFVBQWtDLEVBQUUsRUFDcEMsT0FBZ0IsRUFBRTtRQUVsQixPQUFPO1lBQ0wsSUFBSSxFQUFFLFNBQVM7WUFDZixHQUFHO1lBQ0gsTUFBTTtZQUNOLE9BQU87WUFDUCxJQUFJO1NBQ0wsQ0FBQztJQUNKLENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0gsSUFBSSxDQUNGLHNCQUFzRCxFQUN0RCxJQUFJLEdBQUcsTUFBTSxFQUNiLFFBQVEsR0FBRywwQkFBMEI7UUFFckMsT0FBTztZQUNMLElBQUksRUFBRSxNQUFNO1lBQ1osSUFBSTtZQUNKLFFBQVE7WUFDUixNQUFNLEVBQ0osc0JBQXNCLFlBQVksaUJBQVE7Z0JBQ3hDLENBQUMsQ0FBQyxzQkFBc0I7Z0JBQ3hCLENBQUMsQ0FBQyxpQkFBUSxDQUFDLElBQUksQ0FBQyxDQUFDLHNCQUFzQixDQUFDLENBQUM7U0FDOUMsQ0FBQztJQUNKLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILFVBQVUsQ0FBQyxJQUFZO1FBQ3JCLE9BQU8sRUFBRSxJQUFJLEVBQUUsVUFBVSxFQUFFLElBQUksRUFBRSxDQUFDO0lBQ3BDLENBQUM7Q0FDRjtBQTFGRCxnQ0EwRkMifQ==

dist/src/decorators/computed/types.d.ts

@@ -7,3 +7,2 @@ import { ColumnType } from '../../interfaces/schema';
     readonly dependencies: TFieldName<S, N>[];
-    readonly isRequired?: boolean;
     readonly defaultValue?: unknown;
@@ -10,0 +9,0 @@ readonly enumValues?: string[];

package.json

 {
   "name": "@forestadmin/datasource-toolkit",
-  "version": "1.0.0-beta.21",
+  "version": "1.0.0-beta.22",
   "main": "dist/src/index.js",
@@ -5,0 +5,0 @@ "license": "GPL-3.0",

No alert changes

Improved metrics

Total package byte prevSize

499749

increased by1.99%

Lines of code

5254

increased by5.78%

No dependency changes