Skip to content

Commit d673b49

Browse files
chore: add missing express-session package
1 parent 605b6d8 commit d673b49

File tree

3 files changed

+140
-10
lines changed

3 files changed

+140
-10
lines changed

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,12 @@
4141
"typescript": "^3.9.7"
4242
},
4343
"dependencies": {
44+
"@admin-bro/express": "^3.0.0-beta.3",
4445
"@nestjs/common": "^7.4.2",
4546
"@nestjs/core": "^7.4.2",
4647
"@types/express-session": "^1.17.0",
47-
"@admin-bro/express": "^3.0.0-beta.3",
4848
"express-formidable": "^1.2.0",
49+
"express-session": "^1.17.1",
4950
"reflect-metadata": "^0.1.13",
5051
"rxjs": "^6.5.3"
5152
}

src/index.ts

Lines changed: 75 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,94 @@
1717
* into the root AppModule.
1818
*
1919
* ```
20+
* import { Module } from '@nestjs/common';
21+
* import { AdminModule } from '@admin-bro/nestjs';
22+
*
23+
* @Module({
24+
* imports: [
25+
* AdminModule.createAdminModule({
26+
* useFactory: () => ({
27+
* adminBroOptions: {
28+
* rootPath: '/admin',
29+
* resources: [],
30+
* },
31+
* }),
32+
* }),
33+
* ],
34+
* })
35+
* export class AppModule {}
36+
* ```
37+
*
38+
* Then enter `/admin` path in your browser and you should see the AdminBro.
39+
*
40+
* 3. Passing resources
2041
*
42+
* Let say you use @nestjs/typeorm module, and you have users module.
2143
*
44+
* - you have to install @admin-bro/typeorm adapter
45+
* - you have to register it in AdminBro (as stated in the docs)
46+
* - and you have to pass it to your options
2247
*
48+
* ```
49+
* import AdminBro from 'admin-bro';
2350
* import { Module } from '@nestjs/common';
2451
* import { AdminModule } from '@admin-bro/nestjs';
52+
* import { Database, Resource } from '@admin-bro/typeorm'
53+
* import { TypeOrmModule } from '@nestjs/typeorm';
54+
* import { UsersModule } from './users/users.module';
55+
*
56+
* AdminBro.registerAdapter({ Database, Resource })
2557
*
2658
* @Module({
2759
* imports: [
28-
* AdminModule.createAdminModule({
29-
* // module options
60+
* // you will have to change connection data of course :)
61+
* TypeOrmModule.forRoot({
62+
* type: 'postgres',
63+
* host: 'localhost',
64+
* port: 5432,
65+
* username: 'postgres',
66+
* password: '',
67+
* database: 'database_test',
68+
* entities: [User],
69+
* synchronize: true,
3070
* }),
71+
* AdminModule.createAdminModule({
72+
* useFactory: () => ({
73+
* adminBroOptions: {
74+
* rootPath: '/admin',
75+
* resources: [User],
76+
* },
77+
* }),
78+
* }),
3179
* ],
3280
* })
3381
* export class AppModule {}
3482
* ```
83+
*
84+
* ## Authentication
85+
*
86+
* Apart from the `adminBroOptions` useFactory can return `auth` settings.
87+
*
88+
* This is an example which always logs users in, since authenticate method
89+
* always returns a Promise resolving to {@link CurrentAdmin}. You may
90+
* want to compare the password against what what you have encrypted
91+
* in the database.
92+
*
93+
* ```
94+
* AdminModule.createAdminModule({
95+
* useFactory: () => ({
96+
* adminBroOptions: {
97+
* rootPath: '/admin',
98+
* resources: [User],
99+
* },
100+
* auth: {
101+
* authenticate: async (email, password) => Promise.resolve({ email: 'test' }),
102+
* cookieName: 'test',
103+
* cookiePassword: 'testPass',
104+
* },
105+
* }),
106+
* ```
107+
*
35108
*/
36109

37110
import * as NestJSPlugin from './admin.module'

yarn.lock

Lines changed: 63 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2792,6 +2792,16 @@ convert-source-map@^1.5.0, convert-source-map@^1.5.1, convert-source-map@^1.7.0:
27922792
dependencies:
27932793
safe-buffer "~5.1.1"
27942794

