@mapomodule/core 1.0.0-alpha.0 → 1.0.0-alpha.13

package/CHANGELOG.md

@@ -0,0 +1,59 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [1.0.0-alpha.13](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.12...v1.0.0-alpha.13) (2022-03-01)
+
+
+### Features
+
+* added snack message in the requst interceptor ([acf9cd1](https://github.com/lotrekagency/mapo/commit/acf9cd1efbabc13eb99af7f4bfe0dcf096112ec0))
+
+
+
+
+
+# [1.0.0-alpha.10](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.9...v1.0.0-alpha.10) (2022-02-11)
+
+
+### Bug Fixes
+
+* fix crud requests without multipart policy ([5875833](https://github.com/lotrekagency/mapo/commit/5875833209872a2609b653a089fff80c447b14e9))
+
+
+### Features
+
+* **core:** Completely rewritten multipart capabilities, now the crud helper autodiscovers whet to use a multipart request. ([0a6546c](https://github.com/lotrekagency/mapo/commit/0a6546c9adeaf1fcf57a88105101e476b8b786dc))
+
+
+
+
+
+# [1.0.0-alpha.9](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.8...v1.0.0-alpha.9) (2022-02-08)
+
+**Note:** Version bump only for package @mapomodule/core
+
+
+
+
+
+# [1.0.0-alpha.8](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.7...v1.0.0-alpha.8) (2022-01-23)
+
+
+### Bug Fixes
+
+* **auth:** logout user only on 401 ([818f3d5](https://github.com/lotrekagency/mapo/commit/818f3d5ff315635438ac9bc9566a1b2fd2c5cf03))
+* **permission:** fix bad store initialization on ssr ([f075824](https://github.com/lotrekagency/mapo/commit/f075824561d6a71ce07ecbba70e994102abd623b))
+* **permissions:** add route permissions with routename instead on path ([16ff6ee](https://github.com/lotrekagency/mapo/commit/16ff6eee5e3a8ddbf9e7aea1ba05e8a88fb43932))
+
+
+
+
+
+# [1.0.0-alpha.6](https://github.com/lotrekagency/mapo/compare/v1.0.0-alpha.5...v1.0.0-alpha.6) (2021-12-26)
+
+
+### Features
+
+* **core:** reject promise for crud methods if no endpoint was passed during configuration ([bb8d447](https://github.com/lotrekagency/mapo/commit/bb8d4474efe41af5d7f38dbcd47731133d6ba154))

package/LICENSE.md

@@ -0,0 +1,20 @@
+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,4 +1,13 @@
-const trimslashes = (str) => str.replace(/^\/|\/$/g, '')
+const transformRequestInMultipart = require('@mapomodule/core/api/multipart')
+const trimslashes = (str) => (str || "").replace(/^\/|\/$/g, '')
+const preparePayload = (payload, options) => {
+    const { multipart } = (options || {})
+    if (!(payload instanceof FormData) && (typeof multipart === 'string') && multipart !== 'disable') {
+        payload = transformRequestInMultipart(payload, multipart);
+    }
+    return payload
+}
+const endpointError = "This crud is badly configured. No endpoint was passed"
 
 /**
  * This function generates a fully functional crud helper given the endpoint.
@@ -16,7 +25,8 @@ const createRepository = ($axios) => (endpoint, higherConf = {}) => ({
      * @returns {Promise<external:AxiosResponse>}
      */
     list(config) {
-        return $axios.$get(`/${trimslashes(endpoint)}/`, { ...higherConf, ...config })
+        const func = $axios.$get(`/${trimslashes(endpoint)}/`, { ...higherConf, ...config })
+        return endpoint !== null ? func : Promise.reject(endpointError)
     },
 
     /**
@@ -24,10 +34,13 @@ const createRepository = ($axios) => (endpoint, higherConf = {}) => ({
      * @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) {
-        return $axios.$post(`/${trimslashes(endpoint)}/`, payload, { ...higherConf, ...config })
+    create(payload, config, options) {
+
+        const func = $axios.$post(`/${trimslashes(endpoint)}/`, preparePayload(payload, options), { ...higherConf, ...config })
+        return endpoint !== null ? func : Promise.reject(endpointError)
     },
 
     /**
@@ -38,7 +51,8 @@ const createRepository = ($axios) => (endpoint, higherConf = {}) => ({
      * @returns {Promise<external:AxiosResponse>}
      */
     detail(id, config) {
-        return $axios.$get(`/${trimslashes(endpoint)}/${id}/`, { ...higherConf, ...config })
+        const func = $axios.$get(`/${trimslashes(endpoint)}/${id}/`, { ...higherConf, ...config })
+        return endpoint !== null ? func : Promise.reject(endpointError)
     },
 
     /**
@@ -46,10 +60,12 @@ const createRepository = ($axios) => (endpoint, higherConf = {}) => ({
      * @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) {
-        return payload.id ? this.update(payload.id, payload, { ...higherConf, ...config }) : this.create(payload, { ...higherConf, ...config })
+    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)
     },
 
     /**
@@ -58,10 +74,12 @@ const createRepository = ($axios) => (endpoint, higherConf = {}) => ({
      * @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) {
-        return $axios.$put(`/${trimslashes(endpoint)}/${id}/`, payload, { ...higherConf, ...config })
+    update(id, payload, config, options) {
+        const func = $axios.$put(`/${trimslashes(endpoint)}/${id}/`, preparePayload(payload, options), { ...higherConf, ...config })
+        return endpoint !== null ? func : Promise.reject(endpointError)
     },
 
     /**
@@ -70,10 +88,12 @@ const createRepository = ($axios) => (endpoint, higherConf = {}) => ({
      * @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) {
-        return $axios.$patch(`/${trimslashes(endpoint)}/${id}/`, payload, { ...higherConf, ...config })
+    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.
@@ -83,7 +103,8 @@ const createRepository = ($axios) => (endpoint, higherConf = {}) => ({
      * @returns {Promise<external:AxiosResponse>}
      */
     delete(id, config) {
-        return $axios.$delete(`/${trimslashes(endpoint)}/${id}/`, { ...higherConf, ...config })
+        const func = $axios.$delete(`/${trimslashes(endpoint)}/${id}/`, { ...higherConf, ...config })
+        return endpoint !== null ? func : Promise.reject(endpointError)
     }
 })
 /**
@@ -96,4 +117,10 @@ const createRepository = ($axios) => (endpoint, higherConf = {}) => ({
  * @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,4 +1,4 @@
-const deepClone = require('@mapomodule/utils/helpers/objHelpers').deepClone
+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) 
@@ -6,33 +6,29 @@ const deepClone = require('@mapomodule/utils/helpers/objHelpers').deepClone
  * 
  * @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.
+ * @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 = []) {
-
-    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];
-            }
+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
         }
-        return { data: object, files: files };
+    } else if (Array.isArray(file_attributes)) {
+        file_paths = file_attributes
     }
-
-    const tmp_obj = deepClone(payload);
-    const blob = cleanObject(tmp_obj, 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(blob.data));
-    for (const key in blob.files) {
-        formData.append(key, blob.files[key]);
+    formData.append('data', JSON.stringify(data));
+    for (const key in files) {
+        formData.append(key, files[key]);
     }
     return formData;
 }

package/index.js

@@ -2,6 +2,13 @@ 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)
@@ -39,9 +46,23 @@ export default (ctx, inject) => {
                 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.path) },
+                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.

package/interceptor/auth.js

@@ -9,19 +9,23 @@ module.exports = ({ $axios, store }) => {
         })
     
         $axios.onResponse((response) => {
-            if (response.status !== 200) {
-                if (response.status === 401 || response.status === 402 || response.status === 403) {
-                    store.dispatch('mapo/user/logout');
-                }
+            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 } = error.response || {}
-            if (status === 401 || status === 402 || status === 403) {
+            if (status === 401) {
                 store.dispatch('mapo/user/logout');
             }
+            if (status == 403) {
+                store.dispatch("mapo/app/showSnackMessage", { message: "Permission denied..", color: "error" })
+            }
             return Promise.reject(error)
         })
     }

package/middleware/permissions.js

@@ -5,7 +5,7 @@ Middleware.permissions = Middleware.permissions || async function ({ route, erro
     if (!route.meta.permissions) return
     const userInfo = store.getters['mapo/user/info']
     if (userInfo.is_superuser) {
-        await store.dispatch('mapo/user/addPagePermission', {key: route.path, value: ["add", "change", "delete", "view"]})
+        await store.dispatch('mapo/user/addPagePermission', {key: route.name, value: ["add", "change", "delete", "view"]})
         return
     }
     const { model } = route.meta.permissions
@@ -13,7 +13,7 @@ Middleware.permissions = Middleware.permissions || async function ({ route, erro
     if (!userPermission.includes('view')) {
         return error({ statusCode: 404, message: 'This page could not be found' })
     } else {
-        await store.dispatch('mapo/user/addPagePermission', {key: route.path, value: userPermission})
+        await store.dispatch('mapo/user/addPagePermission', {key: route.name, value: userPermission})
         return
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapomodule/core",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-alpha.13",
   "description": "This is part of Mapo nuxt module. Injects the core mapo plugin helpers.",
   "author": "bnznamco <gabriele.baldi.01@gmail.com>",
   "keywords": [
@@ -13,10 +13,10 @@
   "repository": "https://github.com/lotrekagency/mapo",
   "main": "./module.js",
   "dependencies": {
-    "@mapomodule/utils": "^1.0.0-alpha.0"
+    "@mapomodule/utils": "^1.0.0-alpha.13"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "801fe7de298f06e335793291c4955abf62edd077"
+  "gitHead": "b0fac0f5ebde4c65cc5347dbb841392dc04ef5e8"
 }