@asgardeo/javascript 0.10.1 → 0.11.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/getFlowMetaV2.d.ts +4 -4
- package/dist/cjs/index.js +2 -20
- package/dist/cjs/index.js.map +2 -2
- package/dist/index.js +2 -20
- package/dist/index.js.map +2 -2
- package/dist/models/config.d.ts +27 -0
- package/dist/models/v2/flow-meta-v2.d.ts +12 -4
- package/package.json +1 -1
package/dist/models/config.d.ts
CHANGED
|
@@ -314,6 +314,27 @@ export interface I18nPreferences {
|
|
|
314
314
|
*/
|
|
315
315
|
urlParam?: string | false;
|
|
316
316
|
}
|
|
317
|
+
export interface UserPreferences {
|
|
318
|
+
/**
|
|
319
|
+
* Whether to automatically fetch the user's associated organizations after sign-in.
|
|
320
|
+
* When set to false, the SDK will not make API calls to `/api/users/v1/me/organizations`.
|
|
321
|
+
* @default true
|
|
322
|
+
* @remarks Disabling this will improve performance if you don't need organization information.
|
|
323
|
+
* You can manually call `getMyOrganizations()` when needed if this is disabled.
|
|
324
|
+
*/
|
|
325
|
+
fetchOrganizations?: boolean;
|
|
326
|
+
/**
|
|
327
|
+
* Whether to automatically fetch the user profile from SCIM2 endpoints after sign-in.
|
|
328
|
+
* When set to false, the SDK will not make API calls to `/scim2/Me` and `/scim2/Schemas`.
|
|
329
|
+
* Instead, it will extract basic user claims from the ID token.
|
|
330
|
+
* @default true
|
|
331
|
+
* @remarks Disabling this will improve performance but provide limited user profile information.
|
|
332
|
+
* Only the claims present in the ID token will be available (e.g., sub, email, name).
|
|
333
|
+
* For full user profile attributes (custom claims, enterprise attributes, etc.),
|
|
334
|
+
* keep this enabled or manually call `getUserProfile()` when needed.
|
|
335
|
+
*/
|
|
336
|
+
fetchUserProfile?: boolean;
|
|
337
|
+
}
|
|
317
338
|
export interface Preferences {
|
|
318
339
|
/**
|
|
319
340
|
* Internationalization preferences for the Asgardeo UI components
|
|
@@ -328,4 +349,10 @@ export interface Preferences {
|
|
|
328
349
|
* Theme preferences for the Asgardeo UI components
|
|
329
350
|
*/
|
|
330
351
|
theme?: ThemePreferences;
|
|
352
|
+
/**
|
|
353
|
+
* User profile preferences for controlling user data fetching behavior.
|
|
354
|
+
* TEMPORARY CONFIG
|
|
355
|
+
* TODO: Remove this once https://github.com/asgardeo/javascript/issues/412 is properly fixed.
|
|
356
|
+
*/
|
|
357
|
+
user?: UserPreferences;
|
|
331
358
|
}
|
|
@@ -265,8 +265,12 @@ export interface GetFlowMetaRequestConfig extends Omit<Partial<RequestInit>, 'me
|
|
|
265
265
|
* Either `baseUrl` or `url` must be provided.
|
|
266
266
|
*/
|
|
267
267
|
baseUrl?: string;
|
|
268
|
-
/**
|
|
269
|
-
|
|
268
|
+
/**
|
|
269
|
+
* UUID of the entity (application ID or organization unit ID).
|
|
270
|
+
* Optional — when omitted the server returns i18n-only metadata (e.g. for flows
|
|
271
|
+
* like AcceptInvite that are not tied to a specific application or OU).
|
|
272
|
+
*/
|
|
273
|
+
id?: string;
|
|
270
274
|
/**
|
|
271
275
|
* Language tag in BCP 47 format for i18n translations.
|
|
272
276
|
* Defaults to `en` on the server side when omitted.
|
|
@@ -280,8 +284,12 @@ export interface GetFlowMetaRequestConfig extends Omit<Partial<RequestInit>, 'me
|
|
|
280
284
|
* @example "auth", "errors", "common"
|
|
281
285
|
*/
|
|
282
286
|
namespace?: string;
|
|
283
|
-
/**
|
|
284
|
-
|
|
287
|
+
/**
|
|
288
|
+
* The type of entity to retrieve metadata for.
|
|
289
|
+
* Optional — must be omitted together with `id` for flows that are not
|
|
290
|
+
* associated with a specific application or OU (e.g. AcceptInvite).
|
|
291
|
+
*/
|
|
292
|
+
type?: FlowMetaType;
|
|
285
293
|
/**
|
|
286
294
|
* Fully qualified URL of the `/flow/meta` endpoint.
|
|
287
295
|
* When provided, `baseUrl` is ignored.
|