\n);\n\nconst PermissibleComponent = Permissible(\n RestrictedComponent,\n userPermissions,\n requiredPermissions,\n callbackFunction,\n oneperm,\n);\n\nrender() {\n \n}\n```\n\nWhere:\n\n* `RestrictedComponent`: a component to render\n* `userPermissions`: an array of permissions set for current user\n* `requiredPermissions`: an array of required permissions\n* `oneperm`: boolean determining that only one of required permissions will be necessary instead of requiring all passed permissions (optional)\n"
},
{
"path": "docs-www/.gitignore",
"content": "# Logs\nlogs\n*.log*\n\n# node-waf configuration\n.lock-wscript\n\n# Dependency directory\nnode_modules\n\n# IDEA/Webstorm project files\n.idea\n*.iml\n\n#VSCode metadata\n.vscode\n\n# Mac files\n.DS_Store\n\n# Gatsby\n.cache\npublic\n"
},
{
"path": "docs-www/LICENSE",
"content": "The MIT License (MIT)\n\nCopyright (c) 2017-2020 Brainhub\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n"
},
{
"path": "docs-www/README.md",
"content": "# Gatsby Docs Kit Starter\nThe default Brainhub static docs starter.\n\n## Try it out\n\nEnsure you have the latest version of [Node](https://nodejs.org/en/download/) installed. We also recommend you install [Yarn](https://yarnpkg.com/en/docs/install) as well.\nThen run:\n\n```bash\nyarn install\n```\n\nSeed documentation (if you don't have any yet): \n\n```bash\nyarn seed\n```\n\nRun the local webserver via `yarn develop`;\n\nThe example site is available at http://localhost:8000. You should see the example site loaded in your web browser.\nAlso visit http://localhost:8000/___graphql to explore your site's GraphiQL data and schema.\n\nThen go to `../docs` to edit and write awesome docs!.\n\n## Deploy\n\nReady to go? Want to deploy documentation to github pages? Run:\n\n```bash\nyarn deploy:gh\n```"
},
{
"path": "docs-www/gatsby-config.js",
"content": "'use strict';\n\nconst path = require('path');\nconst pluginConfigFactory = require('@brainhubeu/gatsby-docs-kit/plugins');\n\nmodule.exports = {\n siteMetadata: {\n title: 'react-permissible Docs',\n description: 'Making the permission management for React components easier',\n image: 'https://cdn-images-1.medium.com/max/1200/1*CLUFZFaXF6NG27NA3d_JkQ.jpeg',\n url: 'https://brainhubeu.github.io/react-permissible',\n type: 'article',\n siteName: 'react-permissible Docs',\n githubUrl: 'https://github.com/brainhubeu',\n },\n\n // URL prefix on production environment. For more info see https://www.gatsbyjs.org/docs/path-prefix/\n pathPrefix: process.env.PATH_PREFIX || ' ',\n\n plugins: [\n ...pluginConfigFactory({\n config: `${__dirname}/gatsby-docs-kit.yml`,\n resources: path.resolve(__dirname, '../docs'),\n }),\n {\n resolve: `gatsby-plugin-google-analytics`,\n options: {\n trackingId: 'UA-62818184-6',\n head: false,\n anonymize: true,\n respectDNT: true,\n pageTransitionDelay: 0,\n cookieDomain: 'brainhubeu.github.io',\n },\n ],\n};\n"
},
{
"path": "docs-www/gatsby-docs-kit.yml",
"content": "- title: Home\n dir: ./src\n url: /\n file: pages/landing.js\n\n- title: Docs\n dir: ../docs\n url: docs\n sidemenu:\n - title: Getting Started\n dir: getting-started\n items:\n - title: Overview\n file: overview.md\n - title: Installation\n file: installation.md\n - title: Usage\n dir: usage\n items:\n - title: As an ordinary component\n file: basic.md\n - title: As Higher Order Component\n file: hoc.md\n - title: Examples\n dir: examples\n items:\n - title: Render component when all the permissions match\n file: permissionsMatch.md\n - title: Render component when one of the permissions match\n file: oneMatch.md\n - title: Render another component if the permissions do not match\n file: renderOtherwise.md\n - title: Callback function\n file: callback.md\n"
},
{
"path": "docs-www/package.json",
"content": "{\n \"name\": \"@brainhubeu/gatsby-docs-kit-start\",\n \"description\": \"Gatsby-Docs-Kit starter repository\",\n \"version\": \"0.0.32\",\n \"author\": \"Brainhub\",\n \"license\": \"MIT\",\n \"scripts\": {\n \"build\": \"rm -rf .cache && rm -rf public && gatsby build --prefix-paths\",\n \"deploy:gh\": \"bash tools/deploy-github.sh\",\n \"develop\": \"rm -rf .cache && gatsby develop\",\n \"seed\": \"bash tools/seed.sh\",\n \"serve\": \"gatsby serve\",\n \"lint\": \"eslint --ext .jsx,.js .\",\n \"lint:autofix\": \"eslint --ext .jsx,.js . --fix\"\n },\n \"dependencies\": {\n \"@brainhubeu/gatsby-docs-kit\": \"1.0.10\",\n \"@brainhubeu/react-permissible\": \"^1.9.13\",\n \"gatsby\": \"1.9.279\"\n },\n \"devDependencies\": {\n \"eslint\": \"^7.3.1\",\n \"eslint-config-brainhub\": \"^1.13.0\",\n \"gh-pages\": \"^3.1.0\",\n \"react\": \"^16.13.1\",\n \"react-dom\": \"^16.13.1\"\n }\n}\n"
},
{
"path": "docs-www/src/globalReferences.js",
"content": "import React from 'react';\nimport { Permissible, PermissibleRender } from '@brainhubeu/react-permissible';\n\nconst boxStyle = {\n height: 130,\n width: 130,\n display: 'flex',\n margin: '0 auto',\n textAlign: 'center',\n backgroundColor: '#b5ffb5',\n justifyContent: 'center',\n flexDirection: 'column',\n};\n\nconst notAllowedBoxStyle = {\n ...boxStyle,\n backgroundColor: '#ffb5b5',\n};\n\nconst AccessGranted = () => (\n
You just hit a route that doesn't exist... the sadness.
\n
\n);\n\nexport default NotFoundPage;\n"
},
{
"path": "docs-www/src/pages/landing.js",
"content": "import React from 'react';\nimport Link from 'gatsby-link';\n\nimport styles from './landing.module.scss';\n\nconst LandingPage = () => (\n
\n
\n
react-permissible
\n
Making the permission management for components easier.
\n
\n \n Get started!\n \n
\n
\n
\n);\n\nexport default LandingPage;\n"
},
{
"path": "docs-www/src/pages/landing.module.scss",
"content": "@import './variables.scss';\n\n.landing {\n text-align: center;\n display: flex;\n align-items: center;\n justify-content: center;\n min-height: calc(100vh - 2*#{$mainNavHeight} - 64px);\n}\n\n.landing__header {\n text-transform: uppercase;\n font-size: 3rem;\n letter-spacing: 2px;\n margin-bottom: 1rem;\n margin-top: 0;\n}\n\n.btn__wrapper {\n display: flex;\n justify-content: center;\n}\n\n.landing__btn {\n display: inline-block;\n background-color: $colorBHBg;\n text-decoration: none;\n color: $white;\n padding: 1rem 2rem;\n margin: 2rem;\n position: relative;\n overflow: hidden;\n\n span {\n position: relative;\n z-index: 1;\n }\n\n &:after,\n &:before {\n content: '';\n position: absolute;\n top: 0;\n bottom: 0;\n width: 50%;\n background-color: $colorBHMain;\n transition: width .3s ease-out;\n }\n\n &:after {\n left: 0;\n }\n\n &:before {\n right: 0;\n }\n\n &:hover {\n color: $white;\n\n &:after,\n &:before {\n width: 0;\n }\n }\n}\n\n.landing__btn--alt {\n composes: landing__btn;\n background-color: transparent;\n color: rgba($colorBHBg, .7);\n transition: color .3s;\n\n &:after,\n &:before {\n background-color: transparent;\n border-style: solid;\n border-color: $colorBHMain;\n }\n\n &:after {\n border-width: 1px 0 1px 1px;\n }\n\n &:before {\n border-width: 1px 1px 1px 0;\n }\n\n &:hover {\n color: $colorBHMain;\n }\n}\n"
},
{
"path": "docs-www/src/pages/variables.scss",
"content": "$colorBHBg: #150940;\n$colorBHMain: #7b59ff;\n$white: #ffffff;\n\n$mainNavHeight: 80px;\n"
},
{
"path": "docs-www/src/templates/.gitkeep",
"content": ""
},
{
"path": "docs-www/tools/deploy-github.sh",
"content": "#!/bin/bash\n\nGITHUB_REPO_NAME=$(basename -s .git `git config --get remote.origin.url`);\n\nPATH_PREFIX=\"/$GITHUB_REPO_NAME\" npm run build\n\n# deploy to github pags\nnode ./node_modules/.bin/gh-pages -d public\n"
},
{
"path": "docs-www/tools/seed/example.md",
"content": "# CLI Commands\n\n### Running an app\n1. running an application on locally\n ```bash\n npm run develop # or yarn develop\n ```\n\n Gatsby will start a hot-reloading development environment accessible at [http://localhost:8000](http://localhost:8000)\n\n2. preparing optimized production build\n ```bash\n npm run build\n ```\n\n3. serving locally production build\n ```bash\n npm run serve\n ```\n\n > Note that your site by default will be available on [http://localhost:9000](http://localhost:9000)\n\n4. deploying to github pages\n ```bash\n npm run deploy:gh\n ```\n\n > See more [HERE](../getting-started/publishing.md)\n\n"
},
{
"path": "docs-www/tools/seed.sh",
"content": "#!/bin/bash\n\nCONFIG_FILE=\"gatsby-docs-kit.yml\"\nDIR_NAME=\"docs\"\n\n# Create docs directory\nif [ -d \"../${DIR_NAME}\" ]; then\n echo '\"docs\" directory already exists. Can not seed it. Remove it and try again.'\n exit 1;\nfi\n\nmkdir -p \"../${DIR_NAME}\"\n\n# Create gastsby docs kit config file if do not exists\nif [ ! -f \"./${CONFIG_FILE}\" ]; then\n echo \"\" > $CONFIG_FILE;\nfi\n\n# Create example Mk\ncp ./tools/seed/example.md ../${DIR_NAME}/example.md\n\n# Seeding gastsby docs kit config file\necho \"- title: Home\n dir: ../docs\n url: docs\n file: example.md\" >> $CONFIG_FILE;\n\n# Done\necho \"Done!\""
},
{
"path": "lib/react-permissible.js",
"content": "!function(t,e){\"object\"==typeof exports&&\"object\"==typeof module?module.exports=e(require(\"react\")):\"function\"==typeof define&&define.amd?define(\"react-permissible\",[\"react\"],e):\"object\"==typeof exports?exports[\"react-permissible\"]=e(require(\"react\")):t[\"react-permissible\"]=e(t.React)}(\"undefined\"!=typeof self?self:this,function(t){return function(t){function e(n){if(r[n])return r[n].exports;var o=r[n]={i:n,l:!1,exports:{}};return t[n].call(o.exports,o,o.exports,e),o.l=!0,o.exports}var r={};return e.m=t,e.c=r,e.d=function(t,r,n){e.o(t,r)||Object.defineProperty(t,r,{configurable:!1,enumerable:!0,get:n})},e.n=function(t){var r=t&&t.__esModule?function(){return t.default}:function(){return t};return e.d(r,\"a\",r),r},e.o=function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},e.p=\"\",e(e.s=8)}([function(t,e){function r(){throw new Error(\"setTimeout has not been defined\")}function n(){throw new Error(\"clearTimeout has not been defined\")}function o(t){if(s===setTimeout)return setTimeout(t,0);if((s===r||!s)&&setTimeout)return s=setTimeout,setTimeout(t,0);try{return s(t,0)}catch(e){try{return s.call(null,t,0)}catch(e){return s.call(this,t,0)}}}function i(t){if(l===clearTimeout)return clearTimeout(t);if((l===n||!l)&&clearTimeout)return l=clearTimeout,clearTimeout(t);try{return l(t)}catch(e){try{return l.call(null,t)}catch(e){return l.call(this,t)}}}function u(){h&&y&&(h=!1,y.length?d=y.concat(d):v=-1,d.length&&a())}function a(){if(!h){var t=o(u);h=!0;for(var e=d.length;e;){for(y=d,d=[];++v1)for(var r=1;r-1}function o(t,e,r){for(var n=-1,o=t?t.length:0;++n-1}function P(t,e){var r=this.__data__,n=M(r,t);return n<0?r.push([t,e]):r[n][1]=e,this}function E(t){var e=-1,r=t?t.length:0;for(this.clear();++e=120&&h.length>=120)?new C(l&&h):void 0}h=t[0];var v=-1,b=p[0];t:for(;++v-1&&t%1==0&&t<=Q}function G(t){var e=typeof t;return!!t&&(\"object\"==e||\"function\"==e)}function H(t){return!!t&&\"object\"==typeof t}var K=\"__lodash_hash_undefined__\",Q=9007199254740991,X=\"[object Function]\",Z=\"[object GeneratorFunction]\",tt=/[\\\\^$.*+?()[\\]{}|]/g,et=/^\\[object .+?Constructor\\]$/,rt=\"object\"==typeof e&&e&&e.Object===Object&&e,nt=\"object\"==typeof self&&self&&self.Object===Object&&self,ot=rt||nt||Function(\"return this\")(),it=Array.prototype,ut=Function.prototype,at=Object.prototype,ct=ot[\"__core-js_shared__\"],ft=function(){var t=/[^.]+$/.exec(ct&&ct.keys&&ct.keys.IE_PROTO||\"\");return t?\"Symbol(src)_1.\"+t:\"\"}(),st=ut.toString,lt=at.hasOwnProperty,pt=at.toString,yt=RegExp(\"^\"+st.call(lt).replace(tt,\"\\\\$&\").replace(/hasOwnProperty|(function).*?(?=\\\\\\()| for .+?(?=\\\\\\])/g,\"$1.*?\")+\"$\"),dt=it.splice,ht=Math.max,vt=Math.min,bt=D(ot,\"Map\"),_t=D(Object,\"create\");y.prototype.clear=d,y.prototype.delete=h,y.prototype.get=v,y.prototype.has=b,y.prototype.set=_,m.prototype.clear=g,m.prototype.delete=w,m.prototype.get=O,m.prototype.has=j,m.prototype.set=P,E.prototype.clear=S,E.prototype.delete=x,E.prototype.get=T,E.prototype.has=$,E.prototype.set=k,C.prototype.add=C.prototype.push=A,C.prototype.has=R;var mt=function(t,e){return e=ht(void 0===e?t.length-1:e,0),function(){for(var n=arguments,o=-1,i=ht(n.length-e,0),u=Array(i);++o-1}function o(t,e,r){for(var n=-1,o=t?t.length:0;++n-1}function E(t,e){var r=this.__data__,n=I(r,t);return n<0?r.push([t,e]):r[n][1]=e,this}function S(t){var e=-1,r=t?t.length:0;for(this.clear();++e=Z&&(c=l,f=!1,e=new A(e));t:for(;++a0&&r(c)?e>1?F(c,e-1,r,n,o):u(o,c):n||(o[o.length]=c)}return o}function V(t){return!(!Q(t)||z(t))&&(H(t)||y(t)?_t:ut).test(U(t))}function D(t,e){var r=t.__data__;return W(e)?r[\"string\"==typeof e?\"string\":\"hash\"]:r.map}function q(t,e){var r=p(t,e);return V(r)?r:void 0}function L(t){return xt(t)||J(t)||!!(Ot&&t&&t[Ot])}function W(t){var e=typeof t;return\"string\"==e||\"number\"==e||\"symbol\"==e||\"boolean\"==e?\"__proto__\"!==t:null===t}function z(t){return!!dt&&dt in t}function U(t){if(null!=t){try{return ht.call(t)}catch(t){}try{return t+\"\"}catch(t){}}return\"\"}function Y(t,e){return t===e||t!==t&&e!==e}function J(t){return G(t)&&vt.call(t,\"callee\")&&(!gt.call(t,\"callee\")||bt.call(t)==rt)}function B(t){return null!=t&&K(t.length)&&!H(t)}function G(t){return X(t)&&B(t)}function H(t){var e=Q(t)?bt.call(t):\"\";return e==nt||e==ot}function K(t){return\"number\"==typeof t&&t>-1&&t%1==0&&t<=et}function Q(t){var e=typeof t;return!!t&&(\"object\"==e||\"function\"==e)}function X(t){return!!t&&\"object\"==typeof t}var Z=200,tt=\"__lodash_hash_undefined__\",et=9007199254740991,rt=\"[object Arguments]\",nt=\"[object Function]\",ot=\"[object GeneratorFunction]\",it=/[\\\\^$.*+?()[\\]{}|]/g,ut=/^\\[object .+?Constructor\\]$/,at=\"object\"==typeof e&&e&&e.Object===Object&&e,ct=\"object\"==typeof self&&self&&self.Object===Object&&self,ft=at||ct||Function(\"return this\")(),st=Array.prototype,lt=Function.prototype,pt=Object.prototype,yt=ft[\"__core-js_shared__\"],dt=function(){var t=/[^.]+$/.exec(yt&&yt.keys&&yt.keys.IE_PROTO||\"\");return t?\"Symbol(src)_1.\"+t:\"\"}(),ht=lt.toString,vt=pt.hasOwnProperty,bt=pt.toString,_t=RegExp(\"^\"+ht.call(vt).replace(it,\"\\\\$&\").replace(/hasOwnProperty|(function).*?(?=\\\\\\()| for .+?(?=\\\\\\])/g,\"$1.*?\")+\"$\"),mt=ft.Symbol,gt=pt.propertyIsEnumerable,wt=st.splice,Ot=mt?mt.isConcatSpreadable:void 0,jt=Math.max,Pt=q(ft,\"Map\"),Et=q(Object,\"create\");d.prototype.clear=h,d.prototype.delete=v,d.prototype.get=b,d.prototype.has=_,d.prototype.set=m,g.prototype.clear=w,g.prototype.delete=O,g.prototype.get=j,g.prototype.has=P,g.prototype.set=E,S.prototype.clear=x,S.prototype.delete=T,S.prototype.get=$,S.prototype.has=k,S.prototype.set=C,A.prototype.add=A.prototype.push=R,A.prototype.has=M;var St=function(t,e){return e=jt(void 0===e?t.length-1:e,0),function(){for(var n=arguments,o=-1,i=jt(n.length-e,0),u=Array(i);++o1?e-1:0),n=1;n2?r-2:0),o=2;o1?\"Invalid arguments supplied to oneOf, expected an array, got \"+arguments.length+\" arguments. A common mistake is to write oneOf(x, y, z) instead of oneOf([x, y, z]).\":\"Invalid argument supplied to oneOf, expected an array.\"),n)}function _(t){function e(e,r,n,o,i){if(\"function\"!=typeof t)return new p(\"Property `\"+i+\"` of component `\"+n+\"` has invalid PropType notation inside objectOf.\");var a=e[r],f=P(a);if(\"object\"!==f)return new p(\"Invalid \"+o+\" `\"+i+\"` of type `\"+f+\"` supplied to `\"+n+\"`, expected an object.\");for(var s in a)if(c(a,s)){var l=t(a,s,n,o,i+\".\"+s,u);if(l instanceof Error)return l}return null}return y(e)}function m(t){function r(e,r,n,o,i){for(var a=0;a>\",C={array:d(\"array\"),bool:d(\"boolean\"),func:d(\"function\"),number:d(\"number\"),object:d(\"object\"),string:d(\"string\"),symbol:d(\"symbol\"),any:function(){return y(n)}(),arrayOf:h,element:function(){function e(e,r,n,o,i){var u=e[r];if(!t(u)){return new p(\"Invalid \"+o+\" `\"+i+\"` of type `\"+P(u)+\"` supplied to `\"+n+\"`, expected a single ReactElement.\")}return null}return y(e)}(),elementType:function(){function t(t,e,r,n,i){var u=t[e];if(!o.isValidElementType(u)){return new p(\"Invalid \"+n+\" `\"+i+\"` of type `\"+P(u)+\"` supplied to `\"+r+\"`, expected a single ReactElement type.\")}return null}return y(t)}(),instanceOf:v,node:function(){function t(t,e,r,n,o){return O(t[e])?null:new p(\"Invalid \"+n+\" `\"+o+\"` supplied to `\"+r+\"`, expected a ReactNode.\")}return y(t)}(),objectOf:_,oneOf:b,oneOfType:m,shape:g,exact:w};return p.prototype=Error.prototype,C.checkPropTypes=a,C.resetWarningCache=a.resetWarningCache,C.PropTypes=C,C}}).call(e,r(0))},function(t,e,r){\"use strict\";function n(t){if(null===t||void 0===t)throw new TypeError(\"Object.assign cannot be called with null or undefined\");return Object(t)}/*\nobject-assign\n(c) Sindre Sorhus\n@license MIT\n*/\nvar o=Object.getOwnPropertySymbols,i=Object.prototype.hasOwnProperty,u=Object.prototype.propertyIsEnumerable;t.exports=function(){try{if(!Object.assign)return!1;var t=new String(\"abc\");if(t[5]=\"de\",\"5\"===Object.getOwnPropertyNames(t)[0])return!1;for(var e={},r=0;r<10;r++)e[\"_\"+String.fromCharCode(r)]=r;if(\"0123456789\"!==Object.getOwnPropertyNames(e).map(function(t){return e[t]}).join(\"\"))return!1;var n={};return\"abcdefghijklmnopqrst\".split(\"\").forEach(function(t){n[t]=t}),\"abcdefghijklmnopqrst\"===Object.keys(Object.assign({},n)).join(\"\")}catch(t){return!1}}()?Object.assign:function(t,e){for(var r,a,c=n(t),f=1;f=6.14.5\"\n },\n \"scripts\": {\n \"lint\": \"esw webpack.config.* src tools test --color\",\n \"lint:types\": \"esw 'types/*.{ts,tsx}' 'types/tests/*.{ts,tsx}' --ext ts,tsx --color --format codeframe --config ./types/.eslintrc\",\n \"lint:types:watch\": \"npm run --silent lint:types -- --watch\",\n \"lint:types:fix\": \"npm run --silent lint:types -- --fix\",\n \"clean-dist\": \"rm -rf ./lib && mkdir lib\",\n \"prebuild\": \"npm run clean-dist\",\n \"build\": \"node tools/build.js\",\n \"test\": \"mocha tools/testSetup.js \\\"./test/**/*.js\\\"\",\n \"test:coverage\": \"NODE_PATH=example babel-node ./node_modules/.bin/isparta cover _mocha -- --require ./tools/testSetup.js \\\"./test/**/*.js\\\" && open coverage/lcov-report/index.html\",\n \"test:coverage:ci\": \"NODE_PATH=example babel-node ./node_modules/.bin/isparta cover _mocha --report lcovonly -- --require ./tools/testSetup.js \\\"./test/**/*.js\\\"\",\n \"test:typescript\": \"cd ./types/tests && npm install-test --no-audit\",\n \"precommit\": \"npm run lint && npm run lint:types\"\n },\n \"author\": \"Krystian Kościelniak\",\n \"license\": \"MIT\",\n \"dependencies\": {\n \"gatsby-plugin-google-analytics\": \"2.3.2\",\n \"lodash.difference\": \"^4.5.0\",\n \"lodash.intersection\": \"^4.4.0\"\n },\n \"devDependencies\": {\n \"autoprefixer\": \"^9.8.4\",\n \"babel-cli\": \"^6.26.0\",\n \"babel-core\": \"^6.26.3\",\n \"babel-eslint\": \"^10.1.0\",\n \"babel-loader\": \"^8.1.0\",\n \"babel-plugin-react-display-name\": \"^2.0.0\",\n \"babel-plugin-transform-decorators-legacy\": \"^1.3.5\",\n \"babel-plugin-transform-react-constant-elements\": \"^6.23.0\",\n \"babel-plugin-transform-react-remove-prop-types\": \"^0.4.24\",\n \"babel-polyfill\": \"^6.26.0\",\n \"babel-preset-env\": \"^1.7.0\",\n \"babel-preset-es2015\": \"^6.24.1\",\n \"babel-preset-latest\": \"^6.24.1\",\n \"babel-preset-react\": \"^6.24.1\",\n \"babel-preset-react-hmre\": \"^1.1.1\",\n \"babel-preset-stage-1\": \"^6.24.1\",\n \"babel-register\": \"^6.26.0\",\n \"chai\": \"^4.2.0\",\n \"chai-as-promised\": \"^7.1.1\",\n \"chai-enzyme\": \"^1.0.0-beta.1\",\n \"chalk\": \"^4.1.0\",\n \"coveralls\": \"^3.1.0\",\n \"enzyme\": \"^3.11.0\",\n \"enzyme-adapter-react-16\": \"^1.15.2\",\n \"eslint\": \"^7.3.1\",\n \"eslint-config-brainhub\": \"^1.13.0\",\n \"eslint-plugin-typescript\": \"^0.14.0\",\n \"eslint-watch\": \"^7.0.0\",\n \"html-webpack-plugin\": \"^4.3.0\",\n \"husky\": \"^4.2.5\",\n \"isparta\": \"^4.1.1\",\n \"jsdom\": \"^16.2.2\",\n \"mocha\": \"^8.0.1\",\n \"prop-types\": \"^15.7.2\",\n \"react\": \"^16.13.1\",\n \"react-dom\": \"^16.13.1\",\n \"react-test-renderer\": \"^16.13.1\",\n \"sinon\": \"^9.0.2\",\n \"sinon-chai\": \"^3.5.0\",\n \"typescript\": \"^3.9.6\",\n \"typescript-eslint-parser\": \"^21.0.2\",\n \"uglifyjs-webpack-plugin\": \"^2.2.0\",\n \"webpack\": \"^4.43.0\"\n },\n \"peerDependencies\": {\n \"react\": \">0.14.0 || >15.0.0\",\n \"react-dom\": \">0.14.0 || >15.0.0\"\n },\n \"keywords\": [\n \"react\",\n \"react-permissions\",\n \"permissions\",\n \"permission-manager\",\n \"props\",\n \"callback\",\n \"users\",\n \"authentication\",\n \"optional-props\",\n \"authorization\",\n \"access-control\"\n ],\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/brainhubeu/react-permissible\"\n },\n \"main\": \"./lib/react-permissible.js\",\n \"types\": \"./types/react-permissible.d.ts\"\n}\n"
},
{
"path": "renovate.json",
"content": "{\n \"bumpVersion\": \"patch\",\n \"commitMessagePrefix\": \"[renovate] \",\n \"groupName\": \"NPM dependencies\",\n \"labels\": [\"renovate\"],\n \"rangeStrategy\": \"bump\",\n \"branchPrefix\": \"fix/renovate/\",\n \"docker\": {\n \"major\": {\n \"enabled\": true\n }\n },\n \"packageRules\": [\n {\n \"groupName\": \"Docker dependencies\",\n \"managers\": [\n \"circleci\"\n ]\n },\n {\n \"groupName\": \"gatsby\",\n \"managerBranchPrefix\": \"gatsby\",\n \"packagePatterns\": [\n \"gatsby\"\n ],\n \"rangeStrategy\": \"pin\"\n }\n ],\n \"schedule\": [\n \"before 3am on the first day of the month\"\n ]\n}\n"
},
{
"path": "src/components/permissible.js",
"content": "import React, { Component } from 'react';\nimport PropTypes from 'prop-types';\nimport intersection from 'lodash.intersection';\nimport difference from 'lodash.difference';\n\nexport function Permissible(\n RestrictedComponent,\n userPermissions,\n requiredPermissions,\n callbackFunction,\n oneperm,\n) {\n const permissionsStatus = oneperm\n ? intersection(userPermissions, requiredPermissions).length\n : difference(requiredPermissions, userPermissions).length === 0;\n\n class PermissibleHOC extends Component {\n static propTypes = {\n oneperm: PropTypes.bool,\n history: PropTypes.object, // eslint-disable-line react/forbid-prop-types\n };\n\n constructor(props) {\n super(props);\n\n if (!permissionsStatus) {\n this.runCallback();\n }\n }\n\n runCallback() {\n if (callbackFunction) {\n return callbackFunction({\n userPermissions,\n requiredPermissions,\n },\n this.props.history);\n }\n return;\n }\n\n render() {\n if (permissionsStatus) {\n return ;\n }\n return null;\n }\n }\n return PermissibleHOC;\n}\n"
},
{
"path": "src/components/permissibleRender.js",
"content": "import { Component } from 'react';\nimport PropTypes from 'prop-types';\nimport intersection from 'lodash.intersection';\nimport difference from 'lodash.difference';\n\nexport class PermissibleRender extends Component {\n static propTypes = {\n oneperm: PropTypes.bool,\n userPermissions: PropTypes.arrayOf(PropTypes.string).isRequired,\n requiredPermissions: PropTypes.arrayOf(PropTypes.string).isRequired,\n children: PropTypes.element.isRequired,\n renderOtherwise: PropTypes.element,\n };\n\n checkPermissions() {\n const { userPermissions, requiredPermissions, oneperm } = this.props;\n\n if (oneperm) {\n return intersection(userPermissions, requiredPermissions).length;\n }\n\n return difference(requiredPermissions, userPermissions).length === 0;\n }\n\n render() {\n const { children, userPermissions, requiredPermissions, renderOtherwise } = this.props;\n\n if (!children || !userPermissions || !requiredPermissions) {\n return null;\n }\n\n if (this.checkPermissions()) {\n return children;\n } else if (renderOtherwise) {\n return renderOtherwise;\n }\n return null;\n }\n}\n"
},
{
"path": "src/index.js",
"content": "import { Permissible } from './components/permissible';\nimport { PermissibleRender } from './components/permissibleRender';\n\nexport {\n Permissible,\n PermissibleRender,\n};\n"
},
{
"path": "test/.eslintrc",
"content": "{\n env: {\n es6: true,\n browser: true,\n node: true,\n mocha: true,\n },\n}\n"
},
{
"path": "test/accessible.component.js",
"content": "import React from 'react';\nimport PropTypes from 'prop-types';\n\nconst Accessible = ({ permission, oneperm }) => (\n
\n
\n {oneperm ? 'One of' : 'Whole set of'} {permission} is necessary to see this component.\n
\n
\n);\n\nAccessible.propTypes = {\n permission: PropTypes.string,\n oneperm: PropTypes.bool,\n};\n\nexport default Accessible;\n"
},
{
"path": "test/permissible.test.js",
"content": "import React from 'react';\nimport { shallow } from 'enzyme';\nimport chai from 'chai';\nimport chaiEnzyme from 'chai-enzyme';\nimport { JSDOM } from 'jsdom';\n\nimport { Permissible } from '../src/components/permissible';\n\nimport AccessedComponent from './accessible.component';\n\nconst { document } = (new JSDOM('')).window;\nglobal.document = document;\nglobal.window = document.defaultView;\n\nchai.use(chaiEnzyme());\nchai.should();\n\ndescribe('Permissible HOC', () => {\n it('doesn\\'t run a callback function if the permissions are right', done => {\n let err = null;\n\n const AccessibleRoute = Permissible(\n () => ,\n ['MATCHING_PERMISSIONS'],\n ['MATCHING_PERMISSIONS'],\n () => {\n err = new Error('Callback function called.');\n },\n );\n\n shallow(\n ,\n );\n\n done(err);\n });\n\n it('doesn\\'t run a callback function if `requiredPermissions` and `userPermissions` are both empty', done => {\n let err = null;\n\n const AccessibleRoute = Permissible(\n () => ,\n [],\n [],\n () => {\n err = new Error('Callback function called.');\n },\n );\n\n shallow(\n ,\n );\n\n done(err);\n });\n\n it('doesn\\'t run a callback function if only `requiredPermissions` are empty', done => {\n let err = null;\n\n const AccessibleRoute = Permissible(\n () => ,\n ['SOME_PERMISSION'],\n [],\n () => {\n err = new Error('Callback function called.');\n },\n );\n\n shallow(\n ,\n );\n\n done(err);\n });\n\n it('runs a callback function if the permissions don\\'t match', done => {\n const AccessibleRoute = Permissible(\n () => ,\n ['MATCHING_PERMISSIONS'],\n ['UNMATCHING_PERMISSIONS'],\n () => {\n done();\n },\n );\n\n shallow(\n ,\n );\n });\n\n it('doesn\\'t run a callback function if the user has one of necessary permissions and `oneperm` is `true`', done => {\n let err = null;\n\n const AccessibleRoute = Permissible(\n () => ,\n ['REQUIRED_PERMISSION'],\n ['REQUIRED_PERMISSION', 'ANOTHER_PERMISSION'],\n () => {\n err = new Error('Callback function called.');\n },\n true,\n );\n\n shallow(\n ,\n );\n\n done(err);\n });\n\n it('runs a callback function if the user has one of necessary permissions and `oneperm` is `false`', done => {\n const AccessibleRoute = Permissible(\n () => ,\n ['REQUIRED_PERMISSION'],\n ['REQUIRED_PERMISSION', 'ANOTHER_PERMISSION'],\n () => {\n done();\n },\n false,\n );\n\n shallow(\n ,\n );\n });\n\n it('doesn\\'t run a callback function if it is not defined', done => {\n const AccessibleRoute = Permissible(\n () => ,\n ['REQUIRED_PERMISSION'],\n ['REQUIRED_PERMISSION', 'ANOTHER_PERMISSION'],\n null,\n false,\n );\n\n shallow(\n ,\n );\n\n done();\n });\n});\n"
},
{
"path": "test/permissibleRender.test.js",
"content": "import React from 'react';\nimport { mount } from 'enzyme';\nimport chai from 'chai';\nimport chaiEnzyme from 'chai-enzyme';\nimport { JSDOM } from 'jsdom';\n\nimport { PermissibleRender } from '../src/components/permissibleRender';\n\nconst should = chai.should();\n\nconst { document } = (new JSDOM('')).window;\nglobal.document = document;\nglobal.window = document.defaultView;\n\nchai.use(chaiEnzyme());\nchai.should();\n\ndescribe('PermissibleRender', () => {\n const ChildComponent = () => (\n
\n Child component\n
\n );\n\n const NotAllowedComponent = () => (\n
\n Not allowed component\n
\n );\n\n it('doesn\\'t render a if `userPermissions` prop is not set', () => {\n const props = {\n requiredPermissions: [],\n };\n\n const mountedComponent = mount(\n \n \n ,\n );\n\n const searchedElement = mountedComponent.find('ChildComponent');\n searchedElement.length.should.be.equal(0);\n });\n\n it('doesn\\'t render a if `requiredPermissions` prop is not set', () => {\n const props = {\n userPermissions: [],\n };\n\n const mountedComponent = mount(\n \n \n ,\n );\n\n const searchedElement = mountedComponent.find('ChildComponent');\n searchedElement.length.should.be.equal(0);\n });\n\n it('renders nothing if `children` prop is not set', () => {\n const props = {\n userPermissions: [],\n };\n\n const mountedComponent = mount(\n ,\n );\n\n should.not.exist(mountedComponent.find('PermissibleRender').html());\n });\n\n it('renders a if user permissions and required permissions are both empty', () => {\n const props = {\n userPermissions: [],\n requiredPermissions: [],\n };\n\n const mountedComponent = mount(\n \n \n ,\n );\n\n const searchedElement = mountedComponent.find('ChildComponent');\n searchedElement.length.should.be.equal(1);\n });\n\n it('renders a if only required permissions are empty', () => {\n const props = {\n userPermissions: ['SOME_PERMISSION'],\n requiredPermissions: [],\n };\n\n const mountedComponent = mount(\n \n \n ,\n );\n\n const searchedElement = mountedComponent.find('ChildComponent');\n searchedElement.length.should.be.equal(1);\n });\n\n it('doesn\\'t render a if there is a permission mismatch', () => {\n const props = {\n userPermissions: ['REQUIRED_PERMISSION'],\n requiredPermissions: ['ANOTHER_PERMISSION'],\n };\n\n const mountedComponent = mount(\n \n \n ,\n );\n\n const searchedElement = mountedComponent.find('ChildComponent');\n searchedElement.length.should.be.equal(0);\n });\n\n it('renders a if the user has required permission', () => {\n const props = {\n userPermissions: ['REQUIRED_PERMISSION'],\n requiredPermissions: ['REQUIRED_PERMISSION'],\n };\n\n const mountedComponent = mount(\n \n \n ,\n );\n\n const searchedElement = mountedComponent.find('ChildComponent');\n searchedElement.length.should.be.greaterThan(0);\n });\n\n it('renders a if the user doesn\\'t have required permissions and renderOtherwise is given', () => {\n const props = {\n userPermissions: ['REQUIRED_PERMISSION'],\n requiredPermissions: ['NOT_REQUIRED_PERMISSION'],\n renderOtherwise: ,\n };\n\n const mountedComponent = mount(\n \n \n ,\n );\n\n const searchedElement = mountedComponent.find('NotAllowedComponent');\n searchedElement.length.should.be.greaterThan(0);\n });\n\n it('renders a if the user has one of necessary conditions when `oneperm` prop is defined', () => {\n const props = {\n userPermissions: ['ANOTHER_PERMISSION'],\n requiredPermissions: ['REQUIRED_PERMISSION', 'ANOTHER_PERMISSION'],\n oneperm: true,\n };\n\n const mountedComponent = mount(\n \n \n ,\n );\n\n const searchedElement = mountedComponent.find('ChildComponent');\n searchedElement.length.should.be.greaterThan(0);\n });\n\n it('doesn\\'t render a if the user doesn\\'t have all of necessary permissions when `oneperm` prop is explicitly set to false', () => {\n const props = {\n userPermissions: ['REQUIRED_PERMISSION'],\n requiredPermissions: ['REQUIRED_PERMISSION', 'ANOTHER_PERMISSION'],\n oneperm: false,\n };\n\n const mountedComponent = mount(\n \n \n ,\n );\n\n const searchedElement = mountedComponent.find('ChildComponent');\n searchedElement.length.should.be.equal(0);\n });\n});\n"
},
{
"path": "tools/build.js",
"content": "// More info on Webpack's Node API here: https://webpack.github.io/docs/node.js-api.html\n// Allowing console calls below since this is a build file.\n/* eslint-disable no-console */\nconst chalk = require('chalk');\nconst webpack = require('webpack');\n\nconst config = require('../webpack.config.prod');\n\nconst chalkConfig = {\n chalkError: chalk.red,\n chalkSuccess: chalk.green,\n chalkWarning: chalk.yellow,\n chalkProcessing: chalk.blue,\n};\n\nconst { chalkError, chalkSuccess, chalkWarning, chalkProcessing } = chalkConfig;\n\nprocess.env.NODE_ENV = 'production'; // this assures React is built in prod mode and that the Babel dev config doesn't apply.\n\nconsole.log(chalkProcessing('Generating minified bundle. This will take a moment...'));\n\nwebpack(config).run((error, stats) => {\n if (error) { // so a fatal error occurred. Stop here.\n console.log(chalkError(error));\n return 1;\n }\n\n const jsonStats = stats.toJson();\n\n if (jsonStats.hasErrors) {\n return jsonStats.errors.map(error => console.log(chalkError(error)));\n }\n\n if (jsonStats.hasWarnings) {\n console.log(chalkWarning('Webpack generated the following warnings: '));\n jsonStats.warnings.map(warning => console.log(chalkWarning(warning)));\n }\n\n console.log(`Webpack stats: ${stats}`);\n\n // if we got this far, the build succeeded.\n console.log(chalkSuccess('Your app is compiled in production mode in /dist. It\\'s ready to roll!'));\n\n return 0;\n});\n"
},
{
"path": "tools/testSetup.js",
"content": "process.env.NODE_ENV = 'test';\n\n// Disable webpack-specific features for tests since\n// Mocha doesn't know what to do with them.\n/* istanbul ignore next */\n['.css', '.scss', '.png', '.jpg'].forEach(ext => {\n require.extensions[ext] = () => null;\n});\n\n// add required globals\n/* eslint-disable no-empty-function */\n/* istanbul ignore next */\nglobal.logger = function() {};\n/* istanbul ignore next */\nglobal.logger.info = function() {};\n/* istanbul ignore next */\nglobal.logger.apiSuccess = function() {};\n/* istanbul ignore next */\nglobal.logger.apiError = function() {};\n/* istanbul ignore next */\nglobal.logger.warn = function() {};\n/* eslint-enable */\n\n// Register babel so that it will transpile ES6 to ES5\n// before our tests run.\nrequire('babel-register')();\nrequire('babel-polyfill');\n\nconst chai = require('chai');\nconst sinonChai = require('sinon-chai');\nconst chaiAsPromised = require('chai-as-promised');\nconst enzyme = require('enzyme');\nconst Adapter = require('enzyme-adapter-react-16');\n\nenzyme.configure({ adapter: new Adapter() });\n\nchai.use(sinonChai);\nchai.use(chaiAsPromised);\n"
},
{
"path": "types/.eslintrc",
"content": "{\n \"parser\": \"typescript-eslint-parser\",\n \"plugins\": [\"eslint-plugin-typescript\"],\n \"extends\": \"../.eslintrc\",\n \"rules\": {\n \"comma-dangle\":\"off\",\n \"no-unused-vars\": \"off\",\n \"import/no-namespace\": \"off\",\n \"typescript/no-unused-vars\": \"error\"\n }\n}\n"
},
{
"path": "types/react-permissible.d.ts",
"content": "import { Component, ComponentState, ComponentType, ReactNode, ReactNodeArray, StaticLifecycle, ValidationMap, } from 'react';\n\ndeclare module '@brainhubeu/react-permissible' {\n type Permissions = string[];\n\n type Children = ReactNode | ReactNodeArray;\n\n export interface UserAndRequiredPermissions {\n userPermissions: Permissions\n requiredPermissions: Permissions\n }\n\n export interface PermissibleRenderProps extends UserAndRequiredPermissions {\n oneperm?: boolean\n children: Children\n renderOtherwise?: Children\n }\n\n export class PermissibleRender extends Component {\n checkPermissions(): boolean\n }\n\n export function Permissible(\n RestrictedComponent: ComponentType,\n userPermissions: Permissions,\n requiredPermissions: Permissions,\n callbackFunction?: ({ userPermissions, requiredPermissions, }: UserAndRequiredPermissions) => void,\n oneperm?: boolean,\n ): PermissibleHOC\n\n interface PermissibleHOC extends StaticLifecycle {\n new (props: Props, context?: any): Component & TE\n propTypes?: ValidationMap\n contextTypes?: ValidationMap\n childContextTypes?: ValidationMap\n defaultProps?: Partial\n displayName?: string\n }\n}\n"
},
{
"path": "types/tests/.gitignore",
"content": "brainhubeu-react-permissible-*.tgz\nnode_modules/\n"
},
{
"path": "types/tests/.npmrc",
"content": "update-notifier=false\naudit=false\nprefer-offline=true\n"
},
{
"path": "types/tests/Permissible.test.tsx",
"content": "import * as React from 'react';\nimport { render } from 'react-dom';\n// eslint-disable-next-line import/no-unresolved, import/no-extraneous-dependencies, /* this is what we're testing */\nimport { Permissible, UserAndRequiredPermissions } from '@brainhubeu/react-permissible';\n\nfunction callbackFunction({ userPermissions, requiredPermissions }: UserAndRequiredPermissions) {\n // eslint-disable-next-line no-console\n console.info(`\n react-permissible: Access Denied\n userPermissions: ${userPermissions}\n requiredPermissions: ${requiredPermissions}\n `);\n}\n\nconst AccessGranted = ({ message }: { message: string, }) => <>AccessGranted {message};\n\nconst RestrictedComponentWithCallback = Permissible(\n AccessGranted,\n ['ACCESS_DASHBOARD'], // userPermissions\n ['ACCESS_ADMIN'], // requiredPermissions\n callbackFunction,\n);\n\nrender(, document.createElement('div'));\n"
},
{
"path": "types/tests/PermissibleRender.test.tsx",
"content": "import * as React from 'react';\nimport { render } from 'react-dom';\n// eslint-disable-next-line import/no-unresolved, import/no-extraneous-dependencies, /* this is what we're testing */\nimport { PermissibleRender, PermissibleRenderProps } from '@brainhubeu/react-permissible';\n\nconst VIEW_PERMISSION = 'VIEW';\n\nconst permissibleRenderTestProps: PermissibleRenderProps = {\n oneperm: false,\n children: 'restricted content',\n userPermissions: [VIEW_PERMISSION],\n requiredPermissions: [VIEW_PERMISSION],\n renderOtherwise: 'ACCESS DENIED',\n};\n\nrender(, document.createElement('div'));\n"
},
{
"path": "types/tests/package.json",
"content": "{\n \"name\": \"react-permissible-typescript-tests\",\n \"version\": \"1.0.27\",\n \"description\": \"Test publishing the typings of react-permissible package\",\n \"scripts\": {\n \"clean:packed-package\": \"rm ./brainhubeu-react-permissible-*.tgz\",\n \"clean:node-modules\": \"rm -rf ./node_modules/\",\n \"preinstall\": \"npm run clean:packed-package && npm run clean:node-modules\",\n \"pack-parent-package-get-filename\": \"npm pack ../.. | grep \\\\.tgz\",\n \"postinstall\": \"npm install --no-save --no-audit `npm run --silent pack-parent-package-get-filename`\",\n \"test\": \"tsc --project .\",\n \"posttest\": \"echo 'TypeScript typings successfuly compiled!'\"\n },\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/brainhubeu/react-permissible\"\n },\n \"author\": \"Nick Ribal (https://about.me/nickribal)\",\n \"license\": \"MIT\",\n \"dependencies\": {\n \"@types/react\": \"^16.9.41\",\n \"@types/react-dom\": \"^16.9.8\",\n \"react\": \"^16.13.1\",\n \"react-dom\": \"^16.13.1\",\n \"typescript\": \"^3.9.6\"\n }\n}\n"
},
{
"path": "types/tests/tsconfig.json",
"content": "{\n \"compilerOptions\": {\n \"target\": \"es6\",\n \"module\": \"es2015\",\n \"noEmit\": true,\n \"jsx\": \"react\",\n \"strict\": true,\n \"noUnusedLocals\": true,\n \"noUnusedParameters\": true,\n \"noImplicitReturns\": true,\n \"noFallthroughCasesInSwitch\": true,\n \"moduleResolution\": \"node\"\n }\n}\n"
},
{
"path": "webpack.config.prod.js",
"content": "const path = require('path');\n\nconst UglifyJsPlugin = require('uglifyjs-webpack-plugin');\n\nmodule.exports = {\n externals: [\n {\n 'react-dom': {\n root: 'ReactDOM',\n commonjs2: 'react-dom',\n commonjs: 'react-dom',\n amd: 'react-dom',\n },\n },\n {\n react: {\n root: 'React',\n commonjs2: 'react',\n commonjs: 'react',\n amd: 'react',\n },\n },\n ],\n resolve: {\n extensions: ['.js', '.jsx', '.json'],\n modules: [\n 'node_modules',\n path.join(__dirname, 'src'),\n ],\n },\n devtool: 'source-map',\n entry: './src/index.js',\n output: {\n filename: 'react-permissible.js',\n library: 'react-permissible',\n libraryTarget: 'umd',\n path: path.resolve(__dirname, 'lib'),\n umdNamedDefine: true,\n },\n optimization: {\n minimizer: [\n new UglifyJsPlugin({\n sourceMap: false,\n }),\n ],\n },\n module: {\n rules: [\n {\n test: /\\.jsx?$/,\n exclude: /node_modules/,\n use: ['babel-loader'],\n },\n ],\n },\n};\n"
}
]