@mapomodule/core 1.0.0 → 2.0.0-beta.2

package/api/crud.js

@@ -1,141 +0,0 @@
-const transformRequestInMultipart = require('@mapomodule/core/api/multipart')
-const trimslashes = (str) => (str || "").replace(/^\/|\/$/g, '')
-const preparePayload = (payload, options) => {
-    const { multipart } = (options || {})
-    if (!(payload instanceof FormData) && multipart !== 'disable') {
-        payload = transformRequestInMultipart(payload, multipart || 'auto');
-    }
-    return payload
-}
-const endpointError = "This crud is badly configured. No endpoint was passed"
-
-/**
- * This function generates a fully functional crud helper given the endpoint.
- * 
- * @alias $api.crud
- * @param {string} endpoint This is the endpoint that will be used for all the methods exposed by this function.
- * @param {external:AxiosRequestConfig} [higherConf={}] This is an axios configuration object that allows you to inject all the additional options you want.
- * 
- */
-const createRepository = ($axios) => (endpoint, higherConf = {}) => ({
-    /**
-     * This makes a GET http call to the crud endpoint. Returns as a promise the server response.
-     * @alias $api.crud.list
-     * @param {external:AxiosRequestConfig} [config]
-     * @returns {Promise<external:AxiosResponse>}
-     */
-    list(config) {
-        const func = $axios.$get(`/${trimslashes(endpoint)}/`, { ...higherConf, ...config })
-        return endpoint !== null ? func : Promise.reject(endpointError)
-    },
-
-    /**
-     * This makes a POST http call with the data specified in the payload to the crud endpoint. Returns as a promise the server response.
-     * @alias $api.crud.create
-     * @param {Object} payload The payload containing the data that we want to send.
-     * @param {external:AxiosRequestConfig} [config] This is a further axios configuration object that allows you to override the options previously setted.
-     * @param {MapoRequestConfig} options Additional option configuration. Here you can configure some mapo reserved options. Like the multipart autodiscover politic.
-     * @returns {Promise<external:AxiosResponse>}
-     */
-    create(payload, config, options) {
-
-        const func = $axios.$post(`/${trimslashes(endpoint)}/`, preparePayload(payload, options), { ...higherConf, ...config })
-        return endpoint !== null ? func : Promise.reject(endpointError)
-    },
-
-    /**
-     * This makes a GET http call to the crud endpoint slash the given id. Returns as a promise the server response.
-     * @alias $api.crud.detail
-     * @param {String} id The id of the data we want to get from the server.
-     * @param {external:AxiosRequestConfig} [config] This is a further axios configuration object that allows you to override the options previously setted.
-     * @returns {Promise<external:AxiosResponse>}
-     */
-    detail(id, config) {
-        const func = $axios.$get(`/${trimslashes(endpoint)}/${id}/`, { ...higherConf, ...config })
-        return endpoint !== null ? func : Promise.reject(endpointError)
-    },
-
-    /**
-     * This shortcut calls the update method or the create method depending on the presence of the id field in the payload.
-     * @alias $api.crud.updateOrCreate
-     * @param {Object} payload The payload containing the data that we want to send.
-     * @param {external:AxiosRequestConfig} [config] This is a further axios configuration object that allows you to override the options previously setted.
-     * @param {MapoRequestConfig} options Additional option configuration. Here you can configure some mapo reserved options. Like the multipart autodiscover politic.
-     * @returns {Promise<external:AxiosResponse>}
-     */
-    updateOrCreate(payload, config, options) {
-        const func = payload.id ? this.update(payload.id, payload, { ...higherConf, ...config }, options) : this.create(payload, { ...higherConf, ...config }, options)
-        return endpoint !== null ? func : Promise.reject(endpointError)
-    },
-
-    /**
-     * This makes a PUT http call to the crud endpoint slash the given id, sending the payload. Returns as a promise the server response.
-     * @alias $api.crud.update
-     * @param {String} id The id of the data we want to update.
-     * @param {Object} payload The payload containing the data that we want to send.
-     * @param {external:AxiosRequestConfig} [config] This is a further axios configuration object that allows you to override the options previously setted.
-     * @param {MapoRequestConfig} options Additional option configuration. Here you can configure some mapo reserved options. Like the multipart autodiscover politic.
-     * @returns {Promise<external:AxiosResponse>}
-     */
-    update(id, payload, config, options) {
-        const func = $axios.$put(`/${trimslashes(endpoint)}/${id}/`, preparePayload(payload, options), { ...higherConf, ...config })
-        return endpoint !== null ? func : Promise.reject(endpointError)
-    },
-
-    /**
-     * This makes a PATCH http call to the crud endpoint slash the given id, sending the payload. Returns as a promise the server response.
-     * @alias $api.crud.partialUpdate
-     * @param {String} id The id of the data we want to partially update.
-     * @param {Object} payload The payload containing the data that we want to send.
-     * @param {external:AxiosRequestConfig} [config] This is a further axios configuration object that allows you to override the options previously setted.
-     * @param {MapoRequestConfig} options Additional option configuration. Here you can configure some mapo reserved options. Like the multipart autodiscover politic.
-     * @returns {Promise<external:AxiosResponse>}
-     */
-    partialUpdate(id, payload, config, options) {
-        const func = $axios.$patch(`/${trimslashes(endpoint)}/${id}/`, preparePayload(payload, options), { ...higherConf, ...config })
-        return endpoint !== null ? func : Promise.reject(endpointError)
-    },
-    /** 
-     * This makes a DELETE http call to the crud endpoint slash the given id. Returns as a promise the server response.
-     * @alias $api.crud.delete
-     * @param {String} id The id of the data we want to delete from the server.
-     * @param {external:AxiosRequestConfig} [config] This is a further axios configuration object that allows you to override the options previously setted.
-     * @returns {Promise<external:AxiosResponse>}
-     */
-    delete(id, config) {
-        const func = $axios.$delete(`/${trimslashes(endpoint)}/${id}/`, { ...higherConf, ...config })
-        return endpoint !== null ? func : Promise.reject(endpointError)
-    },
-    /** 
-     * This makes a POST http call to the crud endpoint slash update_order. Returns as a promise the server response.
-     * Use this endpoint to change the order of the items in the list.
-     * @alias $api.crud.update_order
-     * @param {String} startId The id of the item we want to move in the list.
-     * @param {String} endId The id of the item in the position where we want to move.
-     * @param {external:AxiosRequestConfig} [config] This is a further axios configuration object that allows you to override the options previously setted.
-     * @returns {Promise<external:AxiosResponse>}
-     */
-     update_order(startId, endId, config) {
-        const func = $axios.$post(`/${trimslashes(endpoint)}/update_order/`, { startId, endId }, { ...higherConf, ...config })
-        return endpoint !== null ? func : Promise.reject(endpointError)
-    },
-
-    
-})
-/**
- * @external AxiosResponse
- * @see https://axios-http.com/docs/res_schema
- */
-
-/** 
- * @external AxiosRequestConfig
- * @see https://axios-http.com/docs/req_config
- */
-
-/**
- * Additional option configuration. Here you can configure some mapo reserved options.
- * @typedef {MapoRequestConfig} MapoRequestConfig
- * @property {string} multipart - Set the multipart politic. Accepts `'auto'|'force|'disable'`. If auto is set the request is transformed in multipart if any file is in the payload. If set to force the request is transformed in multipart no matter if files are found. If set to `'disable'` the request is never transformed in multipart.
- */
-
-module.exports = createRepository

