kuzzle 2.56.0 → 2.57.0-beta.2

package/dist/lib/api/controllers/securityController.d.ts

@@ -1,9 +1,12 @@
-import { KuzzleRequest } from "../request";
+import type { KuzzleRequest } from "../request";
 import { NativeController } from "./baseController";
+import type { JSONObject } from "../../types/JSONObject";
+import type { Profile } from "../../model/security/profile";
+import type { User } from "../../model/security/user";
 /**
  * @class SecurityController
  */
-export default class SecurityController extends NativeController {
+declare class SecurityController extends NativeController {
     protected readonly subdomain: string;
     protected readonly securityCollections: string[];
     protected getStrategyMethod: any;
@@ -20,19 +23,28 @@ export default class SecurityController extends NativeController {
     /**
      * Creates a new API key for a user
      */
-    createApiKey(request: KuzzleRequest): Promise<any>;
+    createApiKey(request: KuzzleRequest): Promise<{
+        _id: string | null;
+        _source: JSONObject;
+    }>;
     /**
      * Search in an user API keys
      */
     searchApiKeys(request: KuzzleRequest): Promise<{
-        hits: any[];
+        hits: {
+            _id: string | null;
+            _source: JSONObject;
+        }[];
         total: number;
     }>;
     /**
-     * Deletes an user API key
+     * Deletes an user API key.
+     *
+     * The API key to delete can be identified either by its `_id`, by the
+     * clear-text `key` itself, or by the key's `fingerprint`.
      */
     deleteApiKey(request: KuzzleRequest): Promise<{
-        _id: string;
+        _id: string | null;
     }>;
     /**
      * Get the role mapping
@@ -62,7 +74,7 @@ export default class SecurityController extends NativeController {
      * @param {Request} request
      * @returns {Promise}
      */
-    updateProfileMapping(request: any): Promise<any>;
+    updateProfileMapping(request: KuzzleRequest): Promise<any>;
     /**
      * Get the user mapping
      *
@@ -100,7 +112,7 @@ export default class SecurityController extends NativeController {
      * @param {Request} request
      * @returns {Promise}
      */
-    refresh(request: KuzzleRequest): Promise<any>;
+    refresh(request: KuzzleRequest): Promise<null>;
     /**
      * Search for roles
      *
@@ -137,7 +149,7 @@ export default class SecurityController extends NativeController {
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    getProfile(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/profile").Profile>>;
+    getProfile(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<Profile>>;
     /**
      * Get specific profiles according to given ids
      *
@@ -153,14 +165,14 @@ export default class SecurityController extends NativeController {
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    createOrReplaceProfile(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/profile").Profile>>;
+    createOrReplaceProfile(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<Profile>>;
     /**
      * Create a Profile
      *
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    createProfile(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/profile").Profile>>;
+    createProfile(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<Profile>>;
     /**
      * Deletes a profile
      *
@@ -183,7 +195,7 @@ export default class SecurityController extends NativeController {
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    getUser(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/user").User>>;
+    getUser(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<User>>;
     /**
      * Get specific users according to given ids
      *
@@ -200,7 +212,7 @@ export default class SecurityController extends NativeController {
      * @returns {Promise<Object>}
      */
     getProfileRights(request: KuzzleRequest): Promise<{
-        hits: any[];
+        hits: never[];
         total: number;
     }>;
     /**
@@ -210,7 +222,7 @@ export default class SecurityController extends NativeController {
      * @returns {Promise<Object>}
      */
     getUserRights(request: KuzzleRequest): Promise<{
-        hits: any[];
+        hits: never[];
         total: number;
     }>;
     /**
@@ -256,21 +268,21 @@ export default class SecurityController extends NativeController {
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    createUser(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/user").User>>;
+    createUser(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<User>>;
     /**
      * Creates a new User object in Kuzzle's database layer and applies restricted profileIds
      *
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    createRestrictedUser(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/user").User>>;
+    createRestrictedUser(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<User>>;
     /**
      * Updates an existing User
      *
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    updateUser(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/user").User>>;
+    updateUser(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<User>>;
     /**
      * Applies a partial update to an existing user.
      * If the user doesn't already exist, a new user is created.
@@ -278,21 +290,21 @@ export default class SecurityController extends NativeController {
      * @param {Request} request
      * @returns {Promise}
      */
-    upsertUser(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/user").User>>;
+    upsertUser(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<User>>;
     /**
      * Replaces an existing User
      *
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    replaceUser(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/user").User>>;
+    replaceUser(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<User>>;
     /**
      * Updates an existing profile
      *
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    updateProfile(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/profile").Profile>>;
+    updateProfile(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<Profile>>;
     /**
      * Updates an existing role
      *
@@ -306,7 +318,7 @@ export default class SecurityController extends NativeController {
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    createFirstAdmin(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/user").User>>;
+    createFirstAdmin(request: KuzzleRequest): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<User>>;
     /**
      * Restricted rights are applied to the `anonymous` and `default` roles
      * (by default, these roles don't have any restriction).
@@ -321,21 +333,21 @@ export default class SecurityController extends NativeController {
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    mDeleteProfiles(request: any): Promise<any[]>;
+    mDeleteProfiles(request: KuzzleRequest): Promise<string[]>;
     /**
      * Deletes multiple roles
      *
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    mDeleteRoles(request: any): Promise<any[]>;
+    mDeleteRoles(request: KuzzleRequest): Promise<string[]>;
     /**
      * Deletes multiple users
      *
      * @param {Request} request
      * @returns {Promise<Object>}
      */
-    mDeleteUsers(request: any): Promise<any[]>;
+    mDeleteUsers(request: KuzzleRequest): Promise<string[]>;
     /**
      * Scroll a paginated users search result
      *
@@ -395,24 +407,24 @@ export default class SecurityController extends NativeController {
     /**
      * @returns {Promise<Object>}
      */
-    getAllCredentialFields(): Promise<{}>;
+    getAllCredentialFields(): Promise<JSONObject>;
     /**
      * @param {Request} request
      * @returns {Promise.<null>}
      */
-    revokeTokens(request: KuzzleRequest): Promise<any>;
+    revokeTokens(request: KuzzleRequest): Promise<null>;
     /**
      * @param {string.<profile|role|user>} type
      * @param {Request} request
      * @returns {Promise.<Array.<string>>}
      * @private
      */
-    _mDelete(type: string, request: KuzzleRequest): Promise<any[]>;
+    _mDelete(type: string, request: KuzzleRequest): Promise<string[]>;
     /**
      * @returns {Promise}
      * @private
      */
-    _changeUser(request: KuzzleRequest, id: string, content: any, userId: string | null, profileIds: string[] | null): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/user").User>>;
+    _changeUser(request: KuzzleRequest, id: string, content: any, userId: string | null, profileIds: string[] | null): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<User>>;
     /**
      * @param {Request} request
      * @returns {Promise}
@@ -420,7 +432,7 @@ export default class SecurityController extends NativeController {
      */
     _persistUser(request: KuzzleRequest, profileIds: string[], content: any, { humanReadableId }?: {
         humanReadableId?: boolean;
-    }): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<import("../../model/security/user").User>>;
+    }): Promise<import("../../types/core/auth/formatProcessing.type").Serialized<User>>;
     /**
      * Checks if a search result can exceeds the server configured limit
      * @param {Request} request
@@ -429,3 +441,4 @@ export default class SecurityController extends NativeController {
      */
     _getSearchPageSize(request: KuzzleRequest): number;
 }
+export = SecurityController;

package/dist/lib/api/controllers/securityController.js

@@ -25,7 +25,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-Object.defineProperty(exports, "__esModule", { value: true });
 /*
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
@@ -46,6 +45,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+const node_util_1 = require("node:util");
 const bluebird_1 = __importDefault(require("bluebird"));
 const lodash_1 = require("lodash");
 const uuid_1 = require("uuid");
@@ -57,6 +57,13 @@ const apiKey_1 = __importDefault(require("../../model/storage/apiKey"));
 const kerror = __importStar(require("../../kerror"));
 const safeObject_1 = require("../../util/safeObject");
 const name_generator_1 = require("../../util/name-generator");
+/**
+ * Whatever was thrown, as an `Error`. `catch` answers `unknown`, and the
+ * rollback path below reads a message off everything it collected.
+ */
+function causeOf(thrown) {
+    return thrown instanceof Error ? thrown : new Error((0, node_util_1.inspect)(thrown));
+}
 /**
  * @class SecurityController
  */
@@ -198,16 +205,18 @@ class SecurityController extends baseController_1.NativeController {
         };
     }
     /**
-     * Deletes an user API key
+     * Deletes an user API key.
+     *
+     * The API key to delete can be identified either by its `_id`, by the
+     * clear-text `key` itself, or by the key's `fingerprint`.
      */
     async deleteApiKey(request) {
         const userId = request.getString("userId");
-        const apiKeyId = request.getId();
         const refresh = request.getRefresh("wait_for");
-        const apiKey = await apiKey_1.default.load(userId, apiKeyId);
+        const apiKey = await apiKey_1.default.loadFromRequest(userId, request);
         await apiKey.delete({ refresh });
         return {
-            _id: apiKeyId,
+            _id: apiKey._id,
         };
     }
     /**
@@ -526,11 +535,12 @@ class SecurityController extends baseController_1.NativeController {
             ids = request.getBodyArray("ids");
         }
         else {
-            // @deprecated Should be replaced with request.getArray('ids')
-            ids = request.getArrayLegacy("ids");
+            ids = request.getArrayOrCsv("ids");
         }
         const users = await this.ask("core:security:user:mGet", ids);
-        return { hits: users.map((user) => formatProcessing_1.default.serializeUser(user)) };
+        return {
+            hits: users.map((user) => formatProcessing_1.default.serializeUser(user)),
+        };
     }
     /**
      * Given a profile id, returns the matching profile's rights as an array.
@@ -707,7 +717,11 @@ class SecurityController extends baseController_1.NativeController {
             return await this._changeUser(request, id, content, userId, profileIds);
         }
         catch (error) {
-            if (error.id && error.id === "security.user.not_found") {
+            // Duck-typed on the id, as it was: `core:security:user:get` rejects
+            // with a KuzzleError, and this branch reads nothing else off it.
+            if (error instanceof Error &&
+                "id" in error &&
+                error.id === "security.user.not_found") {
                 const creatingContent = {
                     ...defaultValues,
                     ...content, // Order important, content erase default duplicates
@@ -806,8 +820,12 @@ class SecurityController extends baseController_1.NativeController {
      */
     async restrictDefaultRights(request) {
         const userId = request.getKuid();
-        for (const type of ["role", "profile"]) {
-            await bluebird_1.default.map(Object.entries(global.kuzzle.config.security.standard[`${type}s`]), ([name, value]) => this.ask(`core:security:${type}:createOrReplace`, name, value, {
+        const standard = global.kuzzle.config.security.standard;
+        for (const [type, defaults] of [
+            ["role", standard.roles],
+            ["profile", standard.profiles],
+        ]) {
+            await bluebird_1.default.map(Object.entries(defaults), ([name, value]) => this.ask(`core:security:${type}:createOrReplace`, name, value, {
                 refresh: "wait_for",
                 userId,
             }));
@@ -1047,7 +1065,7 @@ class SecurityController extends baseController_1.NativeController {
         const generator = humanReadableId
             ? () => name_generator_1.NameGenerator.generateRandomName({ prefix: "kuid" })
             : () => "kuid-" + (0, uuid_1.v4)();
-        let id = "";
+        let id;
         let alreadyExists = false;
         // Early checks before the user is created
         do {
@@ -1120,20 +1138,18 @@ class SecurityController extends baseController_1.NativeController {
         catch (e) {
             this.logger.error(`User rollback error: ${e}`);
         }
+        const cause = causeOf(creationFailure.error);
         if (deletionErrors.length > 0) {
             // 2 errors > we
-            throw kerror.get("plugin", "runtime", "unexpected_error", [
-                creationFailure.error.message,
-                ...deletionErrors.map((e) => e.message),
-            ].join("\n"));
+            throw kerror.get("plugin", "runtime", "unexpected_error", [cause.message, ...deletionErrors.map((e) => causeOf(e).message)].join("\n"));
         }
         if (creationFailure.error instanceof errors_1.KuzzleError) {
             throw creationFailure.error;
         }
         if (creationFailure.validation) {
-            throw kerror.getFrom(creationFailure.error, "security", "credentials", "rejected", creationFailure.error.message);
+            throw kerror.getFrom(cause, "security", "credentials", "rejected", cause.message);
         }
-        throw kerror.getFrom(creationFailure.error, "plugin", "runtime", "unexpected_error", creationFailure.error.message);
+        throw kerror.getFrom(cause, "plugin", "runtime", "unexpected_error", cause.message);
     }
     /**
      * Checks if a search result can exceeds the server configured limit
@@ -1147,5 +1163,5 @@ class SecurityController extends baseController_1.NativeController {
         return size;
     }
 }
-exports.default = SecurityController;
+module.exports = SecurityController;
 //# sourceMappingURL=securityController.js.map

package/dist/lib/api/controllers/serverController.d.ts

@@ -1,13 +1,24 @@
-export = ServerController;
+/// <reference types="node" />
+import * as os from "node:os";
+import type { ApiRoute } from "../../types/ApiRoute";
+import type { KuzzleRequest } from "../request";
+import { NativeController } from "./baseController";
+interface ApiActionDefinition {
+    action: string;
+    controller: string;
+    http?: Array<{
+        path: string;
+        url: string;
+        verb: string;
+    }>;
+}
 /**
  * @class ServerController
  */
 declare class ServerController extends NativeController {
+    /** Filled by `init()`, from what the two services report. */
+    private readonly _info;
     constructor();
-    _info: {
-        elasticsearch: any;
-        redis: any;
-    };
     /**
      * Init ServerController
      * Used to perform asynchronous initialization safely: the funnel will wait
@@ -15,7 +26,7 @@ declare class ServerController extends NativeController {
      *
      * @returns {Promise}
      */
-    init(): Promise<any>;
+    init(): Promise<void>;
     /**
      * Returns the statistics frame from a date
      *
@@ -24,7 +35,17 @@ declare class ServerController extends NativeController {
      *
      * @deprecated
      */
-    getStats(request: Request): Promise<any>;
+    getStats(request: KuzzleRequest): Promise<{
+        hits: ({
+            completedRequests: Record<string, number>;
+            connections: Record<string, number>;
+            failedRequests: Record<string, number>;
+            ongoingRequests: Record<string, number>;
+        } & {
+            timestamp: number;
+        })[];
+        total: number;
+    }>;
     /**
      * Returns the last statistics frame
      *
@@ -32,7 +53,21 @@ declare class ServerController extends NativeController {
      *
      * @deprecated
      */
-    getLastStats(): Promise<any>;
+    getLastStats(): Promise<({
+        completedRequests: Record<string, number>;
+        connections: Record<string, number>;
+        failedRequests: Record<string, number>;
+        ongoingRequests: Record<string, number>;
+    } & {
+        timestamp: number;
+    }) | ({
+        completedRequests: Map<string, number>;
+        connections: Map<string, number>;
+        failedRequests: Map<string, number>;
+        ongoingRequests: Map<string, number>;
+    } & {
+        timestamp: number;
+    })>;
     /**
      * Returns all stored statistics frames
      *
@@ -40,7 +75,17 @@ declare class ServerController extends NativeController {
      *
      * @deprecated
      */
-    getAllStats(): Promise<any>;
+    getAllStats(): Promise<{
+        hits: ({
+            completedRequests: Record<string, number>;
+            connections: Record<string, number>;
+            failedRequests: Record<string, number>;
+            ongoingRequests: Record<string, number>;
+        } & {
+            timestamp: number;
+        })[];
+        total: number;
+    }>;
     /**
      * Returns the Kuzzle configuration
      *
@@ -51,32 +96,82 @@ declare class ServerController extends NativeController {
      * Returns the Kuzzle capabilities
      * @returns {Promise<Object>}
      */
-    capabilities(): Promise<any>;
+    capabilities(): Promise<{
+        limits: any;
+        plugins: Record<string, {
+            version: string;
+        }>;
+        routes: {
+            [x: string]: Record<string, ApiActionDefinition>;
+        };
+        services: Record<string, {
+            backend: string;
+            version: string;
+        }>;
+        version: any;
+    }>;
     /**
      * Checks if an admin user Exists
      *
      * @returns {Promise<Object>}
      */
-    adminExists(): Promise<any>;
+    adminExists(): Promise<{
+        exists: any;
+    }>;
     /**
      * @returns {Promise<Object>}
      */
-    now(): Promise<any>;
+    now(): Promise<{
+        now: number;
+    }>;
     /**
      * @returns {Promise<Object>}
      */
-    healthCheck(request: any): Promise<any>;
+    healthCheck(request: KuzzleRequest): Promise<{
+        services: Record<string, string>;
+        status: string;
+    }>;
     /**
      * @returns {Promise<Object>}
      */
-    info(): Promise<any>;
-    publicApi(): Promise<{}>;
-    openapi(request: any): Promise<any>;
+    info(): Promise<{
+        serverInfo: {
+            kuzzle: {
+                api: {
+                    routes: {};
+                };
+                application: {};
+                memoryUsed: number;
+                nodeVersion: string;
+                plugins: {};
+                system: {
+                    cpus: os.CpuInfo[];
+                    memory: {
+                        free: number;
+                        total: number;
+                    };
+                };
+                uptime: string;
+                version: string | undefined;
+            };
+            services: {};
+        };
+    }>;
+    publicApi(): Promise<{
+        [x: string]: Record<string, ApiActionDefinition>;
+    }>;
+    openapi(request: KuzzleRequest): Promise<any>;
     /**
      * Fetches and returns Kuzzle core metrics
      * @returns {Promise<Object>}
      */
-    metrics(): Promise<any>;
-    _buildApiDefinition(controllers: any, httpRoutes: any): {};
+    metrics(): Promise<{
+        api: any;
+        network: any;
+        realtime: any;
+    }>;
+    _buildApiDefinition(controllers: Map<string, {
+        _actions: Iterable<string>;
+    }>, httpRoutes: ApiRoute[]): Record<string, Record<string, ApiActionDefinition>>;
 }
-import { NativeController } from "./baseController";
+export = ServerController;