kuzzle 2.16.0 → 2.16.4

package/lib/api/openapi/document/replace.yaml

@@ -0,0 +1,66 @@
+DocumentReplace:
+  summary: "Replaces the content of an existing document."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: collection
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: documentId
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: refresh
+      schema:
+        type: string
+      description: " if set to wait_for, Kuzzle will not respond until the deletion has been indexed"
+      required: false
+    - in: path
+      name: silent
+      schema:
+        type: boolean
+      description: "if set, then Kuzzle will not generate notifications. Available since 2.9.2"
+      required: false
+    - name: body
+      in: "body"
+      description: "Replaces the content of an existing document."
+      required: true
+      schema:
+        $ref: "#/components/schemas/DocumentReplaceRequest"
+  responses:
+    200:
+      description: "Replaces the content of an existing document."
+      schema:
+        $ref: "#/components/schemas/DocumentReplaceResponse"
+
+components:
+  schemas:
+    DocumentReplaceRequest:
+      allOf:
+        - type: "object"
+          description: "new document content"
+    DocumentReplaceResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                _id:
+                  type: "string"
+                  description: "documentId"
+                _version:
+                  type: "integer"
+                _sources:
+                  type: "object"
+                  description: "new document content"

package/lib/api/openapi/document/scroll.yaml

@@ -0,0 +1,49 @@
+DocumentScroll:
+  summary: "Moves a search cursor forward."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: "scrollId"
+      schema:
+        type: integer
+      description: "cursor unique identifier, obtained by either a search or a scroll query"
+      required: true
+    - in: path
+      name: "scroll"
+      schema:
+        type: integer
+      description: "refresh the cursor duration, using the time to live syntax."
+      required: false
+  responses:
+    200:
+      description: "Moves a search cursor forward."
+      schema:
+        $ref: "#/components/schemas/DocumentScrollResponse"
+
+components:
+  schemas:
+    DocumentScrollResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                scrollId:
+                  type: "string"
+                total:
+                  type: "integer"
+                hits:
+                  type: "array"
+                  items:
+                    type: "object"
+                    properties:
+                      _id:
+                        type: "string"
+                      _score:
+                        type: "integer"
+                      _source:
+                        type: "object"
+                        description: "document content"

package/lib/api/openapi/document/update.yaml

@@ -0,0 +1,78 @@
+DocumentUpdate:
+  summary: "Updates a document content."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: collection
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: _id
+      schema:
+        type: string
+      required: true
+    - in: path
+      name: refresh
+      schema:
+        type: string
+      description: "if set to wait_for, Kuzzle will not respond until the deletion has been indexed"
+      required: false
+    - in: path
+      name: silent
+      schema:
+        type: boolean
+      description: "if set, then Kuzzle will not generate notifications. Available since 2.9.2"
+      required: false
+    - in: path
+      name: source
+      schema:
+        type: boolean
+      required: false
+      description: "if set to true Kuzzle will return the entire updated document body in the response."
+    - in: path
+      name: retryOnConflict
+      schema:
+        type: integer
+      description: "conflicts may occur if the same document gets updated multiple times within a short timespan, in a database cluster. You can set the retryOnConflict optional argument (with a retry count), to tell Kuzzle to retry the failing updates the specified amount of times before rejecting the request with an error."
+      required: false
+    - name: body
+      in: "body"
+      description: "Updates a document content."
+      required: true
+      schema:
+        $ref: "#/components/schemas/DocumentUpdateRequest"
+  responses:
+    200:
+      description: "Updates a document content."
+      schema:
+        $ref: "#/components/schemas/DocumentUpdateResponse"
+
+components:
+  schemas:
+    DocumentUpdateRequest:
+      allOf:
+        - type: "object"
+          description: "document changes"
+    DocumentUpdateResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                _id:
+                  type: "string"
+                  description: "documentId"
+                _version:
+                  type: "integer"
+                _source:
+                  type: string
+                  description: "partial or entire document"

package/lib/api/openapi/index.d.ts

@@ -0,0 +1,2 @@
+export * from './document';
+export declare const OpenApiPayloadsDefinitions: any;