2795+
cookie-signature@1.0.6:
2796+
version "1.0.6"
2797+
resolved "https://registry.yarnpkg.com/cookie-signature/-/cookie-signature-1.0.6.tgz#e303a882b342cc3ee8ca513a79999734dab3ae2c"
2798+
integrity sha1-4wOogrNCzD7oylE6eZmXNNqzriw=
2799+
2800+
cookie@0.4.0:
2801+
version "0.4.0"
2802+
resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.4.0.tgz#beb437e7022b3b6d49019d088665303ebe9c14ba"
2803+
integrity sha512-+Hp8fLp57wnUSt0tY0tHEXh4voZRDnoIrZPqlo3DPiI4y9lwg/jqx+1Om94/W6ZaPDOUbnjOt/99w66zk+l1Xg==
2804+
27952805
copy-concurrently@^1.0.0:
27962806
version "1.0.5"
27972807
resolved "https://registry.yarnpkg.com/copy-concurrently/-/copy-concurrently-1.0.5.tgz#92297398cae34937fcafd6ec8139c18051f0b5e0"
@@ -2981,6 +2991,13 @@ dateformat@^3.0.0:
29812991
resolved "https://registry.yarnpkg.com/dateformat/-/dateformat-3.0.3.tgz#a6e37499a4d9a9cf85ef5872044d62901c9889ae"
29822992
integrity sha512-jyCETtSl3VMZMWeRo7iY1FL19ges1t55hMo5yaam4Jrsm5EPL89UQkoQRyiI+Yf4k8r2ZpdngkV8hr1lIdjb3Q==
29832993

2994+
debug@2.6.9, debug@^2.6.9:
2995+
version "2.6.9"
2996+
resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f"
2997+
integrity sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==
2998+
dependencies:
2999+
ms "2.0.0"
3000+
29843001
debug@3.1.0, debug@=3.1.0:
29853002
version "3.1.0"
29863003
resolved "https://registry.yarnpkg.com/debug/-/debug-3.1.0.tgz#5bb5a0672628b64149566ba16819e61518c67261"
@@ -2995,13 +3012,6 @@ debug@4, debug@^4.0.0, debug@^4.0.1, debug@^4.1.0, debug@^4.1.1:
29953012
dependencies:
29963013
ms "^2.1.1"
29973014

2998-
debug@^2.6.9:
2999-
version "2.6.9"
3000-
resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f"
3001-
integrity sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==
3002-
dependencies:
3003-
ms "2.0.0"
3004-
30053015
debug@^3.1.0:
30063016
version "3.2.6"
30073017
resolved "https://registry.yarnpkg.com/debug/-/debug-3.2.6.tgz#e83d17de16d8a7efb7717edbe5fb10135eee629b"
@@ -3078,6 +3088,11 @@ delegates@^1.0.0:
30783088
resolved "https://registry.yarnpkg.com/delegates/-/delegates-1.0.0.tgz#84c6e159b81904fdca59a0ef44cd870d31250f9a"
30793089
integrity sha1-hMbhWbgZBP3KWaDvRM2HDTElD5o=
30803090

3091+
depd@~2.0.0:
3092+
version "2.0.0"
3093+
resolved "https://registry.yarnpkg.com/depd/-/depd-2.0.0.tgz#b696163cc757560d09cf22cc8fad1571b79e76df"
3094+
integrity sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==
3095+
30813096
deprecation@^2.0.0, deprecation@^2.3.1:
30823097
version "2.3.1"
30833098
resolved "https://registry.yarnpkg.com/deprecation/-/deprecation-2.3.1.tgz#6368cbdb40abf3373b525ac87e4a260c3a700919"
@@ -3639,6 +3654,20 @@ express-formidable@^1.2.0:
36393654
dependencies:
36403655
formidable "^1.0.17"
36413656

3657+
express-session@^1.17.1:
3658+
version "1.17.1"
3659+
resolved "https://registry.yarnpkg.com/express-session/-/express-session-1.17.1.tgz#36ecbc7034566d38c8509885c044d461c11bf357"
3660+
integrity sha512-UbHwgqjxQZJiWRTMyhvWGvjBQduGCSBDhhZXYenziMFjxst5rMV+aJZ6hKPHZnPyHGsrqRICxtX8jtEbm/z36Q==
3661+
dependencies:
3662+
cookie "0.4.0"
3663+
cookie-signature "1.0.6"
3664+
debug "2.6.9"
3665+
depd "~2.0.0"
3666+
on-headers "~1.0.2"
3667+
parseurl "~1.3.3"
3668+
safe-buffer "5.2.0"
3669+
uid-safe "~2.1.5"
3670+
36423671
ext@^1.1.2:
36433672
version "1.4.0"
36443673
resolved "https://registry.yarnpkg.com/ext/-/ext-1.4.0.tgz#89ae7a07158f79d35517882904324077e4379244"
@@ -5995,6 +6024,11 @@ object.values@^1.1.1:
59956024
function-bind "^1.1.1"
59966025
has "^1.0.3"
59976026

