@mapomodule/core 1.0.0-alpha.9 → 2.0.0-beta.1

package/LICENSE.md

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) Lotrek 2021
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

package/api/crud.js

@@ -1,107 +0,0 @@
-const trimslashes = (str) => (str || "").replace(/^\/|\/$/g, '')
-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.
-     * @returns {Promise<external:AxiosResponse>}
-     */
-    create(payload, config) {
-        const func = $axios.$post(`/${trimslashes(endpoint)}/`, payload, { ...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.
-     * @returns {Promise<external:AxiosResponse>}
-     */
-    updateOrCreate(payload, config) {
-        const func = payload.id ? this.update(payload.id, payload, { ...higherConf, ...config }) : this.create(payload, { ...higherConf, ...config })
-        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.
-     * @returns {Promise<external:AxiosResponse>}
-     */
-    update(id, payload, config) {
-        const func = $axios.$put(`/${trimslashes(endpoint)}/${id}/`, payload, { ...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.
-     * @returns {Promise<external:AxiosResponse>}
-     */
-    partialUpdate(id, payload, config) {
-        const func = $axios.$patch(`/${trimslashes(endpoint)}/${id}/`, payload, { ...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)
-    }
-})
-/**
- * @external AxiosResponse
- * @see https://axios-http.com/docs/res_schema
- */
-
-/** 
- * @external AxiosRequestConfig
- * @see https://axios-http.com/docs/req_config
- */
-
-module.exports = createRepository

package/api/multipart.js

@@ -1,45 +0,0 @@
-const deepClone = require('@mapomodule/utils/helpers/objHelpers').deepClone
-
-/**
- * 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[]} file_attributes The list of dotted path of all the file attributes that need to be attached to the request.
- * @returns {external:FormData}
-*/
-function transformRequestInMultipart(payload, file_attributes = []) {
-
-    const cleanObject = (object, file_attributes, base = '', files = {}) => {
-        for (const key in object) {
-            if (file_attributes.includes(key) && object[key] && typeof object[key] != 'string') {
-                files[base + key] = object[key];
-                delete object[key];
-            }
-            if (typeof object[key] == 'object') {
-                cleanObject(object[key], file_attributes, base + key + '.', files);
-            }
-            if (file_attributes.includes(key) && object[key] && typeof object[key] == 'string') {
-                delete object[key];
-            }
-        }
-        return { data: object, files: files };
-    }
-
-    const tmp_obj = deepClone(payload);
-    const blob = cleanObject(tmp_obj, file_attributes);
-    const formData = new FormData();
-    formData.append('data', JSON.stringify(blob.data));
-    for (const key in blob.files) {
-        formData.append(key, blob.files[key]);
-    }
-    return formData;
-}
-
-/**
- * @external FormData
- * @see https://developer.mozilla.org/en-US/docs/Web/API/FormData
- */
-
-module.exports = transformRequestInMultipart

package/index.js

@@ -1,124 +0,0 @@
-import createRepository from '@mapomodule/core/api/crud'
-import transformRequestInMultipart from '@mapomodule/core/api/multipart'
-import initInterceptors from '@mapomodule/core/interceptor'
-
-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)
-
-    inject('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/login"),
-            /**
-             * 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
-        }
-    })
-}
-
-/**
- * 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.onRequest((config) => {
-            const token = store.getters['mapo/user/token']
-            if (token && token !== 'undefined') {
-                config.headers['Authorization'] = `Token ${token}`
-            }
-            return config
-        })
-    
-        $axios.onResponse((response) => {
-            if (response.status === 401) {
-                store.dispatch('mapo/user/logout');
-            }
-            return response
-        })
-    
-        $axios.onError((error) => {
-            const { status } = error.response || {}
-            if (status === 401) {
-                store.dispatch('mapo/user/logout');
-            }
-            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,9 +0,0 @@
-import Middleware from '../../middleware' // little hack to inject middleware in root project :P
-
-Middleware.auth = Middleware.auth || function ({ route, redirect, query, store }) {
-    const hasToken = store.getters['mapo/user/token']
-    if (!hasToken) {
-        query['redirect'] = route.path
-        return redirect('/login', query)
-    }
-}

package/middleware/permissions.js

@@ -1,19 +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.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,40 +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)
-        })
-    }
-
-
-    
-}
-
-module.exports.meta = require('./package.json')