@asgardeo/javascript 0.16.1 → 0.17.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/dist/api/v2/executeEmbeddedUserOnboardingFlowV2.d.ts +5 -5
- package/dist/cjs/index.js +5 -4
- package/dist/cjs/index.js.map +2 -2
- package/dist/index.js +5 -4
- package/dist/index.js.map +2 -2
- package/dist/models/field.d.ts +1 -0
- package/dist/models/v2/embedded-signin-flow-v2.d.ts +9 -9
- package/dist/models/v2/embedded-signup-flow-v2.d.ts +9 -9
- package/package.json +1 -1
package/dist/models/field.d.ts
CHANGED
|
@@ -134,7 +134,7 @@ export interface ExtendedEmbeddedSignInFlowResponse {
|
|
|
134
134
|
* @example
|
|
135
135
|
* ```typescript
|
|
136
136
|
* const response: EmbeddedSignInFlowResponse = {
|
|
137
|
-
*
|
|
137
|
+
* executionId: "flow_12345",
|
|
138
138
|
* flowStatus: EmbeddedSignInFlowStatus.Incomplete,
|
|
139
139
|
* type: EmbeddedSignInFlowType.View,
|
|
140
140
|
* data: {
|
|
@@ -183,16 +183,16 @@ export interface EmbeddedSignInFlowResponse extends ExtendedEmbeddedSignInFlowRe
|
|
|
183
183
|
type: string;
|
|
184
184
|
}[];
|
|
185
185
|
};
|
|
186
|
+
/**
|
|
187
|
+
* Unique identifier for this specific flow instance.
|
|
188
|
+
* Used to maintain state across multiple API calls during the authentication process.
|
|
189
|
+
*/
|
|
190
|
+
executionId: string;
|
|
186
191
|
/**
|
|
187
192
|
* Optional reason for flow failure in case of an error.
|
|
188
193
|
* Provides additional context when flowStatus is set to ERROR.
|
|
189
194
|
*/
|
|
190
195
|
failureReason?: string;
|
|
191
|
-
/**
|
|
192
|
-
* Unique identifier for this specific flow instance.
|
|
193
|
-
* Used to maintain state across multiple API calls during the authentication process.
|
|
194
|
-
*/
|
|
195
|
-
flowId: string;
|
|
196
196
|
/**
|
|
197
197
|
* Current status of the sign-in flow.
|
|
198
198
|
* Determines the next action required by the client application.
|
|
@@ -272,14 +272,14 @@ export type EmbeddedSignInFlowInitiateRequest = {
|
|
|
272
272
|
* Request payload for executing steps in Asgardeo embedded sign-in flows.
|
|
273
273
|
*
|
|
274
274
|
* This interface defines the structure for subsequent requests after flow initiation.
|
|
275
|
-
* It supports both continuing existing flows (with
|
|
275
|
+
* It supports both continuing existing flows (with executionId) and submitting user
|
|
276
276
|
* input data collected from the rendered components.
|
|
277
277
|
*
|
|
278
278
|
* @example
|
|
279
279
|
* ```typescript
|
|
280
280
|
* // Continue existing flow with user input
|
|
281
281
|
* const stepRequest: EmbeddedSignInFlowRequest = {
|
|
282
|
-
*
|
|
282
|
+
* executionId: "flow_12345",
|
|
283
283
|
* action: "action_001",
|
|
284
284
|
* inputs: {
|
|
285
285
|
* username: "user@example.com",
|
|
@@ -306,7 +306,7 @@ export interface EmbeddedSignInFlowRequest extends Partial<EmbeddedSignInFlowIni
|
|
|
306
306
|
* Identifier of the flow instance to continue.
|
|
307
307
|
* Required when submitting data for an existing flow.
|
|
308
308
|
*/
|
|
309
|
-
|
|
309
|
+
executionId?: string;
|
|
310
310
|
/**
|
|
311
311
|
* User input data collected from the form components.
|
|
312
312
|
* Keys should match the component identifiers from the response.
|
|
@@ -151,15 +151,15 @@ export interface EmbeddedSignUpFlowResponse extends ExtendedEmbeddedSignUpFlowRe
|
|
|
151
151
|
type: string;
|
|
152
152
|
}[];
|
|
153
153
|
};
|
|
154
|
+
/**
|
|
155
|
+
* Unique identifier for this sign-up flow instance.
|
|
156
|
+
*/
|
|
157
|
+
executionId: string;
|
|
154
158
|
/**
|
|
155
159
|
* Optional reason for flow failure in case of an error.
|
|
156
160
|
* Provides additional context when flowStatus is set to ERROR.
|
|
157
161
|
*/
|
|
158
162
|
failureReason?: string;
|
|
159
|
-
/**
|
|
160
|
-
* Unique identifier for this sign-up flow instance.
|
|
161
|
-
*/
|
|
162
|
-
flowId: string;
|
|
163
163
|
/**
|
|
164
164
|
* Current status of the sign-up flow.
|
|
165
165
|
* Determines whether more input is needed or the flow is complete.
|
|
@@ -191,7 +191,7 @@ export type EmbeddedSignUpFlowInitiateRequest = {
|
|
|
191
191
|
*/
|
|
192
192
|
export interface EmbeddedSignUpFlowRequest extends Partial<EmbeddedSignUpFlowInitiateRequest> {
|
|
193
193
|
action?: string;
|
|
194
|
-
|
|
194
|
+
executionId?: string;
|
|
195
195
|
inputs?: Record<string, any>;
|
|
196
196
|
}
|
|
197
197
|
/**
|
|
@@ -203,7 +203,7 @@ export interface EmbeddedSignUpFlowRequest extends Partial<EmbeddedSignUpFlowIni
|
|
|
203
203
|
*
|
|
204
204
|
* **Key Differences from AsgardeoV1:**
|
|
205
205
|
* - Uses `failureReason` instead of `message`/`description` for error details
|
|
206
|
-
* - Maintains flow context with `
|
|
206
|
+
* - Maintains flow context with `executionId` for tracking failed operations
|
|
207
207
|
* - Uses structured `flowStatus` enum instead of generic error codes
|
|
208
208
|
* - Provides empty `data` object for consistency with success responses
|
|
209
209
|
*
|
|
@@ -216,7 +216,7 @@ export interface EmbeddedSignUpFlowRequest extends Partial<EmbeddedSignUpFlowIni
|
|
|
216
216
|
* ```typescript
|
|
217
217
|
* // Typical Asgardeo error response
|
|
218
218
|
* const errorResponse: EmbeddedSignUpFlowErrorResponse = {
|
|
219
|
-
*
|
|
219
|
+
* executionId: "0ccfeaf9-18b3-43a5-bcc1-07d863dcb2c0",
|
|
220
220
|
* flowStatus: EmbeddedSignUpFlowStatus.Error,
|
|
221
221
|
* data: {},
|
|
222
222
|
* failureReason: "User already exists with the provided username."
|
|
@@ -249,13 +249,13 @@ export interface EmbeddedSignUpFlowErrorResponse {
|
|
|
249
249
|
* Unlike generic error codes, this provides contextual information
|
|
250
250
|
* that helps users understand and resolve the issue.
|
|
251
251
|
*/
|
|
252
|
-
failureReason: string;
|
|
253
252
|
/**
|
|
254
253
|
* Unique identifier for the sign-up flow instance.
|
|
255
254
|
* This ID is used to track the flow state and correlate error responses
|
|
256
255
|
* with the specific sign-up attempt that failed.
|
|
257
256
|
*/
|
|
258
|
-
|
|
257
|
+
executionId: string;
|
|
258
|
+
failureReason: string;
|
|
259
259
|
/**
|
|
260
260
|
* Status of the sign-up flow, which will be `EmbeddedSignUpFlowStatus.Error`
|
|
261
261
|
* for error responses. This field is used by error detection logic to
|