@enonic-types/lib-auth 7.16.2 → 8.0.0-A3

package/auth.d.ts

@@ -11,9 +11,9 @@ declare global {
         '/lib/xp/auth': typeof import('./auth');
     }
 }
-import type { Group, GroupKey, Principal, PrincipalKey, Role, RoleKey, User, UserKey } from '@enonic-types/core';
-export type { PrincipalKey, UserKey, GroupKey, RoleKey, Principal, ScriptValue, User, Group, Role } from '@enonic-types/core';
-export declare type LoginScopeType = 'SESSION' | 'REQUEST' | 'NONE';
+import type { Group, GroupKey, Principal, PrincipalKey, PrincipalType, Role, RoleKey, User, UserKey } from '@enonic-types/core';
+export type { PrincipalKey, PrincipalType, UserKey, GroupKey, RoleKey, Principal, ScriptValue, User, Group, Role } from '@enonic-types/core';
+export type LoginScopeType = 'SESSION' | 'REQUEST' | 'NONE';
 export interface UserWithProfile<Profile extends Record<string, unknown> = Record<string, unknown>> extends User {
     profile?: Profile;
 }
@@ -42,8 +42,8 @@ export interface LoginResult {
  * @example-ref examples/auth/login.js
  *
  * @param {object} params JSON parameters.
- * @param {string} params.user Name of user to log in.
- * @param {string} [params.idProvider] Name of id provider where the user is stored. If not specified it will try all available id providers, in alphabetical order.
+ * @param {string} params.user Name of the user to log in.
+ * @param {string} [params.idProvider] Name of id provider where the user is stored. If not specified system id provider will be used.
  * @param {string} [params.password] Password for the user. Ignored if skipAuth is set to true, mandatory otherwise.
  * @param {('SESSION'|'REQUEST'|'NONE')} [params.scope=SESSION] The scope of this login. Two values are valid. SESSION logs the user in and creates a session in XP for use in future requests. REQUEST logs the user in but only for this particular request and thus does not create a session.
  * @param {boolean} [params.skipAuth=false] Skip authentication.
@@ -100,6 +100,7 @@ export declare function changePassword(params: ChangePasswordParams): void;
 export declare function getPrincipal(userKey: UserKey): User | null;
 export declare function getPrincipal(groupKey: GroupKey): Group | null;
 export declare function getPrincipal(roleKey: RoleKey): Role | null;
+export declare function getPrincipal(principalKey: PrincipalKey): Principal | null;
 /**
  * Returns a list of principals the specified principal is a member of.
  *
@@ -204,7 +205,7 @@ export declare function addMembers(principalKey: GroupKey | RoleKey, members: (U
  */
 export declare function removeMembers(principalKey: GroupKey | RoleKey, members: (UserKey | GroupKey)[]): void;
 export interface FindPrincipalsParams {
-    type?: Principal['type'];
+    type?: PrincipalType;
     idProvider?: string;
     start?: number;
     count?: number;
@@ -294,6 +295,7 @@ export declare function findUsers(params: FindUsersParams & {
 export declare function findUsers<Profile extends Record<string, unknown> = Record<string, unknown>>(params: FindUsersParams & {
     includeProfile: true;
 }): FindPrincipalsResult<UserWithProfile<Profile>>;
+export declare function findUsers(params: FindUsersParams): FindPrincipalsResult<User | UserWithProfile>;
 export interface CreateRoleParams {
     name: string;
     displayName?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/lib-auth",
-    "version": "7.16.2",
+    "version": "8.0.0-A3",
     "description": "Type definitions for lib-auth.",
     "types": "auth.d.ts",
     "files": [
@@ -27,7 +27,7 @@
     },
     "homepage": "https://github.com/enonic/xp/tree/master#readme",
     "dependencies": {
-        "@enonic-types/core": "7.16.2"
+        "@enonic-types/core": "8.0.0-A3"
     },
     "publishConfig": {
         "access": "public"