@bitblit/ratchet-warden-common 4.0.1-alpha
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.
- package/CHANGELOG.md +19 -0
- package/License.txt +13 -0
- package/README.md +38 -0
- package/lib/build/ratchet-warden-common-info.d.ts +5 -0
- package/lib/client/provider/warden-client-abstract-recent-login-provider.d.ts +13 -0
- package/lib/client/provider/warden-client-current-logged-in-jwt-token-provider.d.ts +3 -0
- package/lib/client/provider/warden-client-local-storage-logged-in-user-provider.d.ts +9 -0
- package/lib/client/provider/warden-client-local-storage-recent-login-provider.d.ts +8 -0
- package/lib/client/provider/warden-client-recent-login-provider.d.ts +10 -0
- package/lib/client/provider/warden-client-transient-memory-logged-in-user-provider.d.ts +8 -0
- package/lib/client/provider/warden-client-transient-memory-recent-login-provider.d.ts +7 -0
- package/lib/client/provider/warden-command-exchange-provider.d.ts +3 -0
- package/lib/client/provider/warden-logged-in-user-provider.d.ts +6 -0
- package/lib/client/provider/warden-logged-in-user-wrapper.d.ts +6 -0
- package/lib/client/provider/warden-recent-login-descriptor.d.ts +5 -0
- package/lib/client/provider/warden-user-service-event-processing-provider.d.ts +8 -0
- package/lib/client/provider/warden-user-service-options.d.ts +13 -0
- package/lib/client/warden-client.d.ts +27 -0
- package/lib/client/warden-client.spec.d.ts +1 -0
- package/lib/client/warden-delegating-current-user-providing-user-service-event-processing-provider.d.ts +16 -0
- package/lib/client/warden-user-service.d.ts +41 -0
- package/lib/client/warden-user-service.spec.d.ts +1 -0
- package/lib/common/command/create-account.d.ts +7 -0
- package/lib/common/command/remove-web-authn-registration.d.ts +4 -0
- package/lib/common/command/warden-command-response.d.ts +17 -0
- package/lib/common/command/warden-command.d.ts +18 -0
- package/lib/common/command/web-authn-object-wrapper.d.ts +3 -0
- package/lib/common/model/warden-contact-type.d.ts +4 -0
- package/lib/common/model/warden-contact.d.ts +5 -0
- package/lib/common/model/warden-customer-message-type.d.ts +3 -0
- package/lib/common/model/warden-entry-summary.d.ts +7 -0
- package/lib/common/model/warden-entry.d.ts +11 -0
- package/lib/common/model/warden-jwt-token.d.ts +5 -0
- package/lib/common/model/warden-login-request.d.ts +9 -0
- package/lib/common/model/warden-login-results.d.ts +7 -0
- package/lib/common/model/warden-store-registration-response-type.d.ts +5 -0
- package/lib/common/model/warden-store-registration-response.d.ts +8 -0
- package/lib/common/model/warden-team-role.d.ts +4 -0
- package/lib/common/model/warden-user-decoration.d.ts +6 -0
- package/lib/common/model/warden-web-authn-entry.d.ts +9 -0
- package/lib/common/model/warden-web-authn-transport-future-type.d.ts +8 -0
- package/lib/common/util/warden-utils.d.ts +21 -0
- package/lib/common/util/warden-utils.spec.d.ts +1 -0
- package/lib/index.d.ts +37 -0
- package/lib/index.mjs +3 -0
- package/lib/index.mjs.map +1 -0
- package/package.json +67 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
All notable changes to this project will be documented in this file.
|
|
3
|
+
|
|
4
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
5
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
6
|
+
|
|
7
|
+
## [Notes]
|
|
8
|
+
Alpha releases are exactly what they sound like - places where I am trying out new things that aren't ready for prime
|
|
9
|
+
time, but I need published to see how they interact with the rest of my software ecosystem. If you use an alpha
|
|
10
|
+
package without knowing why it is alpha you'll get exactly what you deserve.
|
|
11
|
+
|
|
12
|
+
## [Unreleased]
|
|
13
|
+
|
|
14
|
+
## In Flight
|
|
15
|
+
|
|
16
|
+
## [0.0.x] - 2018-03-23
|
|
17
|
+
### Initial Release
|
|
18
|
+
- Basic support for Warden, email and text messaging, and a simplified interface for bootstrapping over GraphQL
|
|
19
|
+
|
package/License.txt
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
Copyright 2022-2023 Christopher Weiss
|
|
2
|
+
|
|
3
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
you may not use this file except in compliance with the License.
|
|
5
|
+
You may obtain a copy of the License at
|
|
6
|
+
|
|
7
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
|
|
9
|
+
Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
See the License for the specific language governing permissions and
|
|
13
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# @bitblit/ratchet-warden-common
|
|
2
|
+
|
|
3
|
+
Typescript library to simplify using simplewebauthn and secondary auth methods over GraphQL.
|
|
4
|
+
|
|
5
|
+
## Introduction
|
|
6
|
+
|
|
7
|
+
I really like using the [SimpleWebAuthn](https://simplewebauthn.dev/) library for Authentication but it has a couple
|
|
8
|
+
pieces of code that I still end up re-writing over and over - adding the secondary login methods (like single-use
|
|
9
|
+
code sent to email/text) and setting it up to run over GraphQL, which I use regularly and don't really want to
|
|
10
|
+
add a bunch of special methods when they are boilerplate inside anyway once I nail down storage.
|
|
11
|
+
|
|
12
|
+
So, Warden handles that stuff for me. Relies heavily on my [Ratchet](https://github.com/bitblit/Ratchet) library
|
|
13
|
+
for supporting code.
|
|
14
|
+
|
|
15
|
+
You may wish to read [the changelog](CHANGELOG.md)
|
|
16
|
+
|
|
17
|
+
## Installation
|
|
18
|
+
|
|
19
|
+
`yarn install @bitblit/warden`
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
TBD
|
|
24
|
+
|
|
25
|
+
### Barrel Files
|
|
26
|
+
A Note on barrel files - All of Warden's barrel files are one level down. This is because otherwise everything
|
|
27
|
+
I said above about transitive dependencies gets thrown out the window if you put them all in one big barrel file
|
|
28
|
+
|
|
29
|
+
# Testing
|
|
30
|
+
|
|
31
|
+
Ha! No, seriously - all testing is done using Jest. To run them:
|
|
32
|
+
|
|
33
|
+
`yarn test`
|
|
34
|
+
|
|
35
|
+
# Contributing
|
|
36
|
+
|
|
37
|
+
Pull requests are welcome, although I'm not sure why you'd be interested!
|
|
38
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { WardenClientRecentLoginProvider } from './warden-client-recent-login-provider.js';
|
|
2
|
+
import { WardenRecentLoginDescriptor } from './warden-recent-login-descriptor.js';
|
|
3
|
+
import { WardenEntrySummary } from '../../common/model/warden-entry-summary.js';
|
|
4
|
+
import { WardenContact } from '../../common/model/warden-contact.js';
|
|
5
|
+
export declare abstract class WardenClientAbstractRecentLoginProvider implements WardenClientRecentLoginProvider {
|
|
6
|
+
abstract fetchCache(): WardenRecentLoginDescriptor[];
|
|
7
|
+
abstract updateCache(newValue: WardenRecentLoginDescriptor[]): any;
|
|
8
|
+
saveRecentLogin(entry: WardenEntrySummary): void;
|
|
9
|
+
saveNewUser(userId: string, label: string, contact: WardenContact): void;
|
|
10
|
+
removeUser(userId: string): void;
|
|
11
|
+
fetchAllLogins(): WardenRecentLoginDescriptor[];
|
|
12
|
+
clearAllLogins(): void;
|
|
13
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { WardenLoggedInUserProvider } from './warden-logged-in-user-provider.js';
|
|
2
|
+
import { WardenLoggedInUserWrapper } from './warden-logged-in-user-wrapper.js';
|
|
3
|
+
export declare class WardenClientLocalStorageLoggedInUserProvider<T> implements WardenLoggedInUserProvider<T> {
|
|
4
|
+
private localStorageKey;
|
|
5
|
+
constructor(localStorageKey: string);
|
|
6
|
+
fetchLoggedInUserWrapper(): WardenLoggedInUserWrapper<T>;
|
|
7
|
+
logOutUser(): void;
|
|
8
|
+
setLoggedInUserWrapper(wrapper: WardenLoggedInUserWrapper<T>): void;
|
|
9
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { WardenRecentLoginDescriptor } from './warden-recent-login-descriptor.js';
|
|
2
|
+
import { WardenClientAbstractRecentLoginProvider } from './warden-client-abstract-recent-login-provider.js';
|
|
3
|
+
export declare class WardenClientLocalStorageRecentLoginProvider extends WardenClientAbstractRecentLoginProvider {
|
|
4
|
+
private localStorageKey;
|
|
5
|
+
constructor(localStorageKey: string);
|
|
6
|
+
fetchCache(): WardenRecentLoginDescriptor[];
|
|
7
|
+
updateCache(newValue: WardenRecentLoginDescriptor[]): void;
|
|
8
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { WardenRecentLoginDescriptor } from './warden-recent-login-descriptor.js';
|
|
2
|
+
import { WardenEntrySummary } from '../../common/model/warden-entry-summary.js';
|
|
3
|
+
import { WardenContact } from '../../common/model/warden-contact.js';
|
|
4
|
+
export interface WardenClientRecentLoginProvider {
|
|
5
|
+
saveRecentLogin(entry: WardenEntrySummary): void;
|
|
6
|
+
saveNewUser(userId: string, label: string, contact: WardenContact): void;
|
|
7
|
+
removeUser(userId: string): void;
|
|
8
|
+
fetchAllLogins(): WardenRecentLoginDescriptor[];
|
|
9
|
+
clearAllLogins(): void;
|
|
10
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { WardenLoggedInUserProvider } from './warden-logged-in-user-provider.js';
|
|
2
|
+
import { WardenLoggedInUserWrapper } from './warden-logged-in-user-wrapper.js';
|
|
3
|
+
export declare class WardenClientTransientMemoryLoggedInUserProvider<T> implements WardenLoggedInUserProvider<T> {
|
|
4
|
+
private wrapper;
|
|
5
|
+
fetchLoggedInUserWrapper(): WardenLoggedInUserWrapper<T>;
|
|
6
|
+
logOutUser(): void;
|
|
7
|
+
setLoggedInUserWrapper(wrapper: WardenLoggedInUserWrapper<T>): void;
|
|
8
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { WardenRecentLoginDescriptor } from './warden-recent-login-descriptor.js';
|
|
2
|
+
import { WardenClientAbstractRecentLoginProvider } from './warden-client-abstract-recent-login-provider.js';
|
|
3
|
+
export declare class WardenClientTransientMemoryRecentLoginProvider extends WardenClientAbstractRecentLoginProvider {
|
|
4
|
+
private _cache;
|
|
5
|
+
fetchCache(): WardenRecentLoginDescriptor[];
|
|
6
|
+
updateCache(newValue: WardenRecentLoginDescriptor[]): void;
|
|
7
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { WardenLoggedInUserWrapper } from './warden-logged-in-user-wrapper.js';
|
|
2
|
+
export interface WardenLoggedInUserProvider<T> {
|
|
3
|
+
fetchLoggedInUserWrapper(): WardenLoggedInUserWrapper<T>;
|
|
4
|
+
setLoggedInUserWrapper(wrapper: WardenLoggedInUserWrapper<T>): any;
|
|
5
|
+
logOutUser(): void;
|
|
6
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { WardenLoggedInUserWrapper } from './warden-logged-in-user-wrapper.js';
|
|
2
|
+
export interface WardenUserServiceEventProcessingProvider<T> {
|
|
3
|
+
onLogout(): void;
|
|
4
|
+
onSuccessfulLogin(newUser: WardenLoggedInUserWrapper<T>): void;
|
|
5
|
+
onLoginFailure(reason: string): void;
|
|
6
|
+
onAutomaticTokenRefresh(refreshUser: WardenLoggedInUserWrapper<T>): void;
|
|
7
|
+
onAutomaticLogout(): void;
|
|
8
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { WardenLoggedInUserProvider } from './warden-logged-in-user-provider.js';
|
|
2
|
+
import { WardenClient } from '../warden-client.js';
|
|
3
|
+
import { WardenUserServiceEventProcessingProvider } from './warden-user-service-event-processing-provider.js';
|
|
4
|
+
import { WardenClientRecentLoginProvider } from './warden-client-recent-login-provider.js';
|
|
5
|
+
export interface WardenUserServiceOptions<T> {
|
|
6
|
+
recentLoginProvider?: WardenClientRecentLoginProvider;
|
|
7
|
+
loggedInUserProvider: WardenLoggedInUserProvider<T>;
|
|
8
|
+
wardenClient: WardenClient;
|
|
9
|
+
eventProcessor: WardenUserServiceEventProcessingProvider<T>;
|
|
10
|
+
loginCheckTimerPingSeconds?: number;
|
|
11
|
+
autoLoginHandlingThresholdSeconds?: number;
|
|
12
|
+
allowAutoRefresh?: boolean;
|
|
13
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { WardenCommand } from '../common/command/warden-command.js';
|
|
2
|
+
import { WardenContact } from '../common/model/warden-contact.js';
|
|
3
|
+
import { WardenCommandExchangeProvider } from './provider/warden-command-exchange-provider.js';
|
|
4
|
+
import { WardenCommandResponse } from '../common/command/warden-command-response.js';
|
|
5
|
+
import { PublicKeyCredentialCreationOptionsJSON, PublicKeyCredentialRequestOptionsJSON, RegistrationResponseJSON } from '@simplewebauthn/typescript-types';
|
|
6
|
+
import { WardenLoginResults } from '../common/model/warden-login-results.js';
|
|
7
|
+
import { WardenLoginRequest } from '../common/model/warden-login-request.js';
|
|
8
|
+
import { WardenClientCurrentLoggedInJwtTokenProvider } from './provider/warden-client-current-logged-in-jwt-token-provider.js';
|
|
9
|
+
import { WardenEntrySummary } from '../common/model/warden-entry-summary.js';
|
|
10
|
+
export declare class WardenClient {
|
|
11
|
+
private commandSender;
|
|
12
|
+
private jwtProvider;
|
|
13
|
+
constructor(commandSender: WardenCommandExchangeProvider, jwtProvider: WardenClientCurrentLoggedInJwtTokenProvider);
|
|
14
|
+
exchangeCommand(cmd: WardenCommand, returnErrors?: boolean): Promise<WardenCommandResponse>;
|
|
15
|
+
createAccount(contact: WardenContact, sendCode?: boolean, label?: string, tags?: string[]): Promise<string>;
|
|
16
|
+
generateWebAuthnAuthenticationChallengeForUserId(userId: string): Promise<PublicKeyCredentialRequestOptionsJSON>;
|
|
17
|
+
generateWebAuthnRegistrationChallengeForLoggedInUser(): Promise<PublicKeyCredentialCreationOptionsJSON>;
|
|
18
|
+
removeWebAuthnRegistration(userId: string, credId: string): Promise<WardenEntrySummary>;
|
|
19
|
+
removeWebAuthnRegistrationFromLoggedInUser(input: string): Promise<WardenEntrySummary>;
|
|
20
|
+
removeContactFromLoggedInUser(input: WardenContact): Promise<WardenEntrySummary>;
|
|
21
|
+
sendExpiringValidationToken(contact: WardenContact): Promise<boolean>;
|
|
22
|
+
addContactToLoggedInUser(contact: WardenContact): Promise<boolean>;
|
|
23
|
+
addWebAuthnRegistrationToLoggedInUser(data: RegistrationResponseJSON): Promise<WardenEntrySummary>;
|
|
24
|
+
performLoginCmd(login: WardenLoginRequest): Promise<WardenLoginResults>;
|
|
25
|
+
refreshJwtToken(oldJwtToken: string): Promise<string>;
|
|
26
|
+
executeExpiringTokenBasedLogin(contact: WardenContact, expiringToken: string): Promise<WardenLoginResults>;
|
|
27
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { WardenUserServiceEventProcessingProvider } from './provider/warden-user-service-event-processing-provider.js';
|
|
2
|
+
import { WardenLoggedInUserWrapper } from './provider/warden-logged-in-user-wrapper.js';
|
|
3
|
+
import { BehaviorSubject } from 'rxjs';
|
|
4
|
+
import { WardenClientCurrentLoggedInJwtTokenProvider } from './provider/warden-client-current-logged-in-jwt-token-provider.js';
|
|
5
|
+
export declare class WardenDelegatingCurrentUserProvidingUserServiceEventProcessingProvider<T> implements WardenUserServiceEventProcessingProvider<T>, WardenClientCurrentLoggedInJwtTokenProvider {
|
|
6
|
+
private wrapped?;
|
|
7
|
+
private _currentUserSubject;
|
|
8
|
+
constructor(wrapped?: WardenUserServiceEventProcessingProvider<T>);
|
|
9
|
+
fetchCurrentLoggedInJwtToken(): string;
|
|
10
|
+
get currentUserSubject(): BehaviorSubject<WardenLoggedInUserWrapper<T>>;
|
|
11
|
+
onAutomaticLogout(): void;
|
|
12
|
+
onAutomaticTokenRefresh(refreshUser: WardenLoggedInUserWrapper<T>): void;
|
|
13
|
+
onLoginFailure(reason: string): void;
|
|
14
|
+
onLogout(): void;
|
|
15
|
+
onSuccessfulLogin(newUser: WardenLoggedInUserWrapper<T>): void;
|
|
16
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { WardenUserServiceOptions } from './provider/warden-user-service-options.js';
|
|
2
|
+
import { WardenLoggedInUserWrapper } from './provider/warden-logged-in-user-wrapper.js';
|
|
3
|
+
import { WardenContact } from '../common/model/warden-contact.js';
|
|
4
|
+
import { WardenJwtToken } from '../common/model/warden-jwt-token.js';
|
|
5
|
+
import { WardenLoginResults } from '../common/model/warden-login-results.js';
|
|
6
|
+
import { WardenEntrySummary } from '../common/model/warden-entry-summary.js';
|
|
7
|
+
export declare class WardenUserService<T> {
|
|
8
|
+
private options;
|
|
9
|
+
private loggedInTimerSubscription;
|
|
10
|
+
private _autoRefreshEnabled;
|
|
11
|
+
constructor(options: WardenUserServiceOptions<T>);
|
|
12
|
+
cleanShutDown(): void;
|
|
13
|
+
get serviceOptions(): WardenUserServiceOptions<T>;
|
|
14
|
+
createAccount(contact: WardenContact, sendCode?: boolean, label?: string, tags?: string[]): Promise<string>;
|
|
15
|
+
addContactToLoggedInUser(contact: WardenContact): Promise<boolean>;
|
|
16
|
+
get autoRefreshEnabled(): boolean;
|
|
17
|
+
set autoRefreshEnabled(newValue: boolean);
|
|
18
|
+
checkForAutoLogoutOrRefresh(t: number): Promise<void>;
|
|
19
|
+
logout(): void;
|
|
20
|
+
static wrapperIsExpired(value: WardenLoggedInUserWrapper<any>): boolean;
|
|
21
|
+
fetchLoggedInUserWrapper(): WardenLoggedInUserWrapper<T>;
|
|
22
|
+
loggedInUserHasRole(role: string): boolean;
|
|
23
|
+
isLoggedIn(): boolean;
|
|
24
|
+
fetchLoggedInUserJwtObject(): WardenJwtToken<T>;
|
|
25
|
+
fetchLoggedInUserJwtToken(): string;
|
|
26
|
+
fetchLoggedInUserObject(): T;
|
|
27
|
+
fetchLoggedInUserExpirationEpochSeconds(): number;
|
|
28
|
+
fetchLoggedInUserRemainingSeconds(): number;
|
|
29
|
+
private updateLoggedInUserFromTokenString;
|
|
30
|
+
refreshToken(): Promise<WardenLoggedInUserWrapper<T>>;
|
|
31
|
+
sendExpiringCode(contact: WardenContact): Promise<boolean>;
|
|
32
|
+
private processWardenLoginResults;
|
|
33
|
+
private updateRecentLoginsFromWardenEntrySummary;
|
|
34
|
+
private updateRecentLoginsFromLoggedInUserWrapper;
|
|
35
|
+
executeWebAuthnBasedLogin(userId: string): Promise<WardenLoggedInUserWrapper<T>>;
|
|
36
|
+
removeWebAuthnRegistrationFromLoggedInUser(input: string): Promise<WardenEntrySummary>;
|
|
37
|
+
removeContactFromLoggedInUser(input: WardenContact): Promise<WardenEntrySummary>;
|
|
38
|
+
executeValidationTokenBasedLogin(contact: WardenContact, token: string): Promise<WardenLoggedInUserWrapper<T>>;
|
|
39
|
+
saveCurrentDeviceAsWebAuthnForCurrentUser(): Promise<WardenEntrySummary>;
|
|
40
|
+
executeWebAuthnLoginToWardenLoginResults(userId: string): Promise<WardenLoginResults>;
|
|
41
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { WebAuthnObjectWrapper } from './web-authn-object-wrapper.js';
|
|
2
|
+
import { WardenLoginResults } from '../model/warden-login-results.js';
|
|
3
|
+
import { WardenEntrySummary } from '../model/warden-entry-summary.js';
|
|
4
|
+
export interface WardenCommandResponse {
|
|
5
|
+
createAccount?: string;
|
|
6
|
+
generateWebAuthnAuthenticationChallengeForUserId?: WebAuthnObjectWrapper;
|
|
7
|
+
generateWebAuthnRegistrationChallengeForLoggedInUser?: WebAuthnObjectWrapper;
|
|
8
|
+
removeWebAuthnRegistration?: WardenEntrySummary;
|
|
9
|
+
sendExpiringValidationToken?: boolean;
|
|
10
|
+
addWebAuthnRegistrationToLoggedInUser?: WardenEntrySummary;
|
|
11
|
+
addContactToLoggedInUser?: boolean;
|
|
12
|
+
performLogin?: WardenLoginResults;
|
|
13
|
+
refreshJwtToken?: string;
|
|
14
|
+
removeWebAuthnRegistrationFromLoggedInUser?: WardenEntrySummary;
|
|
15
|
+
removeContactFromLoggedInUser?: WardenEntrySummary;
|
|
16
|
+
error?: string;
|
|
17
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { CreateAccount } from './create-account.js';
|
|
2
|
+
import { WardenContact } from '../model/warden-contact.js';
|
|
3
|
+
import { WebAuthnObjectWrapper } from './web-authn-object-wrapper.js';
|
|
4
|
+
import { RemoveWebAuthnRegistration } from './remove-web-authn-registration.js';
|
|
5
|
+
import { WardenLoginRequest } from '../model/warden-login-request.js';
|
|
6
|
+
export interface WardenCommand {
|
|
7
|
+
createAccount?: CreateAccount;
|
|
8
|
+
generateWebAuthnAuthenticationChallengeForUserId?: string;
|
|
9
|
+
generateWebAuthnRegistrationChallengeForLoggedInUser?: boolean;
|
|
10
|
+
sendExpiringValidationToken?: WardenContact;
|
|
11
|
+
addWebAuthnRegistrationToLoggedInUser?: WebAuthnObjectWrapper;
|
|
12
|
+
addContactToLoggedInUser?: WardenContact;
|
|
13
|
+
removeWebAuthnRegistrationFromLoggedInUser?: string;
|
|
14
|
+
removeContactFromLoggedInUser?: WardenContact;
|
|
15
|
+
removeWebAuthnRegistration?: RemoveWebAuthnRegistration;
|
|
16
|
+
performLogin?: WardenLoginRequest;
|
|
17
|
+
refreshJwtToken?: string;
|
|
18
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { WardenWebAuthnEntry } from './warden-web-authn-entry.js';
|
|
2
|
+
import { WardenContact } from './warden-contact.js';
|
|
3
|
+
export interface WardenEntry {
|
|
4
|
+
userId: string;
|
|
5
|
+
userLabel: string;
|
|
6
|
+
contactMethods: WardenContact[];
|
|
7
|
+
tags: string[];
|
|
8
|
+
webAuthnAuthenticators: WardenWebAuthnEntry[];
|
|
9
|
+
createdEpochMS: number;
|
|
10
|
+
updatedEpochMS: number;
|
|
11
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { WardenContact } from './warden-contact.js';
|
|
2
|
+
import { AuthenticationResponseJSON } from '@simplewebauthn/typescript-types';
|
|
3
|
+
export interface WardenLoginRequest {
|
|
4
|
+
userId?: string;
|
|
5
|
+
contact?: WardenContact;
|
|
6
|
+
webAuthn?: AuthenticationResponseJSON;
|
|
7
|
+
expiringToken?: string;
|
|
8
|
+
jwtTokenToRefresh?: string;
|
|
9
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { WardenStoreRegistrationResponseType } from './warden-store-registration-response-type.js';
|
|
2
|
+
import { WardenEntry } from './warden-entry.js';
|
|
3
|
+
export interface WardenStoreRegistrationResponse {
|
|
4
|
+
updatedEntry?: WardenEntry;
|
|
5
|
+
registrationResponseId: string;
|
|
6
|
+
result: WardenStoreRegistrationResponseType;
|
|
7
|
+
error?: string;
|
|
8
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { WardenWebAuthnTransportFutureType } from './warden-web-authn-transport-future-type.js';
|
|
2
|
+
export interface WardenWebAuthnEntry {
|
|
3
|
+
credentialIdBase64: string;
|
|
4
|
+
credentialPublicKeyBase64: string;
|
|
5
|
+
counter: number;
|
|
6
|
+
credentialBackedUp: boolean;
|
|
7
|
+
credentialDeviceType: string;
|
|
8
|
+
transports?: WardenWebAuthnTransportFutureType[];
|
|
9
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { WardenContact } from '../model/warden-contact.js';
|
|
2
|
+
import { WardenContactType } from '../model/warden-contact-type.js';
|
|
3
|
+
import { WardenEntrySummary } from '../model/warden-entry-summary.js';
|
|
4
|
+
import { WardenEntry } from '../model/warden-entry.js';
|
|
5
|
+
import { WardenLoginRequest } from '../model/warden-login-request.js';
|
|
6
|
+
import { WardenTeamRole } from '../model/warden-team-role.js';
|
|
7
|
+
export declare class WardenUtils {
|
|
8
|
+
constructor();
|
|
9
|
+
static extractContactsOfType(req: WardenEntry | WardenEntrySummary, type: WardenContactType): string[];
|
|
10
|
+
static validLoginRequest(req: WardenLoginRequest): boolean;
|
|
11
|
+
static stringToWardenContact(input: string): WardenContact;
|
|
12
|
+
static teamRolesToRoles(teamRoles: WardenTeamRole[]): string[];
|
|
13
|
+
static roleStringsToTeamRoles(roles: string[]): WardenTeamRole[];
|
|
14
|
+
static roleStringToTeamRole(role: string): WardenTeamRole;
|
|
15
|
+
static teamRoleToRoleString(tr: WardenTeamRole): string;
|
|
16
|
+
static stringToContactType(input: string): WardenContactType;
|
|
17
|
+
static validContact(contact: WardenContact): boolean;
|
|
18
|
+
static stringIsEmailAddress(value: string): boolean;
|
|
19
|
+
static stringIsPhoneNumber(value: string): boolean;
|
|
20
|
+
static stripWardenEntryToSummary(we: WardenEntry): WardenEntrySummary;
|
|
21
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
export * from './build/ratchet-warden-common-info.js';
|
|
2
|
+
export * from './client/warden-client.js';
|
|
3
|
+
export * from './client/warden-delegating-current-user-providing-user-service-event-processing-provider.js';
|
|
4
|
+
export * from './client/warden-user-service.js';
|
|
5
|
+
export * from './client/provider/warden-client-abstract-recent-login-provider.js';
|
|
6
|
+
export * from './client/provider/warden-client-current-logged-in-jwt-token-provider.js';
|
|
7
|
+
export * from './client/provider/warden-client-local-storage-logged-in-user-provider.js';
|
|
8
|
+
export * from './client/provider/warden-client-local-storage-recent-login-provider.js';
|
|
9
|
+
export * from './client/provider/warden-client-recent-login-provider.js';
|
|
10
|
+
export * from './client/provider/warden-client-transient-memory-logged-in-user-provider.js';
|
|
11
|
+
export * from './client/provider/warden-client-transient-memory-recent-login-provider.js';
|
|
12
|
+
export * from './client/provider/warden-command-exchange-provider.js';
|
|
13
|
+
export * from './client/provider/warden-logged-in-user-provider.js';
|
|
14
|
+
export * from './client/provider/warden-logged-in-user-wrapper.js';
|
|
15
|
+
export * from './client/provider/warden-recent-login-descriptor.js';
|
|
16
|
+
export * from './client/provider/warden-user-service-event-processing-provider.js';
|
|
17
|
+
export * from './client/provider/warden-user-service-options.js';
|
|
18
|
+
export * from './common/command/create-account.js';
|
|
19
|
+
export * from './common/command/remove-web-authn-registration.js';
|
|
20
|
+
export * from './common/command/warden-command-response.js';
|
|
21
|
+
export * from './common/command/warden-command.js';
|
|
22
|
+
export * from './common/command/web-authn-object-wrapper.js';
|
|
23
|
+
export * from './common/model/warden-contact-type.js';
|
|
24
|
+
export * from './common/model/warden-contact.js';
|
|
25
|
+
export * from './common/model/warden-customer-message-type.js';
|
|
26
|
+
export * from './common/model/warden-entry-summary.js';
|
|
27
|
+
export * from './common/model/warden-entry.js';
|
|
28
|
+
export * from './common/model/warden-jwt-token.js';
|
|
29
|
+
export * from './common/model/warden-login-request.js';
|
|
30
|
+
export * from './common/model/warden-login-results.js';
|
|
31
|
+
export * from './common/model/warden-store-registration-response-type.js';
|
|
32
|
+
export * from './common/model/warden-store-registration-response.js';
|
|
33
|
+
export * from './common/model/warden-team-role.js';
|
|
34
|
+
export * from './common/model/warden-user-decoration.js';
|
|
35
|
+
export * from './common/model/warden-web-authn-entry.js';
|
|
36
|
+
export * from './common/model/warden-web-authn-transport-future-type.js';
|
|
37
|
+
export * from './common/util/warden-utils.js';
|