@enonic-types/lib-auth 0.1.1 → 7.11.0-B3

package/README.md

@@ -5,7 +5,7 @@
 ## Install
 
 ```bash
-npm i --save-dev @enonic/lib-auth
+npm i --save-dev @enonic-types/lib-auth
 ```
 
 ## Use
@@ -26,8 +26,8 @@ Add the corresponding types to your `tsconfig.json` file that is used for applic
 
 ### Require and custom imports
 
-To make `require` work out of box, you must install and add the `@enonic-types/global` types. Aside from providing definitions for XP global
-objects, e.g. `log`, `app`, `__`, etc, requiring library by the default path will return typed object.
+To make `require` work out of the box, you must install and add the `@enonic-types/global` types. Aside from providing definitions for XP
+global objects, e.g. `log`, `app`, `__`, etc, requiring a library by the default path will return typed object.
 
 `tsconfig.json`
 
@@ -49,7 +49,7 @@ const {login, logout, getUser, generatePassword} = require('/lib/xp/auth');
 ```
 
 More detailed explanation on how it works and how to type custom import function can be
-found [here](https://github.com/enonic/xp/tree/master/modules/lib/typescript/README.md).
+found [here](https://developer.enonic.com/docs/xp/stable/api).
 
 ### ES6-style import
 

package/auth.d.ts

@@ -1,355 +1,350 @@
-/**
- * Built-in authentication functions.
- *
- * @example
- * var authLib = require('/lib/xp/auth');
- *
- * @module auth
- */
-declare global {
-    interface XpLibraries {
-        '/lib/xp/auth': typeof import('./auth');
-    }
-}
-export declare type EditorFn<T> = (value: T) => T;
-export declare type LoginScopeType = 'SESSION' | 'REQUEST' | 'NONE';
-export interface LoginParams {
-    user: string;
-    skipAuth?: boolean;
-    password?: string;
-    idProvider?: string;
-    scope?: LoginScopeType;
-    sessionTimeout?: number;
-}
-export interface Principal {
-    type: string;
-    key: string;
-    displayName: string;
-    modifiedTime: string;
-}
-export interface User extends Principal {
-    disabled?: boolean;
-    email?: string;
-    login?: string;
-    idProvider: string;
-    profile?: Record<string, unknown>;
-}
-export interface Role extends Principal {
-    description?: string;
-}
-export interface Group extends Principal {
-    description?: string;
-}
-export interface LoginResult {
-    authenticated: boolean;
-    message: string;
-    users?: Principal;
-}
-/**
- * Login a user with the specified idProvider, userName, password and scope.
- *
- * @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.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.
- * @param {number} [params.sessionTimeout] Session timeout (in seconds). By default, the value of session.timeout from com.enonic.xp.web.jetty.cfg
- * @returns {LoginResult} Information for logged-in user.
- */
-export declare function login(params: LoginParams): LoginResult;
-/**
- * Logout an already logged-in user.
- *
- * @example-ref examples/auth/logout.js
- */
-export declare function logout(): void;
-export interface GetUserParams {
-    includeProfile?: boolean;
-}
-/**
- * Returns the logged-in user. If not logged-in, this will return *undefined*.
- *
- * @example-ref examples/auth/getUser.js
- *
- * @param {object} [params] JSON parameters.
- * @param {boolean} [params.includeProfile=false] Include profile.
- *
- * @returns {User} Information for logged-in user.
- */
-export declare function getUser(params: GetUserParams): User;
-/**
- * Checks if the logged-in user has the specified role.
- *
- * @example-ref examples/auth/hasRole.js
- *
- * @param {string} role Role to check for.
- * @returns {boolean} True if the user has specfied role, false otherwise.
- */
-export declare function hasRole(role: string): boolean;
-/**
- * Generates a secure password.
- *
- * @example-ref examples/auth/generatePassword.js
- *
- * @returns {string} A secure generated password.
- */
-export declare function generatePassword(): string;
-export interface ChangePasswordParams {
-    userKey: string;
-    password: string;
-}
-/**
- * Changes password for specified user.
- *
- * @example-ref examples/auth/changePassword.js
- *
- * @param {object} params JSON parameters.
- * @param {string} params.userKey Key for user to change password.
- * @param {string} params.password New password to set.
- */
-export declare function changePassword(params: ChangePasswordParams): void;
-/**
- * Returns the principal with the specified key.
- *
- * @example-ref examples/auth/getPrincipal.js
- *
- * @param {string} principalKey Principal key to look for.
- * @returns {Principal} the principal specified, or null if it doesn't exist.
- */
-export declare function getPrincipal(principalKey: string): User | Group | Role;
-/**
- * Returns a list of principals the specified principal is a member of.
- *
- * @example-ref examples/auth/getMemberships.js
- *
- * @param {string} principalKey Principal key to retrieve memberships for.
- * @param {boolean} [transitive=false] Retrieve transitive memberships.
- * @returns {(User | Group | Role)[]} Returns the list of principals.
- */
-export declare function getMemberships(principalKey: string, transitive: boolean): (User | Group | Role)[];
-/**
- * Returns a list of principals that are members of the specified principal.
- *
- * @example-ref examples/auth/getMembers.js
- *
- * @param {string} principalKey Principal key to retrieve members for.
- * @returns {(User | Group | Role)[]} Returns the list of principals.
- */
-export declare function getMembers(principalKey: string): (User | Group | Role)[];
-export interface CreateUserParams {
-    name: string;
-    displayName: string;
-    idProvider: string;
-    email?: string;
-}
-/**
- * Creates user from passed parameters.
- *
- * @example-ref examples/auth/createUser.js
- *
- * @param {object} params JSON parameters.
- * @param {string} params.idProvider Key for id provider where user has to be created.
- * @param {string} params.name User login name to set.
- * @param {string} params.displayName User display name.
- * @param {string} [params.email] User email.
- */
-export declare function createUser(params: CreateUserParams): User | null;
-export interface ModifyUserParams {
-    key: string;
-    editor: EditorFn<User>;
-}
-/**
- * Retrieves the user specified and updates it with the changes applied.
- *
- * @example-ref examples/auth/modifyUser.js
- *
- * @param {object} params JSON parameters.
- * @param {string} params.key Principal key of the user to modify.
- * @param {function} params.editor User editor function to apply to user.
- * @returns {User} the updated user or null if a  user not found.
- */
-export declare function modifyUser(params: ModifyUserParams): User | null;
-export interface CreateGroupParams {
-    idProvider: string;
-    name: string;
-    displayName: string;
-    description: string;
-}
-/**
- * Creates a group.
- *
- * @example-ref examples/auth/createGroup.js
- *
- * @param {object} params JSON parameters.
- * @param {string} params.idProvider Key for id provider where group has to be created.
- * @param {string} params.name Group name.
- * @param {string} params.displayName Group display name.
- * @param {string} params.description as principal description .
- */
-export declare function createGroup(params: CreateGroupParams): Group | null;
-export interface ModifyGroupParams {
-    key: string;
-    editor: EditorFn<Group>;
-}
-/**
- * Retrieves the group specified and updates it with the changes applied.
- *
- * @example-ref examples/auth/modifyGroup.js
- *
- * @param {object} params JSON parameters.
- * @param {string} params.key Principal key of the group to modify.
- * @param {function} params.editor Group editor function to apply to group.
- * @returns {Group} the updated group or null if a group not found.
- */
-export declare function modifyGroup(params: ModifyGroupParams): Group | null;
-/**
- * Adds members to a principal (user or role).
- *
- * @example-ref examples/auth/addMembers.js
- *
- * @param {string} principalKey Key of the principal to add members to.
- * @param {string} members Keys of the principals to add.
- */
-export declare function addMembers(principalKey: string, members: string): void;
-/**
- * Removes members from a principal (user or role).
- *
- * @example-ref examples/auth/removeMembers.js
- *
- * @param {string} principalKey Key of the principal to remove members from.
- * @param {string} members Keys of the principals to remove.
- */
-export declare function removeMembers(principalKey: string, members: string): void;
-export interface FindPrincipalsParams {
-    type?: string;
-    idProvider?: string;
-    start?: number;
-    count?: number;
-    name?: string;
-    searchText?: string;
-}
-export interface FindPrincipalsResult {
-    total: number;
-    count: number;
-    hits: (User | Group | Role)[];
-}
-/**
- * Search for principals matching the specified criteria.
- *
- * @example-ref examples/auth/findPrincipals.js
- *
- * @param {object} params JSON parameters.
- * @param {string} [params.type] Principal type to look for, one of: 'user', 'group' or 'role'. If not specified all principal types will be included.
- * @param {string} [params.idProvider] Key of the id provider to look for. If not specified all id providers will be included.
- * @param {number} [params.start=0] First principal to return from the search results. It can be used for pagination.
- * @param {number} [params.count=10] A limit on the number of principals to be returned.
- * @param {string} [params.name] Name of the principal to look for.
- * @param {string} [params.searchText] Text to look for in any principal field.
- * @returns {FindPrincipalsResult} The "total" number of principals matching the search, the "count" of principals included, and an array of "hits" containing the principals.
- */
-export declare function findPrincipals(params: FindPrincipalsParams): FindPrincipalsResult;
-/**
- * Deletes the principal with the specified key.
- *
- * @example-ref examples/auth/deletePrincipal.js
- *
- * @param {string} principalKey Principal key to delete.
- * @returns {boolean} True if deleted, false otherwise.
- */
-export declare function deletePrincipal(principalKey: string): boolean;
-/**
- * This function returns the ID provider configuration.
- * It is meant to be called from an ID provider controller.
- *
- * @example-ref examples/auth/getIdProviderConfig.js
- *
- * @returns {object} The ID provider configuration as JSON.
- */
-export declare function getIdProviderConfig(): Record<string, unknown>;
-export interface GetProfileParams {
-    key: string;
-    scope?: string;
-}
-/**
- * This function retrieves the profile of a user.
- *
- * @example-ref examples/auth/getProfile.js
- *
- * @param {object} params JSON parameters.
- * @param {string} params.key Principal key of the user.
- * @param {string} [params.scope] Scope of the data to retrieve.
- * @returns {object} The extra data as JSON
- */
-export declare function getProfile(params: GetProfileParams): Record<string, unknown>;
-export interface ModifyProfileParams {
-    key: string;
-    scope?: string | null;
-    editor: EditorFn<User>;
-}
-/**
- * This function retrieves the profile of a user and updates it.
- *
- * @example-ref examples/auth/modifyProfile.js
- *
- * @param {object} params JSON parameters.
- * @param {string} params.key Principal key of the user.
- * @param {string} [params.scope] Scope of the data to retrieve and update.
- * @param {function} params.editor Profile editor function to apply.
- * @returns {object} The extra data as JSON
- */
-export declare function modifyProfile(params: ModifyProfileParams): Record<string, unknown> | null;
-export interface FindUsersParams {
-    start?: number;
-    count?: number;
-    query: string;
-    sort?: string;
-    includeProfile?: boolean;
-}
-/**
- * Search for users matching the specified query.
- *
- * @example-ref examples/auth/findUsers.js
- *
- * @param {object} params JSON with the parameters.
- * @param {number} [params.start=0] Start index (used for paging).
- * @param {number} [params.count=10] Number of contents to fetch.
- * @param {string} params.query Query expression.
- * @param {string} [params.sort] Sorting expression.
- * @param {boolean} [params.includeProfile=false] Include profile.
- *
- * @returns {FindPrincipalsResult} Result of query.
- */
-export declare function findUsers(params: FindUsersParams): FindPrincipalsResult;
-export interface CreateRoleParams {
-    name: string;
-    displayName: string;
-    description: string;
-}
-/**
- * Creates a role.
- *
- * @example-ref examples/auth/createRole.js
- *
- * @param {string} params.name Role name.
- * @param {string} [params.displayName] Role display name.
- * @param {string} [params.description] as principal description .
- */
-export declare function createRole(params: CreateRoleParams): Role;
-export interface ModifyRoleParams {
-    key: string;
-    editor: EditorFn<Role>;
-}
-/**
- * Retrieves the role specified and updates it with the changes applied.
- *
- * @example-ref examples/auth/modifyRole.js
- *
- * @param {object} params JSON parameters.
- * @param {string} params.key Principal key of the role to modify.
- * @param {function} params.editor Role editor function to apply to role.
- * @returns {Role} the updated role or null if a role not found.
- */
-export declare function modifyRole(params: ModifyRoleParams): Role | null;
+/**
+ * Built-in authentication functions.
+ *
+ * @example
+ * var authLib = require('/lib/xp/auth');
+ *
+ * @module auth
+ */
+declare global {
+    interface XpLibraries {
+        '/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, User, Group, Role } from '@enonic-types/core';
+export declare type LoginScopeType = 'SESSION' | 'REQUEST' | 'NONE';
+export interface UserWithProfile<Profile extends Record<string, unknown> = Record<string, unknown>> extends User {
+    profile?: Profile;
+}
+export interface LoginParams {
+    user: string;
+    skipAuth?: boolean;
+    password?: string;
+    idProvider?: string;
+    scope?: LoginScopeType;
+    sessionTimeout?: number;
+}
+export interface LoginResult {
+    authenticated: boolean;
+    message: string;
+    user?: User;
+}
+/**
+ * Login a user with the specified idProvider, userName, password and scope.
+ *
+ * @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.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.
+ * @param {number} [params.sessionTimeout] Session timeout (in seconds). By default, the value of session.timeout from com.enonic.xp.web.jetty.cfg
+ * @returns {LoginResult} Information for logged-in user.
+ */
+export declare function login(params: LoginParams): LoginResult;
+/**
+ * Logout an already logged-in user.
+ *
+ * @example-ref examples/auth/logout.js
+ */
+export declare function logout(): void;
+export interface GetUserParams {
+    includeProfile?: boolean;
+}
+/**
+ * Returns the logged-in user. If not logged-in, this will return *undefined*.
+ *
+ * @example-ref examples/auth/getUser.js
+ *
+ * @param {object} [params] JSON parameters.
+ * @param {boolean} [params.includeProfile=false] Include profile.
+ *
+ * @returns {User} Information for logged-in user.
+ */
+export declare function getUser(params?: {
+    includeProfile?: false;
+}): User | null;
+export declare function getUser<Profile extends Record<string, unknown> = Record<string, unknown>>(params: {
+    includeProfile: true;
+}): UserWithProfile<Profile> | null;
+/**
+ * Checks if the logged-in user has the specified role.
+ *
+ * @example-ref examples/auth/hasRole.js
+ *
+ * @param {string} role Role name to check for.
+ * @returns {boolean} True if the user has specified role, false otherwise.
+ */
+export declare function hasRole(role: string): boolean;
+/**
+ * Generates a secure password.
+ *
+ * @example-ref examples/auth/generatePassword.js
+ *
+ * @returns {string} A secure generated password.
+ */
+export declare function generatePassword(): string;
+export interface ChangePasswordParams {
+    userKey: string;
+    password: string;
+}
+/**
+ * Changes password for specified user.
+ *
+ * @example-ref examples/auth/changePassword.js
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} params.userKey Key for user to change password.
+ * @param {string} params.password New password to set.
+ */
+export declare function changePassword(params: ChangePasswordParams): void;
+/**
+ * Returns the principal with the specified key.
+ *
+ * @example-ref examples/auth/getPrincipal.js
+ *
+ * @param {string} principalKey Principal key to look for.
+ * @returns {User | Group | Role} the principal specified, or null if it doesn't exist.
+ */
+export declare function getPrincipal(principalKey: PrincipalKey): Principal | null;
+/**
+ * Returns a list of principals the specified principal is a member of.
+ *
+ * @example-ref examples/auth/getMemberships.js
+ *
+ * @param {string} principalKey Principal key of user or group to retrieve memberships for.
+ * @param {boolean} [transitive=false] Retrieve transitive memberships.
+ * @returns {Array<Group | Role>} Returns the list of groups and roles.
+ */
+export declare function getMemberships(principalKey: UserKey | GroupKey, transitive?: boolean): (Group | Role)[];
+/**
+ * Returns a list of principals that are members of the specified principal.
+ *
+ * @example-ref examples/auth/getMembers.js
+ *
+ * @param {string} principalKey Principal key to retrieve members for.
+ * @returns {Array<User | Group>} Returns the list of users and groups.
+ */
+export declare function getMembers(principalKey: GroupKey | RoleKey): (User | Group)[];
+export interface CreateUserParams {
+    name: string;
+    displayName?: string;
+    idProvider: string;
+    email?: string;
+}
+/**
+ * Creates user from passed parameters.
+ *
+ * @example-ref examples/auth/createUser.js
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} params.idProvider Key for id provider where user has to be created.
+ * @param {string} params.name User login name to set.
+ * @param {string} [params.displayName] User display name.
+ * @param {string} [params.email] User email.
+ */
+export declare function createUser(params: CreateUserParams): User;
+export interface ModifyUserParams {
+    key: UserKey;
+    editor: (user: User) => User;
+}
+/**
+ * Retrieves the user specified and updates it with the changes applied.
+ *
+ * @example-ref examples/auth/modifyUser.js
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} params.key Principal key of the user to modify.
+ * @param {function} params.editor User editor function to apply to user.
+ * @returns {User} the updated user or null if a  user not found.
+ */
+export declare function modifyUser(params: ModifyUserParams): User | null;
+export interface CreateGroupParams {
+    idProvider: string;
+    name: string;
+    displayName?: string;
+    description?: string;
+}
+/**
+ * Creates a group.
+ *
+ * @example-ref examples/auth/createGroup.js
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} params.idProvider Key for id provider where group has to be created.
+ * @param {string} params.name Group name.
+ * @param {string} [params.displayName] Group display name.
+ * @param {string} [params.description] as principal description .
+ */
+export declare function createGroup(params: CreateGroupParams): Group;
+export interface ModifyGroupParams {
+    key: GroupKey;
+    editor: (group: Group) => Group;
+}
+/**
+ * Retrieves the group specified and updates it with the changes applied.
+ *
+ * @example-ref examples/auth/modifyGroup.js
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} params.key Principal key of the group to modify.
+ * @param {function} params.editor Group editor function to apply to group.
+ * @returns {Group} the updated group or null if a group not found.
+ */
+export declare function modifyGroup(params: ModifyGroupParams): Group | null;
+/**
+ * Adds members to a principal (user or role).
+ *
+ * @example-ref examples/auth/addMembers.js
+ *
+ * @param {string} principalKey Key of the principal to add members to.
+ * @param {Array<string>} members Keys of users and groups to add.
+ */
+export declare function addMembers(principalKey: GroupKey | RoleKey, members: (UserKey | GroupKey)[]): void;
+/**
+ * Removes members from a principal (user or role).
+ *
+ * @example-ref examples/auth/removeMembers.js
+ *
+ * @param {string} principalKey Key of the principal to remove members from.
+ * @param {string} members Keys of the principals to remove.
+ */
+export declare function removeMembers(principalKey: GroupKey | RoleKey, members: (UserKey | GroupKey)[]): void;
+export interface FindPrincipalsParams {
+    type?: Principal['type'];
+    idProvider?: string;
+    start?: number;
+    count?: number;
+    name?: string;
+    searchText?: string;
+}
+export interface FindPrincipalsResult<P extends Principal = Principal> {
+    total: number;
+    count: number;
+    hits: P[];
+}
+/**
+ * Search for principals matching the specified criteria.
+ *
+ * @example-ref examples/auth/findPrincipals.js
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} [params.type] Principal type to look for, one of: 'user', 'group' or 'role'. If not specified all principal types will be included.
+ * @param {string} [params.idProvider] Key of the id provider to look for. If not specified all id providers will be included.
+ * @param {number} [params.start=0] First principal to return from the search results. It can be used for pagination.
+ * @param {number} [params.count=10] A limit on the number of principals to be returned.
+ * @param {string} [params.name] Name of the principal to look for.
+ * @param {string} [params.searchText] Text to look for in any principal field.
+ * @returns {FindPrincipalsResult} The "total" number of principals matching the search, the "count" of principals included, and an array of "hits" containing the principals.
+ */
+export declare function findPrincipals(params: FindPrincipalsParams): FindPrincipalsResult;
+/**
+ * Deletes the principal with the specified key.
+ *
+ * @example-ref examples/auth/deletePrincipal.js
+ *
+ * @param {string} principalKey Principal key to delete.
+ * @returns {boolean} True if deleted, false otherwise.
+ */
+export declare function deletePrincipal(principalKey: PrincipalKey): boolean;
+/**
+ * This function returns the ID provider configuration.
+ * It is meant to be called from an ID provider controller.
+ *
+ * @example-ref examples/auth/getIdProviderConfig.js
+ *
+ * @returns {object} The ID provider configuration as JSON.
+ */
+export declare function getIdProviderConfig<IdProviderConfig extends Record<string, unknown>>(): IdProviderConfig | null;
+export interface GetProfileParams {
+    key: UserKey;
+    scope?: string;
+}
+/**
+ * This function retrieves the profile of a user.
+ *
+ * @example-ref examples/auth/getProfile.js
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} params.key Principal key of the user.
+ * @param {string} [params.scope] Scope of the data to retrieve.
+ * @returns {object} The extra data as JSON
+ */
+export declare function getProfile<Profile extends Record<string, unknown> = Record<string, unknown>>(params: GetProfileParams): Profile | null;
+export interface ModifyProfileParams {
+    key: UserKey;
+    scope?: string | null;
+    editor: (user: User) => User;
+}
+/**
+ * This function retrieves the profile of a user and updates it.
+ *
+ * @example-ref examples/auth/modifyProfile.js
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} params.key Principal key of the user.
+ * @param {string} [params.scope] Scope of the data to retrieve and update.
+ * @param {function} params.editor Profile editor function to apply.
+ * @returns {object} The extra data as JSON
+ */
+export declare function modifyProfile<Profile extends Record<string, unknown> = Record<string, unknown>>(params: ModifyProfileParams): Profile | null;
+export interface FindUsersParams {
+    start?: number;
+    count?: number;
+    query: string;
+    sort?: string;
+    includeProfile?: boolean;
+}
+/**
+ * Search for users matching the specified query.
+ *
+ * @example-ref examples/auth/findUsers.js
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {number} [params.start=0] Start index (used for paging).
+ * @param {number} [params.count=10] Number of contents to fetch.
+ * @param {string} params.query Query expression.
+ * @param {string} [params.sort] Sorting expression.
+ * @param {boolean} [params.includeProfile=false] Include profile.
+ *
+ * @returns {FindPrincipalsResult} Result of query.
+ */
+export declare function findUsers(params: FindUsersParams & {
+    includeProfile?: false;
+}): FindPrincipalsResult<User>;
+export declare function findUsers<Profile extends Record<string, unknown> = Record<string, unknown>>(params: FindUsersParams & {
+    includeProfile: true;
+}): FindPrincipalsResult<UserWithProfile<Profile>>;
+export interface CreateRoleParams {
+    name: string;
+    displayName?: string;
+    description?: string;
+}
+/**
+ * Creates a role.
+ *
+ * @example-ref examples/auth/createRole.js
+ *
+ * @param {string} params.name Role name.
+ * @param {string} [params.displayName] Role display name.
+ * @param {string} [params.description] as principal description .
+ */
+export declare function createRole(params: CreateRoleParams): Role;
+export interface ModifyRoleParams {
+    key: RoleKey;
+    editor: (role: Role) => Role;
+}
+/**
+ * Retrieves the role specified and updates it with the changes applied.
+ *
+ * @example-ref examples/auth/modifyRole.js
+ *
+ * @param {object} params JSON parameters.
+ * @param {string} params.key Principal key of the role to modify.
+ * @param {function} params.editor Role editor function to apply to role.
+ * @returns {Role} the updated role or null if a role not found.
+ */
+export declare function modifyRole(params: ModifyRoleParams): Role | null;

package/package.json

@@ -1,32 +1,35 @@
-{
-    "name": "@enonic-types/lib-auth",
-    "version": "0.1.1",
-    "description": "Type definitions for lib-auth.",
-    "types": "auth.d.ts",
-    "files": [
-        "auth.d.ts"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/enonic/xp.git#master"
-    },
-    "keywords": [
-        "enonic",
-        "enonic-xp",
-        "lib-auth",
-        "auth",
-        "types",
-        "typescript"
-    ],
-    "contributors": [
-        "Mikita Taukachou <edloidas@gmail.com> (https://edloidas.github.io/)"
-    ],
-    "license": "Apache-2.0",
-    "bugs": {
-        "url": "https://github.com/enonic/xp/issues"
-    },
-    "homepage": "https://github.com/enonic/xp/tree/master#readme",
-    "publishConfig": {
-        "access": "public"
-    }
-}
+{
+    "name": "@enonic-types/lib-auth",
+    "version": "7.11.0-B3",
+    "description": "Type definitions for lib-auth.",
+    "types": "auth.d.ts",
+    "files": [
+        "auth.d.ts"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/enonic/xp.git#master"
+    },
+    "keywords": [
+        "enonic",
+        "enonic-xp",
+        "lib-auth",
+        "auth",
+        "types",
+        "typescript"
+    ],
+    "contributors": [
+        "Mikita Taukachou <edloidas@gmail.com> (https://edloidas.github.io/)"
+    ],
+    "license": "Apache-2.0",
+    "bugs": {
+        "url": "https://github.com/enonic/xp/issues"
+    },
+    "homepage": "https://github.com/enonic/xp/tree/master#readme",
+    "dependencies": {
+        "@enonic-types/core": "7.11.0-B3"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}