{"_id":"@ampraveeen/nestjs-user-management","_rev":"1-e670ebf524115345b7eee7d32800d67e","name":"@ampraveeen/nestjs-user-management","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@ampraveeen/nestjs-user-management","version":"1.0.0","description":"Nestjs user management is npm package (for nestjs) for manage users,rbac & auth for lms project","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"rimraf dist && tsc","prepublish":"npm run build"},"dependencies":{"@nestjs/common":"^7.4.2","@nestjs/core":"^7.4.2","@nestjs/jwt":"^7.1.0","@nestjs/mongoose":"^7.0.2","@nestjs/passport":"^7.1.0","@nestjs/platform-express":"^7.4.2","bcrypt":"^5.0.0","class-transformer":"^0.3.2","class-validator":"^0.12.2","mongoose":"^5.10.0","mongoose-unique-validator":"^2.0.3","passport":"^0.4.1","passport-jwt":"^4.0.0","reflect-metadata":"^0.1.13","rxjs":"^6.6.2"},"devDependencies":{"@types/node":"^14.6.0","@types/passport-jwt":"^3.0.3","rimraf":"^3.0.2","typescript":"^3.9.7"},"peerDependencies":{"@nestjs/common":"^7.4.2","@nestjs/core":"^7.4.2","@nestjs/jwt":"^7.1.0","@nestjs/mongoose":"^7.0.2","@nestjs/passport":"^7.1.0","bcrypt":"^5.0.0","class-validator":"^0.12.2","mongoose":"^5.10.0","mongoose-unique-validator":"^2.0.3","passport-jwt":"^4.0.0"},"repository":{"type":"git","url":"git+https://github.com/ampraveeen/nest-user-management.git"},"author":{"name":"Praveen Sharma"},"license":"ISC","bugs":{"url":"https://github.com/ampraveeen/nest-user-management/issues"},"homepage":"https://github.com/ampraveeen/nest-user-management#readme","gitHead":"0b2c4da72309acd3bb5564f12643951051b10057","_id":"@ampraveeen/nestjs-user-management@1.0.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-PH4pZfsv9Qzv6ndbWZIDBGwpoKFxjv3tr/ia5lisnLgzmST7XRwXUStWjVAUIyfN/ljVbXDzbk0dFtqHh2FNOQ==","shasum":"f1fd50cc02b552ef050e0086a87483b8675a0389","tarball":"https://registry.npmjs.org/@ampraveeen/nestjs-user-management/-/nestjs-user-management-1.0.0.tgz","fileCount":65,"unpackedSize":121009,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgF/NeCRA9TVsSAnZWagAAKXsP/jbEHqxUJIlJtvZJUXYi\nRH+uI500ZIqZ2K+IFbLkX/45tTxG47erUL+N/w8VzvavS3mDTiFUDXu5FfOo\nmEFYmp4CQu6B1I5RtN9i2+wLZlCO9PCGxoxF+UD3AY91u5k/+h3v8DJfwrzX\nBfOCrh82WI6xaaoOHbOMBwsYVhbXau2ismqOHTtJSZHCDBclLGt1rvCzvpw2\nkgjT0zzWvtViMCcYFT1GCJMe97F1frilMaJyPwwUritaGTSH9TESpNMa7K34\nvFdE/KbYIPWoU2sZ+iOa1nZYTEvgsWJNpRqjHVl3HwyeMeuzHAKPiZdcqMgz\nHYjk4y38Dy1kAmVLT2GpoxjXIO/cH2WE0Epb6u2yIZBCetZ2afzdEcGlci1h\nPMsYBIa9qTdNMZOhSZ4l7zIou8xssSIbchuZcvu2WToqzi/BpRCFe1ulQw78\nmmcq4n/io9PI936ehrKzdS2C1HsyKtpRvYjug09Z19ZEwy3Dbg+F0mvxznST\nw8AA3MFgtp1+ujkk+/jYSZxWHBV2Gj7XGkYQ0uvN8b3bgiaI3JEFO70YQ2Nd\nyWO5axWE4zAf520F6/+EyVO8cnmr0kMV6yvzxfiUU83vHxncC947SI11c2m0\nSuFz0dg3SQnw4eYsYTI/k2fyJy+M1S84Ip3ZG6Nc+hE6d+B1wvXFqTNdDVBc\nKixi\r\n=EfDg\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA2Urn4FYnFiKtJ74U/7jPPFqRP0uaNN01QwwqkRRP/FAiEAxRHKBbCe2NccTVRF1QuoBj6fa45l/v2i8j+mYrHgdws="}]},"_npmUser":{"name":"ampraveeen","email":"praveen@amcipher.com"},"directories":{},"maintainers":[{"name":"ampraveeen","email":"praveen@amcipher.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nestjs-user-management_1.0.0_1612182366355_0.418510445803834"},"_hasShrinkwrap":false}},"time":{"created":"2021-02-01T12:26:06.314Z","1.0.0":"2021-02-01T12:26:06.510Z","modified":"2022-04-04T13:52:55.157Z"},"maintainers":[{"name":"ampraveeen","email":"praveen@amcipher.com"}],"description":"Nestjs user management is npm package (for nestjs) for manage users,rbac & auth for lms project","homepage":"https://github.com/ampraveeen/nest-user-management#readme","repository":{"type":"git","url":"git+https://github.com/ampraveeen/nest-user-management.git"},"author":{"name":"Praveen Sharma"},"bugs":{"url":"https://github.com/ampraveeen/nest-user-management/issues"},"license":"ISC","readme":"## Description\n\nNestjs user management is npm package (for nestjs) for manage users,rbac & auth for lms project\n\n## Requirements\n\nYou need to have nestjs app with mogodb database. Setup MongooseModule first.\n\n## Installation\n\n```bash\n$ npm install nest-user-management\n```\n\n## How to use\n\n- In your AppModule file import UserAuthModule from nestjs-user-management and registet it with your configOption in imports\n\n```bash\nimport { UserAuthModule } from 'nest-user-management';\n.\n.\n.\nimports: [...,\n      UserAuthModule.register({\n        authOptions,\n        jwtOptions:{\n          secret: 'your jwt secret',\n          signOptions: { expiresIn: 'jwt validity time' }\n        },\n        rbacOptions: {\n          AppPermissions:'your custom permissions array'\n          AppRoles:'your custom assign permissions array'\n        }\n      })\n    ]\n```\n\nprovide the cofiguration details as mentioned above.\n\nNow you can access /auth , /users, /rbac APIs provided by package.\n\n## First Steps\n\n1.  Create a superadmin user.\n\n2.  now create default permissions.\n\n3.  now create vendor, teacher and student roles.\n\n## Setting Permission & Using Guards\n\n1.  Use JwtAuthGuard (from auth module) for setting jwt token authorization to API.\n\n2.  Use OrganizationGuard ( from organization module ) for APIs which need organizationId to complete.\n\n3.  To set permission to your API route use RolesGuard & setRoute (for setting unique api code to your route)\n\n4.  User RolesGuard (from rbac module ) for sverifying role permissions.\n\n```bash\nimport { JwtAuthGuard, RolesGuard  } from 'nest-user-management';\n\n  @Get('')\n  @UseGuards(JwtAuthGuard,RolesGuard)\n  @RouteCode('get_test_data')// unique api code\n  getHello() {\n    return this.service.gethello();\n  }\n\n```\n\n## Notes\n\n- If user register as vendor, after registration he needs to create an organization first.\n\n## Stay in touch\n\n- Author - [Praveen Sharma](https://github.com/ampraveeen)\n- Website - [https://amcipher.com](https://amcipher.com/)\n\n## License\n\nNest is [MIT licensed](LICENSE).\n","readmeFilename":"README.md"}