@igxjs/node-components 1.0.3 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +1 -1
  2. package/index.d.ts +25 -15
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -87,7 +87,7 @@ app.get('/auth/logout', session.logout());
87
87
 
88
88
  #### API Methods
89
89
 
90
- - **`setup(app, config, updateUser)`** - Initialize session configurations
90
+ - **`setup(app, updateUser)`** - Initialize session configurations
91
91
  - **`authenticate(isDebugging?, redirectUrl?)`** - Resource protection middleware
92
92
  - **`callback(initUser)`** - SSO callback handler for successful login
93
93
  - **`identityProviders()`** - Get available identity providers
package/index.d.ts CHANGED
@@ -1,9 +1,8 @@
1
1
  import 'express-session';
2
- import '@types/express';
3
2
 
4
3
  import { AxiosError } from 'axios';
5
4
  import { RedisClientType } from '@redis/client';
6
- import { Application, RequestHandler, Request, Response, NextFunction, Router } from '@types/express';
5
+ import { Application, RequestHandler, Request, Response, NextFunction, Router } from 'express';
7
6
 
8
7
  // Session Configuration
9
8
  export interface SessionConfig {
@@ -93,10 +92,9 @@ export class SessionManager {
93
92
  */
94
93
  setup(
95
94
  app: Application,
96
- config: SessionConfig,
97
95
  updateUser: (user: SessionUser | undefined) => any
98
96
  ): Promise<void>;
99
-
97
+
100
98
  /**
101
99
  * Resource protection middleware
102
100
  * @param isDebugging Debugging flag (default: false)
@@ -104,26 +102,26 @@ export class SessionManager {
104
102
  * @returns Returns express Request Handler
105
103
  */
106
104
  authenticate(isDebugging?: boolean, redirectUrl?: string): RequestHandler;
107
-
105
+
108
106
  /**
109
107
  * SSO callback for successful login
110
108
  * @param initUser Initialize user object function
111
109
  * @returns Returns express Request Handler
112
110
  */
113
111
  callback(initUser: (user: SessionUser) => SessionUser): RequestHandler;
114
-
112
+
115
113
  /**
116
114
  * Get Identity Providers
117
115
  * @returns Returns express Request Handler
118
116
  */
119
117
  identityProviders(): RequestHandler;
120
-
118
+
121
119
  /**
122
120
  * Application logout (NOT SSO)
123
121
  * @returns Returns express Request Handler
124
122
  */
125
123
  logout(): RequestHandler;
126
-
124
+
127
125
  /**
128
126
  * Refresh user session
129
127
  * @param initUser Initialize user object function
@@ -135,9 +133,9 @@ export class SessionManager {
135
133
  // Custom Error class
136
134
  export class CustomError extends Error {
137
135
  code: number;
138
- object;
136
+ data: object;
139
137
  error: object;
140
-
138
+
141
139
  /**
142
140
  * Construct a custom error
143
141
  * @param code Error code
@@ -153,7 +151,7 @@ export class FlexRouter {
153
151
  context: string;
154
152
  router: Router;
155
153
  handlers: RequestHandler[];
156
-
154
+
157
155
  /**
158
156
  * Constructor
159
157
  * @param context Context path
@@ -161,7 +159,7 @@ export class FlexRouter {
161
159
  * @param handlers Request handlers (optional)
162
160
  */
163
161
  constructor(context: string, router: Router, handlers?: RequestHandler[]);
164
-
162
+
165
163
  /**
166
164
  * Mount router to Express app
167
165
  * @param app Express application
@@ -179,19 +177,19 @@ export class RedisManager {
179
177
  * @returns Returns true if Redis server is connected
180
178
  */
181
179
  connect(redisUrl: string, certPath: string): Promise<boolean>;
182
-
180
+
183
181
  /**
184
182
  * Get Redis client
185
183
  * @returns Returns Redis client instance
186
184
  */
187
185
  getClient(): RedisClientType;
188
-
186
+
189
187
  /**
190
188
  * Determine if the Redis server is connected
191
189
  * @returns Returns true if Redis server is connected
192
190
  */
193
191
  isConnected(): Promise<boolean>;
194
-
192
+
195
193
  /**
196
194
  * Disconnect from Redis
197
195
  * @returns Returns nothing
@@ -269,6 +267,18 @@ export function httpErrorHandler(
269
267
  next: NextFunction
270
268
  ): void;
271
269
 
270
+ /**
271
+ * HTTP not found handler middleware
272
+ * @param req Express Request
273
+ * @param res Express Response
274
+ * @param next Next function
275
+ */
276
+ export function httpNotFoundHandler(
277
+ req: Request,
278
+ res: Response,
279
+ next: NextFunction
280
+ ): void;
281
+
272
282
  declare global {
273
283
  namespace Express {
274
284
  export interface Request {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@igxjs/node-components",
3
- "version": "1.0.3",
3
+ "version": "1.0.5",
4
4
  "description": "Node components for igxjs",
5
5
  "main": "index.js",
6
6
  "type": "module",