Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pure180/loopback-session
"Express-Session" implementation for loopback-next
https://github.com/pure180/loopback-session
express-session loopback-next nodejs restful-api session-management
Last synced: 11 days ago
JSON representation
"Express-Session" implementation for loopback-next
- Host: GitHub
- URL: https://github.com/pure180/loopback-session
- Owner: pure180
- License: other
- Created: 2020-04-30T06:44:27.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-19T16:27:55.000Z (3 months ago)
- Last Synced: 2024-11-05T11:18:24.832Z (about 2 months ago)
- Topics: express-session, loopback-next, nodejs, restful-api, session-management
- Language: TypeScript
- Size: 433 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @loopback/session
## This package is *Work In Progress*
**Bucket list**
- optimize code
- create unit tests
- Create inline documentations
- Improve the documentation
- Check the requirements for extending the loopback base packages
## Architecture Overview
Upcoming next
## Usage
To use this component, you need to have an existing LoopBack 4 application.
- create app: run `lb4 app`
Next enable the session system in your application:
- register session component in application
Check The Code
```ts
import { SessionBindings, SessionComponent, SessionConfig } from '@loopback/session';
export class MyApplication extends BootMixin(
ServiceMixin(RepositoryMixin(RestApplication)),
) {
constructor(options: ApplicationConfig = {}) {
super(options);
// - configure the session -
this.configure(SessionBindings.COMPONENT).to({
// Assign your existing data source
DataSource: MemoryDataSource,
// Assign the session configuration
session: {
secret: 'xyz_12345678_zyx',
resave: false,
saveUninitialized: false,
name: 'sid'
}
});
// - register the session Component
this.component(SessionComponent);
// Set up the custom sequence
this.sequence(MySequence);
// Set up default home page
this.static('/', path.join(__dirname, '../public'));
this.projectRoot = __dirname;
// Customize @loopback/boot Booter Conventions here
this.bootOptions = {};
}
}
```
- Setup your sequence and wrap the request and response with the session provider.
Check The Code
```ts
import { inject } from '@loopback/context';
import {
FindRoute,
InvokeMethod,
ParseParams,
Reject,
RequestContext,
RestBindings,
Send,
SequenceHandler,
} from '@loopback/rest';
import { SessionFn, SessionBindings, SessionRequest } from '@loopback/session';
const SequenceActions = RestBindings.SequenceActions;
export class MySequence implements SequenceHandler {
constructor(
@inject(SequenceActions.FIND_ROUTE)
protected findRoute: FindRoute,
@inject(SequenceActions.PARSE_PARAMS)
protected parseParams: ParseParams,
@inject(SequenceActions.INVOKE_METHOD)
protected invoke: InvokeMethod,
@inject(SequenceActions.SEND)
public send: Send,
@inject(SequenceActions.REJECT)
public reject: Reject,
// Inject the session provider
@inject(SessionBindings.PROVIDER)
protected session: SessionFn,
) {}
async handle(context: RequestContext) {
try {
// Wrap the incoming and outgoing messages with the session provider.
const {
request,
response
} = await this.session(context.request as SessionRequest, context.response as Response);
const route = this.findRoute(request);
const args = await this.parseParams(request, route);
const result = await this.invoke(route, args);
this.send(response, result);
} catch (err) {
this.reject(context, err);
}
}
}
```
## Contributions
- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md)
- [Join the team](https://github.com/strongloop/loopback-next/issues/110)
## Tests
Run `npm test` from the root folder.
## Contributors
See
[all contributors](https://github.com/strongloop/loopback-next/graphs/contributors).
## License
MIT