package/lib/api/openapi/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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.OpenApiPayloadsDefinitions = void 0;
+const readYamlFile_1 = require("../../util/readYamlFile");
+__exportStar(require("./document"), exports);
+// Document definitions (reusable object for KuzzleRequest and KuzzleResponse)
+exports.OpenApiPayloadsDefinitions = (0, readYamlFile_1.readYamlFile)(__dirname + '/payloads.yaml').definitions;
+//# sourceMappingURL=index.js.map

package/lib/api/openapi/payloads.yaml

@@ -0,0 +1,32 @@
+definitions:
+  RequestPayload:
+    type: "object"
+    properties:
+      controller:
+        type: "string"
+        enum: "document"
+      action:
+        type: "string"
+        enum: "foo"
+      index:
+        type: "string"
+      collection:
+        type: "string"
+  ResponsePayload:
+    type: "object"
+    properties:
+      status:
+        type: "integer"
+      error:
+        type: "object"
+      index:
+        type: "string"
+      collection:
+        type: "string"
+      controller:
+        type: "string"
+      action:
+        type: "string"
+      requestId:
+        type: "integer"
+        description: "unique request identifie"

package/lib/api/request/kuzzleRequest.d.ts

@@ -1,5 +1,6 @@
 import { JSONObject } from 'kuzzle-sdk';
 import { RequestInput } from './requestInput';
+import { RequestResponse } from './requestResponse';
 import { RequestContext } from './requestContext';
 import { KuzzleError } from '../../kerror/errors';
 import { Deprecation, User } from '../../types';