package/api/multipart.js

@@ -1,41 +0,0 @@
-const { deepClone, getPointed, setPointed, filesInObject } = require('@mapomodule/utils/helpers/objHelpers')
-
-/**
- * This lets you transform a js object containing files in a multipart request with all the classic data in a single attribute (data) 
- * and all the files each one in a single attribute named with the dotted path of the file.
- * 
- * @alias $api.multipart
- * @param {Object} payload The payload of the request that needs to be trasformed. 
- * @param {String | String[]} file_attributes The list of dotted path of all the file attributes that need to be attached to the request. If unset autodiscovery is applyed. If set to 'fallback' if no files are found it returns the payload as it is.
- * @returns {external:FormData}
-*/
-function transformRequestInMultipart(payload, file_attributes = "auto") {
-    var file_paths = []
-    if (["auto", "force"].includes(file_attributes)) {
-        file_paths = filesInObject(payload)
-        if (file_attributes == "auto" && !file_paths.length){
-            return payload
-        }
-    } else if (Array.isArray(file_attributes)) {
-        file_paths = file_attributes
-    }
-    const data = deepClone(payload);
-    const files = file_paths.reduce((acc, path) => {
-        const file = getPointed(data, path, undefined)
-        setPointed(data, path, undefined);
-        return { [path]: file, ...acc }
-    }, {})
-    const formData = new FormData();
-    formData.append('data', JSON.stringify(data));
-    for (const key in files) {
-        formData.append(key, files[key]);
-    }
-    return formData;
-}
-
-/**
- * @external FormData
- * @see https://developer.mozilla.org/en-US/docs/Web/API/FormData
- */
-
-module.exports = transformRequestInMultipart

package/index.js

