piral-auth
Advanced tools
Comparing version 0.9.0-pre.763 to 0.9.0-pre.765
import { Extend } from 'piral-core'; | ||
import { PiralAuthApi, UserInfo } from './types'; | ||
/** | ||
* Available configuration options for the auth extension. | ||
* Available configuration options for the auth plugin. | ||
*/ | ||
@@ -13,4 +13,4 @@ export interface AuthConfig { | ||
/** | ||
* Creates a new Piral API extension for enabling authentication support. | ||
* Creates new Pilet API extensions for enabling authentication support. | ||
*/ | ||
export declare function createAuthApi(config?: AuthConfig): Extend<PiralAuthApi>; |
@@ -6,3 +6,3 @@ "use strict"; | ||
/** | ||
* Creates a new Piral API extension for enabling authentication support. | ||
* Creates new Pilet API extensions for enabling authentication support. | ||
*/ | ||
@@ -9,0 +9,0 @@ function createAuthApi(config = {}) { |
{ | ||
"name": "piral-auth", | ||
"version": "0.9.0-pre.763", | ||
"description": "Extensions for handling authentication in Piral.", | ||
"version": "0.9.0-pre.765", | ||
"description": "Plugin for handling authentication in Piral.", | ||
"keywords": [ | ||
@@ -12,3 +12,3 @@ "piral", | ||
"api", | ||
"extension", | ||
"plugin", | ||
"user", | ||
@@ -40,3 +40,3 @@ "authentication" | ||
"devDependencies": { | ||
"piral-core": "^0.9.0-pre.763" | ||
"piral-core": "^0.9.0-pre.765" | ||
}, | ||
@@ -46,3 +46,3 @@ "peerDependencies": { | ||
}, | ||
"gitHead": "244d493ecf0c7986e549b0ee2fe48feb20c52cd9" | ||
"gitHead": "81e14b202558d9c3bcf2f8bfdf0b758d0b4b1043" | ||
} |
@@ -5,6 +5,8 @@ [![Piral Logo](https://github.com/smapiot/piral/raw/master/docs/assets/logo.png)](https://piral.io) | ||
This is an extension library that only has a peer dependency to `piral-core`. What `piral-auth` brings to the table is a set of API extensions that can be used with `piral` or `piral-core`. | ||
This is a plugin that only has a peer dependency to `piral-core`. What `piral-auth` brings to the table is a set of Pilet API extensions that can be used with `piral` or `piral-core`. | ||
By default, these extensions are not integrated in `piral`, so you'd need to add them to your Piral instance. The set includes the `getUser` API to retrieve the user, login / logout functionality and user state management incl. features and permissions. | ||
The set includes the `getUser` API to retrieve the user, login / logout functionality and user state management incl. features and permissions. | ||
By default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance. | ||
## Documentation | ||
@@ -11,0 +13,0 @@ |
@@ -7,3 +7,3 @@ import * as actions from './actions'; | ||
/** | ||
* Available configuration options for the auth extension. | ||
* Available configuration options for the auth plugin. | ||
*/ | ||
@@ -18,3 +18,3 @@ export interface AuthConfig { | ||
/** | ||
* Creates a new Piral API extension for enabling authentication support. | ||
* Creates new Pilet API extensions for enabling authentication support. | ||
*/ | ||
@@ -21,0 +21,0 @@ export function createAuthApi(config: AuthConfig = {}): Extend<PiralAuthApi> { |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
66
12268