kuzzle 2.56.0 → 2.57.0-beta.2

package/dist/bin/copy-binaries.js

@@ -1,13 +1,80 @@
 #!/usr/bin/env node
 "use strict";
-const fs = require("fs/promises");
-const path = require("path");
+/*
+ * Kuzzle, a backend software, self-hostable and ready to use
+ * to power modern apps
+ *
+ * Copyright 2015-2022 Kuzzle
+ * mailto: support AT kuzzle.io
+ * website: http://kuzzle.io
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Second half of `npm run build`: `tsc` emits the compiled JavaScript, this
+ * copies into `dist/` what the compiler does not — the cluster's `.proto`
+ * definitions — and gives the compiled server entrypoint the extensionless,
+ * executable name the container and the published package promise.
+ *
+ * `bin/start-kuzzle-server` used to be JavaScript, copied here verbatim
+ * ([step 03](../docs/adr-001/steps/03-sprint-2-bin.md)). It is TypeScript now,
+ * so `tsc` emits `dist/bin/start-kuzzle-server.js` and the copy below is what
+ * keeps `dist/bin/start-kuzzle-server` — `docker/images/kuzzle/Dockerfile`'s
+ * `CMD`, and an entry in `package.json`'s `files` — existing and executable.
+ *
+ * Run from the source tree, not from `dist/`, so the paths below stay relative
+ * to the repository root (`__dirname/..`); from `dist/bin/` they would resolve
+ * to `dist/`, and the script would read its sources from `dist/lib/`.
+ *
+ * Executed through `ts-node/register/transpile-only` rather than `tsx`: `tsx`
+ * pulls in esbuild's platform-specific native binary, and this script sits on
+ * the release path (`prepublishOnly` → `build`), whose failure mode is a
+ * published package silently missing its `.proto` files. `ts-node` is pure
+ * JavaScript and cannot fail that way — same idiom as the `doc-error-codes`
+ * script.
+ */
+const fs = __importStar(require("fs/promises"));
+const path = __importStar(require("path"));
 async function main() {
     const projectRoot = path.join(__dirname, "..");
     const protobufSourceDir = path.join(projectRoot, "lib", "cluster", "protobuf");
     const protobufTargetDir = path.join(projectRoot, "dist", "lib", "cluster", "protobuf");
-    const binSourceFile = path.join(projectRoot, "bin", "start-kuzzle-server");
     const binTargetDir = path.join(projectRoot, "dist", "bin");
+    const binSourceFile = path.join(binTargetDir, "start-kuzzle-server.js");
     const binTargetFile = path.join(binTargetDir, "start-kuzzle-server");
     await fs.mkdir(protobufTargetDir, { recursive: true });
     await fs.cp(protobufSourceDir, protobufTargetDir, { recursive: true });
@@ -17,7 +84,7 @@ async function main() {
 }
 main().catch((error) => {
     // eslint-disable-next-line no-console
-    console.error("Failed to copy protobuf definitions:", error);
+    console.error("Failed to copy the build's non-compiled payload:", error);
     process.exit(1);
 });
 //# sourceMappingURL=copy-binaries.js.map

package/dist/bin/start-kuzzle-server

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-
+"use strict";
 /*
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
@@ -20,111 +20,205 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-"use strict";
-
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 /* eslint-disable no-console */
-
-const fs = require("fs");
-
-const yargs = require("yargs");
-
+const fs = __importStar(require("fs"));
+const module_1 = require("module");
+const path_1 = require("path");
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+/**
+ * The production container's entrypoint: `docker/images/kuzzle/Dockerfile` runs
+ * `node ./bin/start-kuzzle-server` from `dist/`, which is why the import below
+ * is relative — from `dist/bin/`, `../index` is `dist/index.js`, the package's
+ * own `main`. Keep it that way.
+ */
+const index_1 = require("../index");
 /**
- * When builded this file is reachable the bin folder
- * Leave it this way on build
+ * Parses one of the JSON files the command line points at. The type parameter
+ * is a *claim about the file*, not a check: `JSON.parse` answers `any` and this
+ * is the boundary where that stops. What each file must actually contain is
+ * validated by the `import` method it is handed to, which throws a named
+ * assertion error rather than failing later and elsewhere.
  */
-const { Backend } = require("../index");
-
+/**
+ * Resolves a plugin fixture relative to *this file*, which is what the bare
+ * `require("./plugins/available/…")` this replaces did. `createRequire` rather
+ * than `require`: the entrypoint is TypeScript now, and a bare `require` call
+ * is an error under the repo's ESLint configuration.
+ *
+ * ⚠️ `--enable-plugins` only has something to load when the entrypoint runs
+ * from the source tree: `bin/plugins/` is not part of the published build, so
+ * in the container there is nothing under `pluginsDir`. `startKuzzle` checks
+ * each plugin's directory first and skips a missing one with a warning:
+ * v2.56.0 ignored the option altogether, and fixing its parsing (TD-84) was not
+ * meant to turn it into a `MODULE_NOT_FOUND` at boot. See
+ * docs/adr-001/type-debt-register.md, TD-84.
+ */
+const loadPlugin = (0, module_1.createRequire)(__filename);
+const pluginsDir = (0, path_1.join)(__dirname, "plugins", "available");
 function loadJson(path) {
-  if (!path) {
-    return {};
-  }
-
-  return JSON.parse(fs.readFileSync(path, "utf8"));
+    return JSON.parse(fs.readFileSync(path, "utf8"));
+}
+/**
+ * Reads one string option off yargs' answer. Every option this script declares
+ * takes a value, so anything else on the command line is a user error rather
+ * than a shape to accommodate.
+ */
+function stringOption(argv, name) {
+    const value = argv[name];
+    if (value === undefined) {
+        return undefined;
+    }
+    // yargs reads `--vault-key 12345` as a number and a repeated option as an
+    // array: "expects a value" would send the user looking for an argument that
+    // is not missing. Named the way it is typed, not yargs' camelCase key.
+    const flag = `--${name.replace(/[A-Z]/g, (c) => `-${c.toLowerCase()}`)}`;
+    if (value === true) {
+        throw new Error(`${flag} expects a value`);
+    }
+    if (typeof value !== "string") {
+        throw new Error(`${flag} expects a single string value, got ${JSON.stringify(value)}`);
+    }
+    return value;
 }
-
 async function startKuzzle(options = {}) {
-  const app = new Backend("kuzzle");
-
-  if (options.enablePlugins) {
-    const additionalPlugins = options.enablePlugins
-      .trim()
-      .split(",")
-      .map((x) => x.trim().replace(/(^")|("$)/g, ""));
-
-    for (const additionalPlugin of additionalPlugins) {
-      const PluginClass = require(`./plugins/available/${additionalPlugin}`);
-      const manifest = require(
-        `./plugins/available/${additionalPlugin}/manifest.json`,
-      );
-      const plugin = new PluginClass();
-
-      try {
-        plugin.version = require(
-          `./plugins/available/${additionalPlugin}/package.json`,
-        ).version;
-      } catch (e) {
-        // ignore
-      }
-
-      app.plugin.use(plugin, { manifest, name: manifest.name });
+    const app = new index_1.Backend("kuzzle");
+    if (options.enablePlugins) {
+        const additionalPlugins = options.enablePlugins
+            .trim()
+            .split(",")
+            .map((x) => x.trim().replace(/(^")|("$)/g, ""));
+        for (const additionalPlugin of additionalPlugins) {
+            if (!fs.existsSync((0, path_1.join)(pluginsDir, additionalPlugin))) {
+                app.log.warn(`[!] --enable-plugins: plugin "${additionalPlugin}" not found in ${pluginsDir}, ignored (the option only works from a source checkout)`);
+                continue;
+            }
+            const pluginPath = `./plugins/available/${additionalPlugin}`;
+            const PluginClass = loadPlugin(pluginPath);
+            const manifest = loadPlugin(`${pluginPath}/manifest.json`);
+            const plugin = new PluginClass();
+            try {
+                plugin.version = loadPlugin(`${pluginPath}/package.json`).version;
+            }
+            catch {
+                // ignore
+            }
+            app.plugin.use(plugin, { manifest, name: manifest.name });
+        }
+    }
+    // ⚠️ These three used to be *assignments* — `app.import.mappings = json`,
+    // `app.import.fixtures = json`, `app.import.securities = json`. `import`
+    // exposes methods, and only `mappings` among those names: the first
+    // assignment replaced the method, and the other two invented properties
+    // nothing reads. So `--mappings`, `--fixtures` and `--securities` had been
+    // accepted and ignored. Typing the entrypoint is what said so; see
+    // docs/adr-001/type-debt-register.md, TD-84.
+    if (options.mappings) {
+        app.import.mappings(loadJson(options.mappings));
+    }
+    if (options.securities) {
+        const securities = loadJson(options.securities);
+        // The shape `admin:loadSecurities` takes, which is what an admin-console
+        // export writes: roles, then profiles, then users.
+        if (securities.roles) {
+            app.import.roles(securities.roles);
+        }
+        if (securities.profiles) {
+            app.import.profiles(securities.profiles);
+        }
+        if (securities.users) {
+            app.import.users(securities.users);
+        }
+    }
+    // Assigned only when given: the setters take a `string`, and writing `""`
+    // for an absent key is a different claim from not setting one at all.
+    if (options.vaultKey) {
+        app.vault.key = options.vaultKey;
+    }
+    if (options.secretsFile) {
+        app.vault.file = options.secretsFile;
+    }
+    app.version = "1.0.0";
+    await app.start();
+    // Data fixtures have no `import` counterpart — they are documents, loaded
+    // through the API once the storage layer is up, the way `admin:loadFixtures`
+    // does it.
+    if (options.fixtures) {
+        await app.sdk.query({
+            action: "loadFixtures",
+            body: loadJson(options.fixtures),
+            controller: "admin",
+        });
+    }
+    // `searchUsers` answers a *count* in `total`, not a list: the previous
+    // `admins.length === 0` read `.length` off a number, which is `undefined`,
+    // so this warning never printed either.
+    const { total: admins } = await app.sdk.security.searchUsers({
+        query: { term: { profileIds: "admin" } },
+    });
+    if (admins === 0) {
+        app.log.warn("[!] [WARNING] There is no administrator user yet: everyone has administrator rights.");
+        app.log.warn("[ℹ]  You can use the CLI or the admin console to create the first administrator user.");
+        app.log.warn("    For more information: https://docs.kuzzle.io/core/2/guides/essentials/security/");
     }
-  }
-
-  app.import.mappings = loadJson(options.mappings);
-
-  app.import.fixtures = loadJson(options.fixtures);
-
-  app.import.securities = loadJson(options.securities);
-
-  app.vault.key = options.vaultKey;
-
-  app.vault.file = options.secretsFile;
-
-  app.version = "1.0.0";
-
-  await app.start();
-
-  const { total: admins } = await app.sdk.security.searchUsers({
-    query: { term: { profileIds: "admin" } },
-  });
-
-  if (admins.length === 0) {
-    app.log(
-      "[!] [WARNING] There is no administrator user yet: everyone has administrator rights.",
-    );
-    app.log(
-      "[ℹ]  You can use the CLI or the admin console to create the first administrator user.",
-    );
-    app.log(
-      "    For more information: https://docs.kuzzle.io/core/2/guides/essentials/security/",
-    );
-  }
 }
-
-const options = yargs()
-  .scriptName("kuzzle")
-  .usage("start-kuzzle-server [options]")
-  .describe("fixtures", "Import data from file")
-  .describe("mappings", "Apply mappings from file")
-  .describe("securities", "Import roles, profiles and users from file")
-  .describe("vault-key", "Vault key used to decrypt secrets")
-  .describe("secrets-file", "Output file to write decrypted secrets")
-  .describe(
-    "enable-plugins",
-    'Enable plugins from "plugins/available" directory',
-  ).argv;
-
+// ⚠️ `hideBin(process.argv)`, not `yargs()`. A bare `yargs()` parses an *empty*
+// argument list — it is the ESM factory, and the process arguments have to be
+// handed to it — so every option below was declared, documented in `--help`,
+// and then read off an object that never had them. See
+// docs/adr-001/type-debt-register.md, TD-84.
+const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+    .scriptName("kuzzle")
+    .usage("start-kuzzle-server [options]")
+    .describe("fixtures", "Import data from file")
+    .describe("mappings", "Apply mappings from file")
+    .describe("securities", "Import roles, profiles and users from file")
+    .describe("vault-key", "Vault key used to decrypt secrets")
+    .describe("secrets-file", "Encrypted secrets file to decrypt at startup")
+    .describe("enable-plugins", 'Enable plugins from "plugins/available" directory').argv;
+const options = {
+    enablePlugins: stringOption(argv, "enablePlugins"),
+    fixtures: stringOption(argv, "fixtures"),
+    mappings: stringOption(argv, "mappings"),
+    secretsFile: stringOption(argv, "secretsFile"),
+    securities: stringOption(argv, "securities"),
+    vaultKey: stringOption(argv, "vaultKey"),
+};
 const run = async () => {
-  try {
-    await startKuzzle(options);
-  } catch (error) {
-    console.error(`[x] [ERROR] ${error.stack}`);
-    process.exit(1);
-  }
+    try {
+        await startKuzzle(options);
+    }
+    catch (error) {
+        console.error(`[x] [ERROR] ${error instanceof Error ? error.stack : String(error)}`);
+        process.exit(1);
+    }
 };
-
 run();
-
-// Used for tests only
 module.exports = startKuzzle;
+//# sourceMappingURL=start-kuzzle-server.js.map

package/dist/index.d.ts

@@ -5,9 +5,39 @@ export * from "./lib/core/shared/sdk/embeddedSdk";
 export * from "./lib/api/request";
 export * from "./lib/kerror/errors";
 export * from "./lib/util/mutex";
+export * from "./lib/util/distributedLock";
 export * from "./lib/util/Inflector";
 export { NameGenerator } from "./lib/util/name-generator";
-export * from "kuzzle-sdk";
+export type { 
+/**
+ * The server-side user model: the type of `request.context.user` and of
+ * `request.getUser()`. Not the SDK's client-side `User`, which is what
+ * `app.sdk.security.*` returns.
+ */
+User as KuzzleUser, } from "./lib/model/security/user";
+export type { 
+/**
+ * The server-side authentication token model: the type of
+ * `request.context.token`. Its connections are tracked by the token manager,
+ * not on the token, so unlike the `Token` interface it has no `connectionId`.
+ */
+Token as KuzzleToken, } from "./lib/model/security/token";
+export { AuthController, BaseController, BatchController, CollectionController, Document, DocumentController, DocumentSearchResult, 
+/** @deprecated A client transport: import it from "kuzzle-sdk". */
+Http, IndexController, 
+/** @deprecated The SDK's client. On the server, `app.sdk` is already one (an `EmbeddedSDK`); to open a client connection, import it from "kuzzle-sdk". */
+Kuzzle, 
+/** @deprecated A client transport base class: import it from "kuzzle-sdk". */
+KuzzleAbstractProtocol, KuzzleEventEmitter, Observer, 
+/** The SDK's client-side profile, as `app.sdk.security.*` returns it. */
+Profile, ProfileSearchResult, RealtimeController, RealtimeDocument, 
+/** The SDK's client-side role, as `app.sdk.security.*` returns it. */
+Role, RoleSearchResult, ScopeOption, SearchResultBase, ServerController, SpecificationsSearchResult, 
+/** The SDK's client-side user, as `app.sdk.security.*` returns it — not the type of `request.context.user`, which is `KuzzleUser`. */
+User, UserOption, UserSearchResult, 
+/** @deprecated A client transport: import it from "kuzzle-sdk". */
+WebSocket, } from "kuzzle-sdk";
+export type { ApiKey, ArgsAuthControllerCheckRights, ArgsAuthControllerCheckToken, ArgsAuthControllerCreateApiKey, ArgsAuthControllerCreateMyCredentials, ArgsAuthControllerCredentialsExist, ArgsAuthControllerDeleteApiKey, ArgsAuthControllerDeleteMyCredentials, ArgsAuthControllerGetCurrentUser, ArgsAuthControllerGetMyCredentials, ArgsAuthControllerGetMyRights, ArgsAuthControllerGetStrategies, ArgsAuthControllerLogin, ArgsAuthControllerLogout, ArgsAuthControllerRefreshToken, ArgsAuthControllerSearchApiKeys, ArgsAuthControllerUpdateMyCredentials, ArgsAuthControllerUpdateSelf, ArgsAuthControllerValidateMyCredentials, ArgsCollectionControllerCreate, ArgsCollectionControllerDelete, ArgsCollectionControllerDeleteSpecifications, ArgsCollectionControllerExists, ArgsCollectionControllerGetMapping, ArgsCollectionControllerGetSpecifications, ArgsCollectionControllerList, ArgsCollectionControllerRefresh, ArgsCollectionControllerSearchSpecifications, ArgsCollectionControllerTruncate, ArgsCollectionControllerUpdate, ArgsCollectionControllerUpdateMapping, ArgsCollectionControllerUpdateSpecifications, ArgsCollectionControllerValidateSpecifications, ArgsDefault, ArgsDocumentControllerCount, ArgsDocumentControllerCreate, ArgsDocumentControllerCreateOrReplace, ArgsDocumentControllerDelete, ArgsDocumentControllerDeleteByQuery, ArgsDocumentControllerDeleteFields, ArgsDocumentControllerExists, ArgsDocumentControllerGet, ArgsDocumentControllerMCreate, ArgsDocumentControllerMCreateOrReplace, ArgsDocumentControllerMDelete, ArgsDocumentControllerMGet, ArgsDocumentControllerMReplace, ArgsDocumentControllerMUpdate, ArgsDocumentControllerMUpsert, ArgsDocumentControllerReplace, ArgsDocumentControllerSearch, ArgsDocumentControllerUpdate, ArgsDocumentControllerUpdateByQuery, ArgsDocumentControllerUpsert, ArgsDocumentControllerValidate, ArgsIndexControllerCreate, ArgsIndexControllerDelete, ArgsIndexControllerExists, ArgsIndexControllerList, ArgsIndexControllerMDelete, ArgsIndexControllerStats, ArgsRealtimeControllerCount, ArgsRealtimeControllerPublish, ArgsRealtimeControllerSubscribe, ArgsRealtimeControllerUnsubscribe, ArgsServerControllerAdminExists, ArgsServerControllerGetAllStats, ArgsServerControllerGetConfig, ArgsServerControllerGetLastStats, ArgsServerControllerGetStats, ArgsServerControllerInfo, ArgsServerControllerNow, BaseNotification, BaseRequest, CollectionMappings, DocumentContent, DocumentHit, DocumentMetadata, DocumentNotification, HttpRoutes, KDocument, KDocumentContent, KDocumentContentGeneric, KDocumentKuzzleInfo, KHit, MappingsProperties, Notification, NotificationType, ObserverOptions, PrivateAndPublicSDKEvents, ProfilePolicy, PublicKuzzleEvents, RequestPayload, ResponsePayload, RoleRightsDefinition, SearchResult, ServerNotification, UpdateByQueryResponse, UserNotification, mCreateOrReplaceRequest, mCreateOrReplaceResponse, mCreateRequest, mCreateResponse, mDeleteRequest, mDeleteResponse, mReplaceRequest, mReplaceResponse, mUpdateRequest, mUpdateResponse, mUpsertRequest, mUpsertResponse, } from "kuzzle-sdk";
 export * from "./lib/core/shared/KoncordeWrapper";
 export * from "./lib/core/shared/ObjectRepository";
 export * from "./lib/core/shared/store";

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NameGenerator = void 0;
+exports.WebSocket = exports.UserSearchResult = exports.UserOption = exports.User = exports.SpecificationsSearchResult = exports.ServerController = exports.SearchResultBase = exports.ScopeOption = exports.RoleSearchResult = exports.Role = exports.RealtimeDocument = exports.RealtimeController = exports.ProfileSearchResult = exports.Profile = exports.Observer = exports.KuzzleEventEmitter = exports.KuzzleAbstractProtocol = exports.Kuzzle = exports.IndexController = exports.Http = exports.DocumentSearchResult = exports.DocumentController = exports.Document = exports.CollectionController = exports.BatchController = exports.BaseController = exports.AuthController = exports.NameGenerator = void 0;
 __exportStar(require("./lib/core/backend"), exports);
 __exportStar(require("./lib/types"), exports);
 __exportStar(require("./lib/core/plugin/pluginContext"), exports);
@@ -22,10 +22,53 @@ __exportStar(require("./lib/core/shared/sdk/embeddedSdk"), exports);
 __exportStar(require("./lib/api/request"), exports);
 __exportStar(require("./lib/kerror/errors"), exports);
 __exportStar(require("./lib/util/mutex"), exports);
+__exportStar(require("./lib/util/distributedLock"), exports);
 __exportStar(require("./lib/util/Inflector"), exports);
 var name_generator_1 = require("./lib/util/name-generator");
 Object.defineProperty(exports, "NameGenerator", { enumerable: true, get: function () { return name_generator_1.NameGenerator; } });
-__exportStar(require("kuzzle-sdk"), exports);
+// The SDK names this package has always re-exported (it was `export * from
+// "kuzzle-sdk"`), listed so that the SDK's next additions no longer become part
+// of Kuzzle's API unannounced — ADR-0002 step 01
+// (docs/adr-002/ADR-0002-own-api-contract-types.md). The typings gate asserts
+// every one of them is still here (tests/typings/consumer/sdkReexports.ts).
+//
+// Values (classes and enums) — the SDK's client runtime, and the result classes
+// `app.sdk.*` answers with:
+var kuzzle_sdk_1 = require("kuzzle-sdk");
+Object.defineProperty(exports, "AuthController", { enumerable: true, get: function () { return kuzzle_sdk_1.AuthController; } });
+Object.defineProperty(exports, "BaseController", { enumerable: true, get: function () { return kuzzle_sdk_1.BaseController; } });
+Object.defineProperty(exports, "BatchController", { enumerable: true, get: function () { return kuzzle_sdk_1.BatchController; } });
+Object.defineProperty(exports, "CollectionController", { enumerable: true, get: function () { return kuzzle_sdk_1.CollectionController; } });
+Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return kuzzle_sdk_1.Document; } });
+Object.defineProperty(exports, "DocumentController", { enumerable: true, get: function () { return kuzzle_sdk_1.DocumentController; } });
+Object.defineProperty(exports, "DocumentSearchResult", { enumerable: true, get: function () { return kuzzle_sdk_1.DocumentSearchResult; } });
+/** @deprecated A client transport: import it from "kuzzle-sdk". */
+Object.defineProperty(exports, "Http", { enumerable: true, get: function () { return kuzzle_sdk_1.Http; } });
+Object.defineProperty(exports, "IndexController", { enumerable: true, get: function () { return kuzzle_sdk_1.IndexController; } });
+/** @deprecated The SDK's client. On the server, `app.sdk` is already one (an `EmbeddedSDK`); to open a client connection, import it from "kuzzle-sdk". */
+Object.defineProperty(exports, "Kuzzle", { enumerable: true, get: function () { return kuzzle_sdk_1.Kuzzle; } });
+/** @deprecated A client transport base class: import it from "kuzzle-sdk". */
+Object.defineProperty(exports, "KuzzleAbstractProtocol", { enumerable: true, get: function () { return kuzzle_sdk_1.KuzzleAbstractProtocol; } });
+Object.defineProperty(exports, "KuzzleEventEmitter", { enumerable: true, get: function () { return kuzzle_sdk_1.KuzzleEventEmitter; } });
+Object.defineProperty(exports, "Observer", { enumerable: true, get: function () { return kuzzle_sdk_1.Observer; } });
+/** The SDK's client-side profile, as `app.sdk.security.*` returns it. */
+Object.defineProperty(exports, "Profile", { enumerable: true, get: function () { return kuzzle_sdk_1.Profile; } });
+Object.defineProperty(exports, "ProfileSearchResult", { enumerable: true, get: function () { return kuzzle_sdk_1.ProfileSearchResult; } });
+Object.defineProperty(exports, "RealtimeController", { enumerable: true, get: function () { return kuzzle_sdk_1.RealtimeController; } });
+Object.defineProperty(exports, "RealtimeDocument", { enumerable: true, get: function () { return kuzzle_sdk_1.RealtimeDocument; } });
+/** The SDK's client-side role, as `app.sdk.security.*` returns it. */
+Object.defineProperty(exports, "Role", { enumerable: true, get: function () { return kuzzle_sdk_1.Role; } });
+Object.defineProperty(exports, "RoleSearchResult", { enumerable: true, get: function () { return kuzzle_sdk_1.RoleSearchResult; } });
+Object.defineProperty(exports, "ScopeOption", { enumerable: true, get: function () { return kuzzle_sdk_1.ScopeOption; } });
+Object.defineProperty(exports, "SearchResultBase", { enumerable: true, get: function () { return kuzzle_sdk_1.SearchResultBase; } });
+Object.defineProperty(exports, "ServerController", { enumerable: true, get: function () { return kuzzle_sdk_1.ServerController; } });
+Object.defineProperty(exports, "SpecificationsSearchResult", { enumerable: true, get: function () { return kuzzle_sdk_1.SpecificationsSearchResult; } });
+/** The SDK's client-side user, as `app.sdk.security.*` returns it — not the type of `request.context.user`, which is `KuzzleUser`. */
+Object.defineProperty(exports, "User", { enumerable: true, get: function () { return kuzzle_sdk_1.User; } });
+Object.defineProperty(exports, "UserOption", { enumerable: true, get: function () { return kuzzle_sdk_1.UserOption; } });
+Object.defineProperty(exports, "UserSearchResult", { enumerable: true, get: function () { return kuzzle_sdk_1.UserSearchResult; } });
+/** @deprecated A client transport: import it from "kuzzle-sdk". */
+Object.defineProperty(exports, "WebSocket", { enumerable: true, get: function () { return kuzzle_sdk_1.WebSocket; } });
 __exportStar(require("./lib/core/shared/KoncordeWrapper"), exports);
 __exportStar(require("./lib/core/shared/ObjectRepository"), exports);
 __exportStar(require("./lib/core/shared/store"), exports);

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

@@ -1,10 +1,10 @@
 import { NativeController } from "./baseController";
-import { KuzzleRequest } from "../request";
-import { ResetSecurityResult } from "../../types/controllers/adminControlller.type";
+import type { KuzzleRequest } from "../request";
+import type { ResetSecurityResult } from "../../types/controllers/adminController.type";
 /**
  * @class AdminController
  */
-export default class AdminController extends NativeController {
+declare class AdminController extends NativeController {
     protected shuttingDown: boolean;
     protected logger: any;
     constructor();
@@ -49,3 +49,4 @@ export default class AdminController extends NativeController {
         acknowledge: boolean;
     }>;
 }
+export = AdminController;

package/dist/lib/api/controllers/adminController.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
@@ -187,5 +186,5 @@ class AdminController extends baseController_1.NativeController {
         return promise.then(() => result);
     }
 }
-exports.default = AdminController;
+module.exports = AdminController;
 //# sourceMappingURL=adminController.js.map