@@ -1,134 +0,0 @@
-import createRepository from '@mapomodule/core/api/crud'
-import transformRequestInMultipart from '@mapomodule/core/api/multipart'
-import initInterceptors from '@mapomodule/core/interceptor'
-
-try {
-    var options = require('./options').default;
-} catch (error) {
-    var options = {};
-}
-
-function getRouteMiddlewares(route) {
-    const meta = Array.isArray(route?.meta) ? route.meta[0] : route.meta
-    const { middleware } = meta || {}
-    return (typeof middleware === "string" ? [middleware] : middleware) || []
-}
-
-
-export default (ctx, inject) => {
-
-    initInterceptors(ctx)
-
-    const mapo = {
-        /**
-         * From here you can reach some utilities that simplify the interaction with the backend api.
-         */
-        $api: {
-            crud: createRepository(ctx.$axios),
-            multipart: transformRequestInMultipart,
-        },
-        /**
-         * From here you can reach some utilities that simplify the interaction with the user authentication flow.
-         */
-        $auth: {
-            /**
-             * Here you can submit your login credentials to the vuex store.
-             * 
-             * @param { Object } payload { username, password } aka user credentials for the login request.
-             */
-            login: payload => ctx.store.dispatch("mapo/user/login", payload),
-            /**
-             * 
-             * This simply commits a logout to the vuex store.
-             */
-            logout: () => ctx.store.dispatch("mapo/user/logout"),
-            /**
-             * This refresh user informations present in vuex store and returns them.
-             * @returns {UserData}
-             */
-            getInfo: () => ctx.store.dispatch("mapo/user/getInfo"),
-            user: {
-                get isLoggedIn() { return ctx.store.getters['mapo/user/isLoggedIn'] },
-                get token() { return ctx.store.getters['mapo/user/token'] },
-                get info() { return ctx.store.getters['mapo/user/info'] },
-                get username() { return ctx.store.getters['mapo/user/username'] },
-                get permissions() { return ctx.store.getters['mapo/user/pagePermission'](ctx.app?.context?.route?.name || "") },
-                get role() { return ctx.store.getters['mapo/user/role'] }
-            },
-            /**
-             * 
-             * This returns the current route middlewares if routemeta is enabled.
-             */
-            get routeMiddlewares() {
-                return getRouteMiddlewares(ctx.app?.context?.route || {})
-            },
-            /**
-             * 
-             * This returns the middlewares of a given route if routemeta is enabled.
-             * @param { Object } route { meta } the route object with meta info.
-             * @returns { Array } 
-             */
-            getRouteMiddlewares: getRouteMiddlewares
-        },
-        /**
-         * From here you can manage the default popup messaging system of mapo.
-         */
-        $snack: {
-            /**
-             * This send a message to the snack vuex store bringing up the component that carries the message to the user.
-             * 
-             * @param {SnackMessage} payload The payload containing the message.
-             * @returns {Promise}
-             */
-            open: payload => ctx.store.dispatch("mapo/app/showSnackMessage", payload),
-            /**
-             * This closes all the opened snack instances.
-             */
-            close: () => ctx.store.dispatch("mapo/app/clearSnackMessage"),
-        },
-        /**
-         * From here you can manage the default confirm dialog of mapo.
-         */
-        $confirm: {
-            /**
-             * This open the Confirm dialog component showing to the user a question. Returns a promise with the user response.
-             * @function
-             * @param {ConfirmDialogOptions} payload The payload containing the information to show to the user in the confirm dialog.
-             * @returns {Promise<boolean>} The response from the user interaction.
-             */
-            open: null,
-
-            /**
-             * This forces the dialog to close, giving a positive response.
-             * @function
-             */
-            accept: null,
-            /**
-             * This forces the dialog to close, giving a negative response.
-             * @function
-             */
-            close: null
-        },
-        $options: options
-    };
-
-    inject('mapo', mapo);
-    ctx.$mapo = mapo;
-}
-
-/**
- * The payload that need to be sent to the store in order to make the snack appear.
- * @typedef {SnackMessage} SnackMessage
- * @property {string} message - Contains the message to show.
- * @property {string} color - Indicates the color of the close button.
- */
-
-/**
- * The payload for the open function of the ConfirmDialog.
- * @typedef {ConfirmDialogOptions} ConfirmDialogOptions
- * @property {string} title - The title of the dialog.
- * @property {string} question - The text in the body of the dialog.
- * @property {string} dismissButton - The text in the dismiss Button.
- * @property {string} approveButton - The text in the approve Button.
- * @property {Object} attrs - An object with {@link https://vuetifyjs.com/en/api/v-dialog/|props} you want to inject into the confirm dialog.
- */

package/interceptor/auth.js

