Skip to content

Commit 8adf360

Browse files
committed
Merge branch 'master' into dev
2 parents 352192b + f0b387f commit 8adf360

1 file changed

Lines changed: 83 additions & 64 deletions

File tree

oidc-client.d.ts

Lines changed: 83 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,20 @@
1-
declare var UserManager: Oidc.UserManager;
2-
declare var OidcClient: Oidc.OidcClient;
3-
declare var AccessTokenEvents: Oidc.AccessTokenEvents;
4-
declare var Log: Oidc.Log;
5-
declare var InMemoryWebStorage: Oidc.InMemoryWebStorage;
6-
declare var MetadataService: Oidc.MetadataService;
7-
declare var WebStorageStateStore: Oidc.WebStorageStateStore;
8-
9-
declare module "oidc-client" {
10-
export = Oidc;
11-
}
121
declare namespace Oidc {
13-
2+
interface Logger {
3+
error(message?: any, ...optionalParams: any[]): void;
4+
info(message?: any, ...optionalParams: any[]): void;
5+
warn(message?: any, ...optionalParams: any[]): void;
6+
}
147
interface AccessTokenEvents {
158

16-
load(container: any): any;
9+
load(container: User): void;
1710

18-
unload(): any;
11+
unload(): void;
1912

20-
addAccessTokenExpiring(callback: (ev: any) => void): any;
21-
removeAccessTokenExpiring(callback: (ev: any) => void): any;
13+
addAccessTokenExpiring(callback: (...ev: any[]) => void): void;
14+
removeAccessTokenExpiring(callback: (...ev: any[]) => void): void;
2215

23-
addAccessTokenExpired(callback: (ev: any) => void): any;
24-
removeAccessTokenExpired(callback: (ev: any) => void): any;
16+
addAccessTokenExpired(callback: (...ev: any[]) => void): void;
17+
removeAccessTokenExpired(callback: (...ev: any[]) => void): void;
2518
}
2619
interface InMemoryWebStorage {
2720
getItem(key: string): any;
@@ -34,41 +27,58 @@ declare namespace Oidc {
3427

3528
length?: number;
3629
}
37-
interface Log {
38-
NONE(): number;
39-
ERROR(): number;
40-
WARN(): number;
41-
INFO(): number;
42-
43-
reset(): void;
44-
45-
level(value: number): number;
46-
47-
logger(value: any): any;
48-
49-
info(...args: any[]): void;
50-
warn(...args: any[]): void;
51-
error(...args: any[]): void;
30+
class Log {
31+
static NONE: number;
32+
static ERROR: number;
33+
static WARN: number;
34+
static INFO: number;
35+
// For when TypeScript 2.0 compiler is more widely used
36+
// static readonly NONE: number;
37+
// static readonly ERROR: number;
38+
// static readonly WARN: number;
39+
// static readonly INFO: number;
40+
41+
static reset(): void;
42+
43+
static level: number;
44+
45+
static logger: Logger;
46+
47+
static info(message?: any, ...optionalParams: any[]): void;
48+
static warn(message?: any, ...optionalParams: any[]): void;
49+
static error(message?: any, ...optionalParams: any[]): void;
5250
}
5351

5452
interface MetadataService {
55-
new (settings: any): any;
56-
getMetadata(): any;
53+
new (settings: OidcClientSettings): MetadataService;
54+
55+
getMetadata(): Promise<any>;
5756

58-
getIssuer(): any;
57+
getIssuer(): Promise<any>;
5958

60-
getAuthorizationEndpoint(): any;
59+
getAuthorizationEndpoint(): Promise<any>;
6160

62-
getUserInfoEndpoint(): any;
61+
getUserInfoEndpoint(): Promise<any>;
6362

64-
getCheckSessionIframe(): any;
63+
getCheckSessionIframe(): Promise<any>;
6564

66-
getEndSessionEndpoint(): any;
65+
getEndSessionEndpoint(): Promise<any>;
6766

68-
getSigningKeys(): any;
67+
getSigningKeys(): Promise<any>;
6968
}
70-
interface OidcClient {
71-
new (settings: OidcClientCtor): any;
69+
interface MetadataServiceCtor {
70+
(settings: OidcClientSettings, jsonServiceCtor?: any): MetadataService;
71+
}
72+
interface ResponseValidator {
73+
validateSigninResponse(state: any, response: any): Promise<any>;
74+
validateSignoutResponse(state: any, response: any): Promise<any>;
75+
}
76+
interface ResponseValidatorCtor {
77+
(settings: OidcClientSettings, metadataServiceCtor?: MetadataServiceCtor, userInfoServiceCtor?: any): ResponseValidator;
78+
}
79+
80+
class OidcClient {
81+
constructor(settings: OidcClientSettings);
7282

7383
createSigninRequest(args?: any): Promise<any>;
7484
processSigninResponse(): Promise<any>;
@@ -79,7 +89,7 @@ declare namespace Oidc {
7989
clearStaleState(stateStore: any): Promise<any>;
8090
}
8191

82-
interface OidcClientCtor {
92+
interface OidcClientSettings {
8393
authority?: string;
8494
metadataUrl?: string;
8595
metadata?: any;
@@ -98,13 +108,13 @@ declare namespace Oidc {
98108
loadUserInfo?: boolean;
99109
staleStateAge?: number;
100110
clockSkew?: number;
101-
stateStore?: any;
102-
ResponseValidatorCtor?: any;
103-
MetadataServiceCtor?: any;
111+
stateStore?: WebStorageStateStore;
112+
ResponseValidatorCtor?: ResponseValidatorCtor;
113+
MetadataServiceCtor?: MetadataServiceCtor;
104114
}
105115

106-
interface UserManager extends OidcClient {
107-
new (settings: UserManagerCtor): any;
116+
class UserManager extends OidcClient {
117+
constructor(settings: UserManagerSettings);
108118

109119
clearStaleState(): Promise<void>;
110120

@@ -131,19 +141,19 @@ declare namespace Oidc {
131141
load(user: User): any;
132142
unload(): any;
133143

134-
addUserLoaded(callback: (ev: any) => void): any;
135-
removeUserLoaded(callback: (ev: any) => void): any;
144+
addUserLoaded(callback: (...ev: any[]) => void): void;
145+
removeUserLoaded(callback: (...ev: any[]) => void): void;
136146

137-
addUserUnloaded(callback: (ev: any) => void): any;
138-
removeUserUnloaded(callback: (ev: any) => void): any;
147+
addUserUnloaded(callback: (...ev: any[]) => void): void;
148+
removeUserUnloaded(callback: (...ev: any[]) => void): void;
139149

140-
addSilentRenewError(callback: (ev: any) => void): any;
141-
removeSilentRenewError(callback: (ev: any) => void): any;
150+
addSilentRenewError(callback: (...ev: any[]) => void): void;
151+
removeSilentRenewError(callback: (...ev: any[]) => void): void;
142152

143-
addUserSignedOut(callback: (ev: any) => void): any;
144-
removeUserSignedOut(callback: (ev: any) => void): any;
153+
addUserSignedOut(callback: (...ev: any[]) => void): void;
154+
removeUserSignedOut(callback: (...ev: any[]) => void): void;
145155
}
146-
interface UserManagerCtor extends OidcClientCtor {
156+
interface UserManagerSettings extends OidcClientSettings {
147157
popup_redirect_uri?: string;
148158
popupWindowFeatures?: string;
149159
popupWindowTarget?: any;
@@ -156,13 +166,13 @@ declare namespace Oidc {
156166
userStore?: any;
157167
}
158168
interface WebStorageStateStore {
159-
set(key: string, value: any): any;
169+
set(key: string, value: any): Promise<void>;
160170

161-
get(key: string): any;
171+
get(key: string): Promise<any>;
162172

163-
remove(key: string): any;
173+
remove(key: string): Promise<any>;
164174

165-
getAllKeys(): any;
175+
getAllKeys(): Promise<string[]>;
166176
}
167177
interface User {
168178
id_token: string;
@@ -171,8 +181,17 @@ declare namespace Oidc {
171181
token_type: string;
172182
scope: string;
173183
profile: any;
174-
expires_at: any;
184+
expires_at: number;
175185
state: any;
176-
toStorageString(storageString?: any): any;
186+
toStorageString(): string;
187+
188+
expires_in: number;
189+
expired: boolean;
190+
scopes: string[];
191+
192+
// For when TypeScript 2.0 compiler is more widely used
193+
// readonly expires_in: number;
194+
// readonly expired: boolean;
195+
// readonly scopes: string[];
177196
}
178197
}

0 commit comments

Comments
 (0)