6027+
on-headers@~1.0.2:
6028+
version "1.0.2"
6029+
resolved "https://registry.yarnpkg.com/on-headers/-/on-headers-1.0.2.tgz#772b0ae6aaa525c399e489adfad90c403eb3c28f"
6030+
integrity sha512-pZAE+FJLoyITytdqK0U5s+FIpjN0JP3OzFi/u8Rx+EV5/W+JTWGXG8xFzevE7AjBfDqHv/8vL8qQsIhHnqRkrA==
6031+
59986032
once@^1.3.0, once@^1.3.1, once@^1.4.0, once@~1.4.0:
59996033
version "1.4.0"
60006034
resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1"
@@ -6264,6 +6298,11 @@ parse-json@^5.0.0:
62646298
json-parse-better-errors "^1.0.1"
62656299
lines-and-columns "^1.1.6"
62666300

6301+
parseurl@~1.3.3:
6302+
version "1.3.3"
6303+
resolved "https://registry.yarnpkg.com/parseurl/-/parseurl-1.3.3.tgz#9da19e7bee8d12dff0513ed5b76957793bc2e8d4"
6304+
integrity sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==
6305+
62676306
path-exists@^3.0.0:
62686307
version "3.0.0"
62696308
resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-3.0.0.tgz#ce0ebeaa5f78cb18925ea7d810d7b59b010fd515"
@@ -6567,6 +6606,11 @@ raf@^3.4.0:
65676606
dependencies:
65686607
performance-now "^2.1.0"
65696608

6609+
random-bytes@~1.0.0:
6610+
version "1.0.0"
6611+
resolved "https://registry.yarnpkg.com/random-bytes/-/random-bytes-1.0.0.tgz#4f68a1dc0ae58bd3fb95848c30324db75d64360b"
6612+
integrity sha1-T2ih3Arli9P7lYSMMDJNt11kNgs=
6613+
65706614
randombytes@^2.1.0:
65716615
version "2.1.0"
65726616
resolved "https://registry.yarnpkg.com/randombytes/-/randombytes-2.1.0.tgz#df6f84372f0270dc65cdf6291349ab7a473d4f2a"
@@ -7249,6 +7293,11 @@ rxjs@^6.5.3:
72497293
dependencies:
72507294
tslib "^1.9.0"
72517295

7296+
safe-buffer@5.2.0:
7297+
version "5.2.0"
7298+
resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.0.tgz#b74daec49b1148f88c64b68d49b1e815c1f2f519"
7299+
integrity sha512-fZEwUGbVl7kouZs1jCdMLdt95hdIv0ZeHg6L7qPeciMZhZ+/gdesW4wgTARkrFWEpspjEATAzUGPG8N2jJiwbg==
7300+
72527301
safe-buffer@^5.0.1, safe-buffer@^5.1.0, safe-buffer@^5.1.1, safe-buffer@^5.1.2, safe-buffer@^5.2.0, safe-buffer@~5.2.0:
72537302
version "5.2.1"
72547303
resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6"
@@ -8159,6 +8208,13 @@ uid-number@0.0.6:
81598208
resolved "https://registry.yarnpkg.com/uid-number/-/uid-number-0.0.6.tgz#0ea10e8035e8eb5b8e4449f06da1c730663baa81"
81608209
integrity sha1-DqEOgDXo61uOREnwbaHHMGY7qoE=
81618210

8211+
uid-safe@~2.1.5:
8212+
version "2.1.5"
8213+
resolved "https://registry.yarnpkg.com/uid-safe/-/uid-safe-2.1.5.tgz#2b3d5c7240e8fc2e58f8aa269e5ee49c0857bd3a"
8214+
integrity sha512-KPHm4VL5dDXKz01UuEd88Df+KzynaohSL9fBh096KWAxSKZQDI2uBrVqtvRM4rwrIrRRKsdLNML/lnaaVSRioA==
8215+
dependencies:
8216+
random-bytes "~1.0.0"
8217+
81628218
umask@^1.1.0, umask@~1.1.0:
81638219
version "1.1.0"
81648220
resolved "https://registry.yarnpkg.com/umask/-/umask-1.1.0.tgz#f29cebf01df517912bb58ff9c4e50fde8e33320d"

0 commit comments

Comments
 (0)