@@ -1,26 +0,0 @@
-module.exports = ({ $axios, store }) => {
-    if ($axios && store) {
-        $axios.onResponse((response) => {
-            if (response.status === 401) {
-                store.dispatch('mapo/user/logout');
-            }
-            if (response.status == 403) {
-                store.dispatch("mapo/app/showSnackMessage", { message: "Permission denied..", color: "error" })
-            }
-            return response
-        })
-
-        $axios.onError((error) => {
-            const { status, request } = error.response || {}
-            const baseURL = ($axios.defaults.baseURL || "").replace(/https?:\/\/[^\/]+/i, "")
-            const logoutPath = `${baseURL.endsWith("/") ? baseURL : baseURL + "/"}${process.env.AUTH_LOGIN_URL || "api/auth/logout"}`
-            if (status === 401 && (request || {}).path !== logoutPath) {
-                store.dispatch('mapo/user/logout')
-            }
-            if (status == 403) {
-                store.dispatch("mapo/app/showSnackMessage", { message: "Permission denied..", color: "error" })
-            }
-            return Promise.reject(error)
-        })
-    }
-}

package/interceptor/index.js

@@ -1,5 +0,0 @@
-const AuthInterceptor = require('./auth')
-
-module.exports = (ctx) => {
-    AuthInterceptor(ctx)
-}

package/middleware/auth.js

@@ -1,10 +0,0 @@
-import Middleware from '../../middleware' // little hack to inject middleware in root project :P
-
-Middleware.auth = Middleware.auth || function ({ route, redirect, query, store, app }) {
-    const { router: { options } } = app;
-    const isLoggedIn = store.getters['mapo/user/isLoggedIn']
-    if (!isLoggedIn) {
-        query['redirect'] = route.path
-        return redirect(`${options.base || '/'}login`, query)
-    }
-}

package/middleware/permissions.js

@@ -1,36 +0,0 @@
-import Middleware from "../../middleware"; // little hack to inject middleware in root project :P
-
-Middleware.permissions =
-    Middleware.permissions ||
-    async function ({ route, error, store }) {
-        route.meta = Array.isArray(route.meta) ? route.meta[0] : route.meta;
-        if (!route.meta.permissions) return;
-        const userInfo = store.getters["mapo/user/info"];
-        if (userInfo.is_superuser) {
-            await store.dispatch("mapo/user/addPagePermission", {
-                key: route.name,
-                value: ["add", "change", "delete", "view"],
-            });
-            return;
-        }
-        const { model } = route.meta.permissions;
-        const userPermission = (
-            userInfo.all_permissions ||
-            userInfo.user_permissions ||
-            []
-        )
-            .filter((perm) => perm.codename.endsWith(model))
-            .map(({ codename }) => codename.replace(`_${model}`, ""));
-        if (!userPermission.includes("view")) {
-            return error({
-                statusCode: 404,
-                message: "This page could not be found",
-            });
-        } else {
-            await store.dispatch("mapo/user/addPagePermission", {
-                key: route.name,
-                value: userPermission,
-            });
-            return;
-        }
-    };

package/middleware/roles.js

@@ -1,10 +0,0 @@
-import Middleware from '../../middleware' // little hack to inject middleware in root project :P
-
-Middleware.roles = Middleware.roles || async function ({ route, error, store }) {
-    route.meta = (Array.isArray(route.meta) ? route.meta[0] : route.meta) || {}
-    return (
-        route.meta.roles && !store.getters['mapo/user/isSuperUser'] &&
-        !route.meta.roles.includes(store.getters['mapo/user/role']) &&
-        error({ statusCode: 404, message: 'This page could not be found' })
-    )
-}

package/module.js

@@ -1,44 +0,0 @@
-import path from 'path'
-import Glob from 'glob'
-import pify from 'pify'
-const glob = pify(Glob)
-
-class Resolver {
-    resolveFiles = async (cwd, dir) => await glob(`${dir}/**/*.{vue,js}`, { cwd })
-    resolveRelative = async (cwd, dir) => {
-        const dirPrefix = new RegExp(`^${dir}/`)
-        return (await this.resolveFiles(cwd, dir)).map(file => ({ src: file.replace(dirPrefix, '') }))
-    }
-}
-
-export default async function (moduleOptions) {
-
-    const resolver = new Resolver()
-
-    const namespace = 'mapo'
-
-    // INJECT MAPO PLUGIN
-    this.addPlugin({
-        src: path.resolve(__dirname, './index.js'),
-        fileName: path.join(namespace, 'mapo.js')
-    })
-
-    // INJECT ALL MIDDLEWARES
-    const middlewares = (await resolver.resolveRelative(__dirname, 'middleware')).map(({ src }) => src)
-
-    for (const middleware of middlewares) {
-        this.addPlugin({
-            src: path.resolve(__dirname, './middleware', middleware),
-            fileName: path.join(namespace, 'middleware', middleware)
-        })
-    }
-
-    this.addTemplate({
-        src: path.resolve(__dirname, './templates/options.js'),
-        fileName: path.join(namespace, 'options.js'),
-        options: moduleOptions
-    })
-    
-}
-
-module.exports.meta = require('./package.json')

package/templates/options.js

@@ -1 +0,0 @@
-export default <%= serializeFunction(options) %>;