@enonic-types/lib-auth 7.11.3 → 7.12.0-RC1

package/auth.d.ts

@@ -54,16 +54,6 @@ 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;
@@ -101,14 +91,6 @@ export interface ChangePasswordParams {
  * @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(userKey: UserKey): User | null;
 export declare function getPrincipal(groupKey: GroupKey): Group | null;
 export declare function getPrincipal(roleKey: RoleKey): Role | null;
@@ -300,20 +282,6 @@ export interface FindUsersParams {
     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>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/lib-auth",
-    "version": "7.11.3",
+    "version": "7.12.0-RC1",
     "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.11.3"
+        "@enonic-types/core": "7.12.0-RC1"
     },
     "publishConfig": {
         "access": "public"