@@ -12,46 +13,47 @@ import { Deprecation, User } from '../../types';
  */
 export declare class KuzzleRequest {
     /**
-     * Deprecation warnings for the API action
+     * Request external ID (specified by "requestId" or random uuid)
      */
-    deprecations: Deprecation[] | undefined;
+    id: string;
+    constructor(data: any, options: any);
     /**
-    * Request timestamp (in Epoch-Micro)
-    */
-    timestamp: number;
+     * Request internal ID
+     */
+    get internalId(): string;
     /**
-    * Request HTTP status
-    */
-    status: any;
+     * Deprecation warnings for the API action
+     */
+    get deprecations(): Deprecation[] | void;
     /**
-    * Request input
-    */
-    input: RequestInput;
+     * Request timestamp (in Epoch-micro)
+     */
+    get timestamp(): number;
     /**
-   * Request context
-   */
-    context: RequestContext;
+     * Request HTTP status
+     */
+    get status(): number;
+    set status(i: number);
     /**
-    * Request error
-    */
-    error: KuzzleError;
+     * Request input
+     */
+    get input(): RequestInput;
     /**
-    * Request result
-    */
-    result: any;
+     * Request context
+     */
+    get context(): RequestContext;
     /**
-    * Request response
-    */
-    response: any;
+     * Request error
+     */
+    get error(): KuzzleError | null;
     /**
-    * Request internal ID
-    */
-    internalId: any;
+     * Request result
+     */
+    get result(): any | null;
     /**
-    * Request external ID (specified by "requestId" or random uuid)
-    */
-    id: string;
-    constructor(data: any, options: any);
+     * Request response
+     */
+    get response(): RequestResponse;
     /**
      * Adds an error to the request, and sets the request's status to the error one.
      */
@@ -101,6 +103,38 @@ export declare class KuzzleRequest {
         data: JSONObject;
         options: JSONObject;
     };
+    /**
+     * Return a POJO representing the request.
+     *
+     * This can be used to match Koncorde filter rather than the Request object
+     * because it has properties defined with invisible unicode characters.
+     */
+    pojo(): {
+        context: {
+            connection: import("./requestContext").Connection;
+            token: import("../../types").Token;
+            user: User;
+        };
+        deprecations: void | Deprecation[];
+        error: KuzzleError;
+        id: string;
+        input: {
+            action: string;
+            args: JSONObject;
+            body: JSONObject;
+            controller: string;
+            jwt: string;
+            volatile: JSONObject;
+        };
+        internalId: string;
+        response: {
+            headers: JSONObject;
+            raw: boolean;
+        };
+        result: any;
+        status: number;
+        timestamp: number;
+    };
     /**
      * Returns the `lang` param of the request.
      *

package/lib/api/request/kuzzleRequest.js

@@ -53,6 +53,17 @@ const kerror_1 = __importDefault(require("../../kerror"));
 const assert = __importStar(require("../../util/assertType"));
 const safeObject_1 = require("../../util/safeObject");
 const assertionError = kerror_1.default.wrap('api', 'assert');
+// private properties
+// \u200b is a zero width space, used to masquerade console.log output
+const _internalId = 'internalId\u200b';
+const _status = 'status\u200b';
+const _input = 'input\u200b';
+const _error = 'error\u200b';
+const _result = 'result\u200b';
+const _context = 'context\u200b';
+const _timestamp = 'timestamp\u200b';
+const _response = 'response\u200b';
+const _deprecations = 'deprecations\u200b';
 /**
  * The `KuzzleRequest` class represents a request being processed by Kuzzle.
  *
@@ -62,21 +73,21 @@ const assertionError = kerror_1.default.wrap('api', 'assert');
  */
 class KuzzleRequest {
     constructor(data, options) {
-        this.internalId = (0, nanoid_1.nanoid)();
-        this.status = 102;
-        this.input = new requestInput_1.RequestInput(data);
-        this.context = new requestContext_1.RequestContext(options);
-        this.error = null;
-        this.result = null;
-        this.response = new requestResponse_1.RequestResponse(this);
-        this.deprecations = undefined;
+        this[_internalId] = (0, nanoid_1.nanoid)();
+        this[_status] = 102;
+        this[_input] = new requestInput_1.RequestInput(data);
+        this[_context] = new requestContext_1.RequestContext(options);
+        this[_error] = null;
+        this[_result] = null;
+        this[_response] = null;
+        this[_deprecations] = undefined;
         // @deprecated - Backward compatibility with the RequestInput.headers
         // property
-        this.input.headers = this.context.connection.misc.headers;
+        this[_input].headers = this[_context].connection.misc.headers;
         this.id = data.requestId
             ? assert.assertString('requestId', data.requestId)
             : (0, nanoid_1.nanoid)();
-        this.timestamp = data.timestamp || Date.now();
+        this[_timestamp] = data.timestamp || Date.now();
         // handling provided options
         if (options !== undefined && options !== null) {
             if (typeof options !== 'object' || Array.isArray(options)) {
@@ -111,6 +122,67 @@ class KuzzleRequest {
                 this.status = options.status;
             }
         }
+        Object.seal(this);
+    }
+    /**
+     * Request internal ID
+     */
+    get internalId() {
+        return this[_internalId];
+    }
+    /**
+     * Deprecation warnings for the API action
+     */
+    get deprecations() {
+        return this[_deprecations];
+    }
+    /**
+     * Request timestamp (in Epoch-micro)
+     */
+    get timestamp() {
+        return this[_timestamp];
+    }
+    /**
+     * Request HTTP status
+     */
+    get status() {
+        return this[_status];
+    }
+    set status(i) {
+        this[_status] = assert.assertInteger('status', i);
+    }
+    /**
+     * Request input
+     */
+    get input() {
+        return this[_input];
+    }
+    /**
+     * Request context
+     */
+    get context() {
+        return this[_context];
+    }
+    /**
+     * Request error
+     */
+    get error() {
+        return this[_error];
+    }
+    /**
+     * Request result
+     */
+    get result() {
+        return this[_result];
+    }
+    /**
+     * Request response
+     */
+    get response() {
+        if (this[_response] === null) {
+            this[_response] = new requestResponse_1.RequestResponse(this);
+        }
+        return this[_response];
     }
     /**
      * Adds an error to the request, and sets the request's status to the error one.
@@ -119,14 +191,14 @@ class KuzzleRequest {
         if (!error || !(error instanceof Error)) {
             throw new errors_1.InternalError('Cannot set non-error object as a request\'s error');
         }
-        this.error = error instanceof errors_1.KuzzleError ? error : new errors_1.InternalError(error);
-        this.status = this.error.status;
+        this[_error] = error instanceof errors_1.KuzzleError ? error : new errors_1.InternalError(error);
+        this.status = this[_error].status;
     }
     /**
      * Sets the request error to null and status to 200
      */
     clearError() {
-        this.error = null;
+        this[_error] = null;
         this.status = 200;
     }
     /**
@@ -151,7 +223,7 @@ class KuzzleRequest {
         if (options.raw !== undefined) {
             this.response.raw = options.raw;
         }
-        this.result = result;
+        this[_result] = result;
     }
     /**
      * Add a deprecation for a used component, this can be action/controller/parameters...
@@ -168,7 +240,7 @@ class KuzzleRequest {
             version,
         };
         if (!this.deprecations) {
-            this.deprecations = [deprecation];
+            this[_deprecations] = [deprecation];
         }
         else {
             this.deprecations.push(deprecation);
@@ -182,28 +254,62 @@ class KuzzleRequest {
     serialize() {
         const serialized = {
             data: {
-                _id: this.input.args._id,
+                _id: this[_input].args._id,
+                action: this[_input].action,
+                body: this[_input].body,
+                collection: this[_input].args.collection,
+                controller: this[_input].controller,
+                index: this[_input].args.index,
+                jwt: this[_input].jwt,
+                requestId: this.id,
+                timestamp: this[_timestamp],
+                volatile: this[_input].volatile,
+            },
+            // @deprecated - duplicate of options.connection.misc.headers
+            headers: this[_input].headers,
+            options: {
+                error: this[_error],
+                result: this[_result],
+                status: this[_status],
+            },
+        };
+        Object.assign(serialized.data, this[_input].args);
+        Object.assign(serialized.options, this[_context].toJSON());
+        return serialized;
+    }
+    /**
+     * Return a POJO representing the request.
+     *
+     * This can be used to match Koncorde filter rather than the Request object
+     * because it has properties defined with invisible unicode characters.
+     */
+    pojo() {
+        return {
+            context: {
+                connection: this.context.connection,
+                token: this.context.token,
+                user: this.context.user,
+            },
+            deprecations: this.deprecations,
+            error: this.error,
+            id: this.id,
+            input: {
                 action: this.input.action,
+                args: this.input.args,
                 body: this.input.body,
-                collection: this.input.args.collection,
                 controller: this.input.controller,
-                index: this.input.args.index,
                 jwt: this.input.jwt,
-                requestId: this.id,
-                timestamp: this.timestamp,
                 volatile: this.input.volatile,
             },
-            // @deprecated - duplicate of options.connection.misc.headers
-            headers: this.input.headers,
-            options: {
-                error: this.error,
-                result: this.result,
-                status: this.status,
+            internalId: this.internalId,
+            response: {
+                headers: this.response.headers,
+                raw: this.response.raw,
             },
+            result: this.result,
+            status: this.status,
+            timestamp: this.timestamp,
         };
-        Object.assign(serialized.data, this.input.args);
-        Object.assign(serialized.options, this.context.toJSON());
-        return serialized;
     }
     /**
      * Returns the `lang` param of the request.

package/lib/api/request/requestContext.d.ts

@@ -24,23 +24,26 @@ export declare type ContextMisc = {
  * Information about the connection at the origin of the request.
  */
 export declare class Connection {
+    constructor(connection: any);
     /**
      * Unique identifier of the user connection
      */
-    id: string;
+    set id(str: string);
+    get id(): string | null;
     /**
      * Network protocol name
      */
-    protocol: string;
+    set protocol(str: string);
+    get protocol(): string | null;
     /**
      * Chain of IP addresses, starting from the client
      */
-    ips: string[];
+    set ips(arr: string[]);
+    get ips(): string[];
     /**
      * Additional informations about the connection
      */
-    misc: ContextMisc;
-    constructor(connection: any);
+    get misc(): ContextMisc;
     /**
      * Serializes the Connection object
      */
@@ -53,18 +56,6 @@ export declare class Connection {
  * and origin (connection, protocol).
  */
 export declare class RequestContext {
-    /**
-     * Connection that initiated the request
-     */
-    connection: Connection;
-    /**
-     * Authentication token
-     */
-    token: Token | null;
-    /**
-     * Associated user
-     */
-    user: User | null;
     constructor(options?: any);
     /**
      * Serializes the RequestContext object
@@ -81,4 +72,18 @@ export declare class RequestContext {
      */
     get protocol(): string | null;
     set protocol(str: string);
+    /**
+     * Connection that initiated the request
+     */
+    get connection(): Connection;
+    /**
+     * Authentication token
+     */
+    get token(): Token | null;
+    set token(obj: Token | null);
+    /**
+     * Associated user
+     */
+    get user(): User | null;
+    set user(obj: User | null);
 }