@dfns/sdk 0.6.12-rc.1 → 0.7.0

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/baseAuthApi.d.ts CHANGED
@@ -1,14 +1,7 @@
1
1
  import { FirstFactorAttestation, RecoveryFactorAttestation, SecondFactorAttestation, UserRegistrationChallenge } from './store';
2
2
  import { CredentialKind, FirstFactorAssertion, RecoveryKeyAssertion, SecondFactorAssertion, UserActionChallenge } from './signer';
3
3
  import { HttpMethod } from './utils/fetch';
4
- export type DfnsBaseApiOptions = {
5
- appId: string;
6
- /** Needs to be specified to use any endpoint that requires authentication */
7
- authToken?: string;
8
- /** Only needs to be specified when using another API environment */
9
- baseUrl?: string;
10
- appSecret?: string;
11
- };
4
+ import { DfnsBaseApiOptions } from './types/generic';
12
5
  export type CreateUserActionChallengeRequest = {
13
6
  userActionPayload: string;
14
7
  userActionHttpMethod: HttpMethod;
@@ -1,4 +1,4 @@
1
- import { DfnsBaseApiOptions } from './baseAuthApi';
1
+ import { DfnsBaseApiOptions } from './types/generic';
2
2
  import { AuthClient } from './generated/auth';
3
3
  import { ExchangesClient } from './generated/exchanges';
4
4
  import { FeeSponsorsClient } from './generated/feeSponsors';
@@ -1,6 +1,7 @@
1
1
  import { CredentialStore } from './store';
2
2
  import { CredentialSigner } from './signer';
3
- import { CreateUserLoginChallengeRequest, CreateUserRegistrationChallengeRequest, DfnsBaseApiOptions, UserLoginResponse, UserRegistrationResponse } from './baseAuthApi';
3
+ import { CreateUserLoginChallengeRequest, CreateUserRegistrationChallengeRequest, UserLoginResponse, UserRegistrationResponse } from './baseAuthApi';
4
+ import { DfnsBaseApiOptions } from './types/generic';
4
5
  export type LoginRequest = CreateUserLoginChallengeRequest;
5
6
  export type LoginResponse = UserLoginResponse;
6
7
  export type RegisterRequest = CreateUserRegistrationChallengeRequest;
@@ -10,7 +11,6 @@ export type DfnsAuthenticatorOptions = Omit<DfnsBaseApiOptions, 'authToken'> & {
10
11
  };
11
12
  export declare class DfnsAuthenticator {
12
13
  private apiOptions;
13
- private api;
14
14
  constructor(apiOptions: DfnsAuthenticatorOptions);
15
15
  login(request: LoginRequest): Promise<LoginResponse>;
16
16
  register(request: RegisterRequest): Promise<RegisterResponse>;
@@ -1,4 +1,4 @@
1
- import { DfnsBaseApiOptions } from './baseAuthApi';
1
+ import { DfnsBaseApiOptions } from './types/generic';
2
2
  import { DelegatedAuthClient } from './generated/auth';
3
3
  import { DelegatedExchangesClient } from './generated/exchanges';
4
4
  import { DelegatedFeeSponsorsClient } from './generated/feeSponsors';
@@ -3,16 +3,13 @@ import * as T from './types';
3
3
  export declare class AuthClient {
4
4
  private apiOptions;
5
5
  constructor(apiOptions: DfnsApiClientOptions);
6
- activateApplication(request: T.ActivateApplicationRequest): Promise<T.ActivateApplicationResponse>;
7
6
  activateCredential(request: T.ActivateCredentialRequest): Promise<T.ActivateCredentialResponse>;
8
7
  activatePersonalAccessToken(request: T.ActivatePersonalAccessTokenRequest): Promise<T.ActivatePersonalAccessTokenResponse>;
9
8
  activateServiceAccount(request: T.ActivateServiceAccountRequest): Promise<T.ActivateServiceAccountResponse>;
10
9
  activateUser(request: T.ActivateUserRequest): Promise<T.ActivateUserResponse>;
11
- archiveApplication(request: T.ArchiveApplicationRequest): Promise<T.ArchiveApplicationResponse>;
12
10
  archivePersonalAccessToken(request: T.ArchivePersonalAccessTokenRequest): Promise<T.ArchivePersonalAccessTokenResponse>;
13
11
  archiveServiceAccount(request: T.ArchiveServiceAccountRequest): Promise<T.ArchiveServiceAccountResponse>;
14
12
  archiveUser(request: T.ArchiveUserRequest): Promise<T.ArchiveUserResponse>;
15
- createApplication(request: T.CreateApplicationRequest): Promise<T.CreateApplicationResponse>;
16
13
  createCredential(request: T.CreateCredentialRequest): Promise<T.CreateCredentialResponse>;
17
14
  /** @deprecated, use createCredential instead */
18
15
  createUserCredential(request: T.CreateCredentialRequest): Promise<T.CreateCredentialResponse>;
@@ -39,7 +36,6 @@ export declare class AuthClient {
39
36
  /** @deprecated, use createUserActionChallenge instead */
40
37
  createUserActionSignatureChallenge(request: T.CreateUserActionChallengeRequest): Promise<T.CreateUserActionChallengeResponse>;
41
38
  createUserActionSignature(request: T.CreateUserActionSignatureRequest): Promise<T.CreateUserActionSignatureResponse>;
42
- deactivateApplication(request: T.DeactivateApplicationRequest): Promise<T.DeactivateApplicationResponse>;
43
39
  deactivateCredential(request: T.DeactivateCredentialRequest): Promise<T.DeactivateCredentialResponse>;
44
40
  deactivatePersonalAccessToken(request: T.DeactivatePersonalAccessTokenRequest): Promise<T.DeactivatePersonalAccessTokenResponse>;
45
41
  deactivateServiceAccount(request: T.DeactivateServiceAccountRequest): Promise<T.DeactivateServiceAccountResponse>;
@@ -74,7 +70,6 @@ export declare class AuthClient {
74
70
  sendLoginCode(request: T.SendLoginCodeRequest): Promise<T.SendLoginCodeResponse>;
75
71
  sendRecoveryCode(request: T.SendRecoveryCodeRequest): Promise<T.SendRecoveryCodeResponse>;
76
72
  socialLogin(request: T.SocialLoginRequest): Promise<T.SocialLoginResponse>;
77
- updateApplication(request: T.UpdateApplicationRequest): Promise<T.UpdateApplicationResponse>;
78
73
  updatePersonalAccessToken(request: T.UpdatePersonalAccessTokenRequest): Promise<T.UpdatePersonalAccessTokenResponse>;
79
74
  updateServiceAccount(request: T.UpdateServiceAccountRequest): Promise<T.UpdateServiceAccountResponse>;
80
75
  }
@@ -9,18 +9,6 @@ class AuthClient {
9
9
  constructor(apiOptions) {
10
10
  this.apiOptions = apiOptions;
11
11
  }
12
- async activateApplication(request) {
13
- const path = (0, url_1.buildPathAndQuery)('/auth/apps/:appId/activate', {
14
- path: request ?? {},
15
- query: {},
16
- });
17
- const response = await (0, userActionFetch_1.userActionFetch)(path, {
18
- method: 'PUT',
19
- body: {},
20
- apiOptions: this.apiOptions,
21
- });
22
- return response.json();
23
- }
24
12
  async activateCredential(request) {
25
13
  const path = (0, url_1.buildPathAndQuery)('/auth/credentials/activate', {
26
14
  path: request ?? {},
@@ -69,18 +57,6 @@ class AuthClient {
69
57
  });
70
58
  return response.json();
71
59
  }
72
- async archiveApplication(request) {
73
- const path = (0, url_1.buildPathAndQuery)('/auth/apps/:appId', {
74
- path: request ?? {},
75
- query: {},
76
- });
77
- const response = await (0, userActionFetch_1.userActionFetch)(path, {
78
- method: 'DELETE',
79
- body: {},
80
- apiOptions: this.apiOptions,
81
- });
82
- return response.json();
83
- }
84
60
  async archivePersonalAccessToken(request) {
85
61
  const path = (0, url_1.buildPathAndQuery)('/auth/pats/:tokenId', {
86
62
  path: request ?? {},
@@ -117,18 +93,6 @@ class AuthClient {
117
93
  });
118
94
  return response.json();
119
95
  }
120
- async createApplication(request) {
121
- const path = (0, url_1.buildPathAndQuery)('/auth/apps', {
122
- path: request ?? {},
123
- query: {},
124
- });
125
- const response = await (0, userActionFetch_1.userActionFetch)(path, {
126
- method: 'POST',
127
- body: request.body,
128
- apiOptions: this.apiOptions,
129
- });
130
- return response.json();
131
- }
132
96
  async createCredential(request) {
133
97
  const path = (0, url_1.buildPathAndQuery)('/auth/credentials', {
134
98
  path: request ?? {},
@@ -341,18 +305,6 @@ class AuthClient {
341
305
  });
342
306
  return response.json();
343
307
  }
344
- async deactivateApplication(request) {
345
- const path = (0, url_1.buildPathAndQuery)('/auth/apps/:appId/deactivate', {
346
- path: request ?? {},
347
- query: {},
348
- });
349
- const response = await (0, userActionFetch_1.userActionFetch)(path, {
350
- method: 'PUT',
351
- body: {},
352
- apiOptions: this.apiOptions,
353
- });
354
- return response.json();
355
- }
356
308
  async deactivateCredential(request) {
357
309
  const path = (0, url_1.buildPathAndQuery)('/auth/credentials/deactivate', {
358
310
  path: request ?? {},
@@ -652,18 +604,6 @@ class AuthClient {
652
604
  });
653
605
  return response.json();
654
606
  }
655
- async updateApplication(request) {
656
- const path = (0, url_1.buildPathAndQuery)('/auth/apps/:appId', {
657
- path: request ?? {},
658
- query: {},
659
- });
660
- const response = await (0, userActionFetch_1.userActionFetch)(path, {
661
- method: 'POST',
662
- body: request.body,
663
- apiOptions: this.apiOptions,
664
- });
665
- return response.json();
666
- }
667
607
  async updatePersonalAccessToken(request) {
668
608
  const path = (0, url_1.buildPathAndQuery)('/auth/pats/:tokenId', {
669
609
  path: request ?? {},
@@ -4,8 +4,6 @@ import * as T from './types';
4
4
  export declare class DelegatedAuthClient {
5
5
  private apiOptions;
6
6
  constructor(apiOptions: DfnsDelegatedApiClientOptions);
7
- activateApplicationInit(request: T.ActivateApplicationRequest): Promise<UserActionChallengeResponse>;
8
- activateApplicationComplete(request: T.ActivateApplicationRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.ActivateApplicationResponse>;
9
7
  activateCredentialInit(request: T.ActivateCredentialRequest): Promise<UserActionChallengeResponse>;
10
8
  activateCredentialComplete(request: T.ActivateCredentialRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.ActivateCredentialResponse>;
11
9
  activatePersonalAccessTokenInit(request: T.ActivatePersonalAccessTokenRequest): Promise<UserActionChallengeResponse>;
@@ -14,16 +12,12 @@ export declare class DelegatedAuthClient {
14
12
  activateServiceAccountComplete(request: T.ActivateServiceAccountRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.ActivateServiceAccountResponse>;
15
13
  activateUserInit(request: T.ActivateUserRequest): Promise<UserActionChallengeResponse>;
16
14
  activateUserComplete(request: T.ActivateUserRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.ActivateUserResponse>;
17
- archiveApplicationInit(request: T.ArchiveApplicationRequest): Promise<UserActionChallengeResponse>;
18
- archiveApplicationComplete(request: T.ArchiveApplicationRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.ArchiveApplicationResponse>;
19
15
  archivePersonalAccessTokenInit(request: T.ArchivePersonalAccessTokenRequest): Promise<UserActionChallengeResponse>;
20
16
  archivePersonalAccessTokenComplete(request: T.ArchivePersonalAccessTokenRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.ArchivePersonalAccessTokenResponse>;
21
17
  archiveServiceAccountInit(request: T.ArchiveServiceAccountRequest): Promise<UserActionChallengeResponse>;
22
18
  archiveServiceAccountComplete(request: T.ArchiveServiceAccountRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.ArchiveServiceAccountResponse>;
23
19
  archiveUserInit(request: T.ArchiveUserRequest): Promise<UserActionChallengeResponse>;
24
20
  archiveUserComplete(request: T.ArchiveUserRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.ArchiveUserResponse>;
25
- createApplicationInit(request: T.CreateApplicationRequest): Promise<UserActionChallengeResponse>;
26
- createApplicationComplete(request: T.CreateApplicationRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.CreateApplicationResponse>;
27
21
  createCredentialInit(request: T.CreateCredentialRequest): Promise<UserActionChallengeResponse>;
28
22
  createCredentialComplete(request: T.CreateCredentialRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.CreateCredentialResponse>;
29
23
  createCredentialChallenge(request: T.CreateCredentialChallengeRequest): Promise<T.CreateCredentialChallengeResponse>;
@@ -51,8 +45,6 @@ export declare class DelegatedAuthClient {
51
45
  /** @deprecated, use createUserActionChallenge instead */
52
46
  createUserActionSignatureChallenge(request: T.CreateUserActionChallengeRequest): Promise<T.CreateUserActionChallengeResponse>;
53
47
  createUserActionSignature(request: T.CreateUserActionSignatureRequest): Promise<T.CreateUserActionSignatureResponse>;
54
- deactivateApplicationInit(request: T.DeactivateApplicationRequest): Promise<UserActionChallengeResponse>;
55
- deactivateApplicationComplete(request: T.DeactivateApplicationRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.DeactivateApplicationResponse>;
56
48
  deactivateCredentialInit(request: T.DeactivateCredentialRequest): Promise<UserActionChallengeResponse>;
57
49
  deactivateCredentialComplete(request: T.DeactivateCredentialRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.DeactivateCredentialResponse>;
58
50
  deactivatePersonalAccessTokenInit(request: T.DeactivatePersonalAccessTokenRequest): Promise<UserActionChallengeResponse>;
@@ -89,8 +81,6 @@ export declare class DelegatedAuthClient {
89
81
  sendLoginCode(request: T.SendLoginCodeRequest): Promise<T.SendLoginCodeResponse>;
90
82
  sendRecoveryCode(request: T.SendRecoveryCodeRequest): Promise<T.SendRecoveryCodeResponse>;
91
83
  socialLogin(request: T.SocialLoginRequest): Promise<T.SocialLoginResponse>;
92
- updateApplicationInit(request: T.UpdateApplicationRequest): Promise<UserActionChallengeResponse>;
93
- updateApplicationComplete(request: T.UpdateApplicationRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.UpdateApplicationResponse>;
94
84
  updatePersonalAccessTokenInit(request: T.UpdatePersonalAccessTokenRequest): Promise<UserActionChallengeResponse>;
95
85
  updatePersonalAccessTokenComplete(request: T.UpdatePersonalAccessTokenRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.UpdatePersonalAccessTokenResponse>;
96
86
  updateServiceAccountInit(request: T.UpdateServiceAccountRequest): Promise<UserActionChallengeResponse>;
@@ -8,33 +8,6 @@ class DelegatedAuthClient {
8
8
  constructor(apiOptions) {
9
9
  this.apiOptions = apiOptions;
10
10
  }
11
- async activateApplicationInit(request) {
12
- const path = (0, url_1.buildPathAndQuery)('/auth/apps/:appId/activate', {
13
- path: request ?? {},
14
- query: {},
15
- });
16
- const challenge = await baseAuthApi_1.BaseAuthApi.createUserActionChallenge({
17
- userActionHttpMethod: 'PUT',
18
- userActionHttpPath: path,
19
- userActionPayload: JSON.stringify({}),
20
- userActionServerKind: 'Api',
21
- }, this.apiOptions);
22
- return challenge;
23
- }
24
- async activateApplicationComplete(request, signedChallenge) {
25
- const path = (0, url_1.buildPathAndQuery)('/auth/apps/:appId/activate', {
26
- path: request ?? {},
27
- query: {},
28
- });
29
- const { userAction } = await baseAuthApi_1.BaseAuthApi.signUserActionChallenge(signedChallenge, this.apiOptions);
30
- const response = await (0, fetch_1.simpleFetch)(path, {
31
- method: 'PUT',
32
- body: {},
33
- headers: { 'x-dfns-useraction': userAction },
34
- apiOptions: this.apiOptions,
35
- });
36
- return response.json();
37
- }
38
11
  async activateCredentialInit(request) {
39
12
  const path = (0, url_1.buildPathAndQuery)('/auth/credentials/activate', {
40
13
  path: request ?? {},
@@ -143,33 +116,6 @@ class DelegatedAuthClient {
143
116
  });
144
117
  return response.json();
145
118
  }
146
- async archiveApplicationInit(request) {
147
- const path = (0, url_1.buildPathAndQuery)('/auth/apps/:appId', {
148
- path: request ?? {},
149
- query: {},
150
- });
151
- const challenge = await baseAuthApi_1.BaseAuthApi.createUserActionChallenge({
152
- userActionHttpMethod: 'DELETE',
153
- userActionHttpPath: path,
154
- userActionPayload: JSON.stringify({}),
155
- userActionServerKind: 'Api',
156
- }, this.apiOptions);
157
- return challenge;
158
- }
159
- async archiveApplicationComplete(request, signedChallenge) {
160
- const path = (0, url_1.buildPathAndQuery)('/auth/apps/:appId', {
161
- path: request ?? {},
162
- query: {},
163
- });
164
- const { userAction } = await baseAuthApi_1.BaseAuthApi.signUserActionChallenge(signedChallenge, this.apiOptions);
165
- const response = await (0, fetch_1.simpleFetch)(path, {
166
- method: 'DELETE',
167
- body: {},
168
- headers: { 'x-dfns-useraction': userAction },
169
- apiOptions: this.apiOptions,
170
- });
171
- return response.json();
172
- }
173
119
  async archivePersonalAccessTokenInit(request) {
174
120
  const path = (0, url_1.buildPathAndQuery)('/auth/pats/:tokenId', {
175
121
  path: request ?? {},
@@ -251,33 +197,6 @@ class DelegatedAuthClient {
251
197
  });
252
198
  return response.json();
253
199
  }
254
- async createApplicationInit(request) {
255
- const path = (0, url_1.buildPathAndQuery)('/auth/apps', {
256
- path: request ?? {},
257
- query: {},
258
- });
259
- const challenge = await baseAuthApi_1.BaseAuthApi.createUserActionChallenge({
260
- userActionHttpMethod: 'POST',
261
- userActionHttpPath: path,
262
- userActionPayload: JSON.stringify(request.body),
263
- userActionServerKind: 'Api',
264
- }, this.apiOptions);
265
- return challenge;
266
- }
267
- async createApplicationComplete(request, signedChallenge) {
268
- const path = (0, url_1.buildPathAndQuery)('/auth/apps', {
269
- path: request ?? {},
270
- query: {},
271
- });
272
- const { userAction } = await baseAuthApi_1.BaseAuthApi.signUserActionChallenge(signedChallenge, this.apiOptions);
273
- const response = await (0, fetch_1.simpleFetch)(path, {
274
- method: 'POST',
275
- body: request.body,
276
- headers: { 'x-dfns-useraction': userAction },
277
- apiOptions: this.apiOptions,
278
- });
279
- return response.json();
280
- }
281
200
  async createCredentialInit(request) {
282
201
  const path = (0, url_1.buildPathAndQuery)('/auth/credentials', {
283
202
  path: request ?? {},
@@ -583,33 +502,6 @@ class DelegatedAuthClient {
583
502
  });
584
503
  return response.json();
585
504
  }
586
- async deactivateApplicationInit(request) {
587
- const path = (0, url_1.buildPathAndQuery)('/auth/apps/:appId/deactivate', {
588
- path: request ?? {},
589
- query: {},
590
- });
591
- const challenge = await baseAuthApi_1.BaseAuthApi.createUserActionChallenge({
592
- userActionHttpMethod: 'PUT',
593
- userActionHttpPath: path,
594
- userActionPayload: JSON.stringify({}),
595
- userActionServerKind: 'Api',
596
- }, this.apiOptions);
597
- return challenge;
598
- }
599
- async deactivateApplicationComplete(request, signedChallenge) {
600
- const path = (0, url_1.buildPathAndQuery)('/auth/apps/:appId/deactivate', {
601
- path: request ?? {},
602
- query: {},
603
- });
604
- const { userAction } = await baseAuthApi_1.BaseAuthApi.signUserActionChallenge(signedChallenge, this.apiOptions);
605
- const response = await (0, fetch_1.simpleFetch)(path, {
606
- method: 'PUT',
607
- body: {},
608
- headers: { 'x-dfns-useraction': userAction },
609
- apiOptions: this.apiOptions,
610
- });
611
- return response.json();
612
- }
613
505
  async deactivateCredentialInit(request) {
614
506
  const path = (0, url_1.buildPathAndQuery)('/auth/credentials/deactivate', {
615
507
  path: request ?? {},
@@ -991,33 +883,6 @@ class DelegatedAuthClient {
991
883
  });
992
884
  return response.json();
993
885
  }
994
- async updateApplicationInit(request) {
995
- const path = (0, url_1.buildPathAndQuery)('/auth/apps/:appId', {
996
- path: request ?? {},
997
- query: {},
998
- });
999
- const challenge = await baseAuthApi_1.BaseAuthApi.createUserActionChallenge({
1000
- userActionHttpMethod: 'POST',
1001
- userActionHttpPath: path,
1002
- userActionPayload: JSON.stringify(request.body),
1003
- userActionServerKind: 'Api',
1004
- }, this.apiOptions);
1005
- return challenge;
1006
- }
1007
- async updateApplicationComplete(request, signedChallenge) {
1008
- const path = (0, url_1.buildPathAndQuery)('/auth/apps/:appId', {
1009
- path: request ?? {},
1010
- query: {},
1011
- });
1012
- const { userAction } = await baseAuthApi_1.BaseAuthApi.signUserActionChallenge(signedChallenge, this.apiOptions);
1013
- const response = await (0, fetch_1.simpleFetch)(path, {
1014
- method: 'POST',
1015
- body: request.body,
1016
- headers: { 'x-dfns-useraction': userAction },
1017
- apiOptions: this.apiOptions,
1018
- });
1019
- return response.json();
1020
- }
1021
886
  async updatePersonalAccessTokenInit(request) {
1022
887
  const path = (0, url_1.buildPathAndQuery)('/auth/pats/:tokenId', {
1023
888
  path: request ?? {},