Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xixilive/feathers-authentication-weapp
微信小程序 Authentication for feathersjs
https://github.com/xixilive/feathers-authentication-weapp
Last synced: about 2 months ago
JSON representation
微信小程序 Authentication for feathersjs
- Host: GitHub
- URL: https://github.com/xixilive/feathers-authentication-weapp
- Owner: xixilive
- License: mit
- Created: 2020-04-21T10:07:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T03:55:35.000Z (about 2 years ago)
- Last Synced: 2024-08-03T18:15:22.563Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 727 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-feathersjs - feathers-authentication-weapp - Wechat mini-program authentication strategy for feathers. (Plugins / Social media)
README
## 微信小程序 Authentication for [Feathers](https://github.com/feathersjs)
## Install
```sh
npm i @feathers-weapp/auth
```
## Usage
### Step1: update feathers configuration
add new authentication strategy into feathers default configuration json file.
```js
// config/default.json
"authentication": {
"authStrategies": [
// ...
"weapp" // strategy name, such as wxauth, whatever
],
// ...
"weapp": { // keep identic with strategy name
"appId": "WX_APP_ID",
"appSecret": "WX_APP_SECRET"
}
},
```
### Step2: setup auth strategy in authentication service
Implements the `entityResolver` protocol and register new auth-strategy.
```js
// authentication.js
const WeappStrategy = require('@feathers-weapp/auth')
// declare a function to find, patch or create authentication entity(eg: users)
const entityResolverBuilder = (strategy) => {
const {configuration:{key, secret}, entityService:service} = strategy
const decrypt = WeappStrategy.decipherer(key, secret)
return {
// to decrypt encrypted data which post from clients
async decryptData(rawData, params) {
return await decrypt(rawData)
},
// to find an entity with specified auth-data
async findEntity(authData, params) {
const [entity] = await service.find({query: {openId: authData.openId, $limit: 1}, paginate: false})
return entity
},
// optional, to update an entity with specified auth-data
async patchEntity(entity, authData, params) {
return await service.path(entity.id, {userInfo: authData.userInfo})
},
// to create an entity when not found
async createEntity(authData, params) {
return await service.create({openId: authData.openId, userInfo: authData.userInfo})
}
}
}
module.exports = function configureAuthenticationService(app) {
const authentication = new AuthenticationService(app);
// ... skipped
authentication.register('weapp', new WeappStrategy(entityResolverBuilder));
// ... skipped
}
```
```js
// client
const app = feathers()
app.service('authentication').create({
strategy: 'weapp',
code: 'login code',
rawData: '',
signature: '',
encryptedData: '',
iv: ''
}).then(({accessToken}) => console.log('JWT token', accessToken))
```
## API
### rawData object
```ts
interface rawData {
code: string;
rawData: string;
signature: string;
encryptedData: string;
iv: string
}
```
### authData object
```ts
interface authData {
openId: string;
sessionKey: string;
userInfo: userInfo
}
```
### userInfo object
```ts
interface userInfo {
nickname: string;
gender: number;
language: string;
city: string;
province: string;
country: string;
avatarUrl: string;
unionId?: string;
watermark: any
}
```
### entityResolver object
```ts
interface entityResolver {
decryptData(rawData: rawData, params: object): object;
findEntity(authData: authData, params: object): Entity | null;
[patchEntity(entity: Entity, authData: authData, params: object)]: Entity;
createEntity(entity: object, authData: authData, params: object): Entity;
}
```
### entityResolverBuilder function
```ts
function entityResolverBuilder(strategy:WeappStrategy):entityResolver
```
### WeappStrategy class
```ts
class WeappStrategy {
constructor(builder:entityResolverBuilder);
app:Application;
name:string;
authentication:AuthenticationBase;
configuration:object;
entityService:Service;
}
```