@jsynple/core/dist/repositories/utils/Repository.js

All the core modules and types for the Synple application

import { BaseRepository } from "./BaseRepository";
import { omit, pick } from 'lodash';
/**
 * This class is used by most repositories as it provides classic CRUD actions on a resource.
 * It can be parameterized with two generic types, the first one being the actual type that
 * read methods MUST return, representing the resource itsef. The second one being the payload
 * that MUST be sent when creating a resource, sometimes different from the actual form of the
 * resource (for example in case of login sessions), sometimes not.
 * @author Vincent Courtois <courtois.vincent@outlook.com>
 */
export class Repository extends BaseRepository {
    /**
     * Transforms a creation payload in an actual instance of the resource by calling the POST /
     * endpoint on the corresponding API resource.
     *
     * @param payload The elements needed to create the instance of the resource.
     * @returns The created instance of the resource with all fields duely filled.
     */
    async create(payload, token) {
        return (await this.api.post(this.uri(), this.enrich(payload, token))).json();
    }
    /**
     * List all the instances of a resource respecting a series of criteria. Every instance
     * corresponding to ALL the criterias will be sent in the response from the API.
     *
     * @param payload The filtering criteria applied to this listing search.
     * @returns an array of results getting the list of elements requested.
     */
    async list(token, payload = {}) {
        return (await this.api.get(this.uri(), this.enrich(payload, token))).json();
    }
    /**
     * Gets one instance of the resource on the API, searched by its unique identifier.
     *
     * @param id The Unique Identifier for this instance of the resource.
     * @returns The whole instance, formatted as returned by the API.
     */
    async get(id, token) {
        return (await this.api.get(this.uri(id), this.enrich({}, token))).json();
    }
    async delete(id, token) {
        return (await this.api.delete(this.uri(id), this.enrich({}, token))).json();
    }
    /**
     * Updates an instance of a model on the API by formatting, limiting, and sending its object representation
     * to the API so that it can be further queried on the backend.
     *
     * @param payload The instance of the resource to update the fields of.
     * @param keys an array of keys available in the instance of the resource to limit the update to them.
     * @returns the updated version of the record after API request and response.
     */
    async update(payload, token, keys) {
        const filtered = omit(keys ? pick(payload, keys) : payload, 'id');
        return (await this.api.put(this.uri(payload.id), this.enrich(filtered, token))).json();
    }
    enrich(payload, token) {
        return { auth_token: token, ...payload };
    }
}