@olympeio/runtime-node 9.8.1 → 9.9.1

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@olympeio/runtime-node",
-  "version": "9.8.1",
+  "version": "9.9.1",
   "description": "Olympe Node Runtime Environment",
   "types": "types/index.d.ts",
   "dependencies": {
-    "ws": "~8.11.0",
-    "bufferutil": "~4.0.7",
-    "utf-8-validate": "~5.0.10",
-    "rxjs": "7.8.1",
-    "fastify": "~4.24.3"
+    "ws": "~8.18.0",
+    "bufferutil": "~4.0.8",
+    "utf-8-validate": "~6.0.4",
+    "rxjs": "~7.8.1",
+    "fastify": "~4.28.1"
   },
   "codeAsData": "import",
   "author": "Olympe S.A. <dev@olympe.ch>",

package/types/cloud.d.ts

@@ -169,28 +169,58 @@ export class File extends CloudObject {
     static createFromURL(transaction: Transaction, name: string, url: string, mimeType?: string, source?: Source, tag?: string): string;
 
     /**
-     * Retrieve content from this file asynchronously
+     * Gets the file content as an ArrayBuffer.
      *
-     * @param onSuccess callback to execute when byte content has been retrieved successfully
-     * @param onFailure callback to execute when content retrieval has failed
+     * @deprecated consider using the new `getContentAsBinary` method returning a Promise instead
+     * @param onSuccess (deprecated) callback to execute when byte content has been retrieved successfully
+     * @param onFailure (deprecated) callback to execute when content retrieval has failed
      */
-    getContentAsBinary(onSuccess: (content: ArrayBuffer) => void, onFailure?: (errMsg: string) => void): void;
+    getContentAsBinary(onSuccess: (content: ArrayBuffer) => void, onFailure?: (errMsg: string) => void);
 
     /**
-     * Retrieve string content from this file asynchronously
+     * Gets the file content as an ArrayBuffer.
      *
-     * @param onSuccess callback to execute when string content has been retrieved successfully
-     * @param onFailure callback to execute when content retrieval has failed
+     * @return promise resolving with the content as a byte array
      */
-    getContentAsString(onSuccess: (content: string) => void, onFailure?: (errMsg: string) => void): void;
+    getContentAsBinary():Promise<ArrayBuffer>;
 
     /**
-     * Retrieve string content from URL asynchronously
+     * Get the content of this file and returns it as an UTF-8 string.
+     * **Note:** this method should be used only when the file is a text file.
      *
-     * @param onSuccess callback to execute when content has been retrieved successfully
-     * @param onFailure callback to execute when content retrieval has failed
+     * @deprecated consider using the new `getContentAsString` method returning a Promise instead
+     * @param onSuccess (deprecated) callback to execute when string content has been retrieved successfully
+     * @param onFailure (deprecated) callback to execute when content retrieval has failed
      */
-    getContentUrl(onSuccess: (content: string) => void, onFailure?: () => void): void;
+    getContentAsString(onSuccess: (content: string) => void, onFailure?: (errMsg: string) => void);
+
+    /**
+     * Get the content of this file and returns it as an UTF-8 string.
+     * **Note:** this method should be used only when the file is a text file.
+     *
+     * @return promise resolving with the content as a string
+     */
+    getContentAsString(): Promise<string>;
+
+    /**
+     * Gets the URL that gives direct access to the file content:
+     * - For files that are external to Olympe, gives the normal URL
+     * - For the files stored by Olympe, provides a dataURL, with the content embedded in Base64
+     *
+     * @deprecated consider using the new `getContentUrl` method returning a Promise instead
+     * @param onSuccess (deprecated) callback to execute when content has been retrieved successfully
+     * @param onFailure (deprecated) callback to execute when content retrieval has failed
+     */
+    getContentUrl(onSuccess: (content: string) => void, onFailure?: () => void);
+
+    /**
+     * Gets the URL that gives direct access to the file content:
+     * - For files that are external to Olympe, gives the normal URL
+     * - For the files stored by Olympe, provides a dataURL, with the content embedded in Base64
+     *
+     * @return promise resolving with the content as a string
+     */
+    getContentUrl(): Promise<string>;
 
     /**
      * Save this file with specified name

package/types/runtime.d.ts

@@ -144,11 +144,12 @@ export class BrickContext extends Context {
 
     /**
      * Return the closest parent of a given type
+     * If no context of the specified type is found from the hierarchy, returns the root context.
      *
      * @param selector the context selector
      * @param selector.modelTag tag of the "type" of context you want to find in the parent tree
      */
-    getClosest(selector: {modelTag: InstanceOrTag}): BrickContext | null;
+    getClosest(selector: {modelTag: InstanceOrTag}): BrickContext;
 
     /**
      * Listen to the creation of the context with the specified id.

package/types/utils.d.ts

@@ -19,6 +19,18 @@ export class Config {
     static getParameter(id: string): unknown | undefined;
 }
 
+/**
+ * Types of probe that can be used to check the health of the process:
+ * - LIVENESS: used to check if the process is alive
+ * - READINESS: used to check if the process is ready to operate
+ * - ALL: used to check both liveness and readiness
+ */
+export enum ProbeType {
+    LIVENESS = 'liveness',
+    READINESS = 'readiness',
+    ALL = 'all'
+}
+
 // Health check and shutdown
 export class Process {
 
@@ -29,10 +41,15 @@ export class Process {
      * The callback must return a Promise which returns a string as valid message.
      * The process is considered by the runtime as unhealthy if the promise is rejected.
      *
+     * The options parameter can be used to specify the type of probe to register:
+     * - LIVENESS: used to check if the process is alive
+     * - READINESS: used to check if the process is ready to operate
+     * - ALL: used to check both liveness and readiness
+     *
      * @param callback the callback executed each time the runtime check the health of the process.
-     * @param healthCheckId optional id to name the healthCheck hook, mainly for debug purpose
+     * @param options options to specify the type of probe to register
      */
-    static onHealthCheck(callback: () => Promise<string>, healthCheckId?: string): () => void;
+    static onHealthCheck(callback: () => Promise<string>, options?: {type: ProbeType}): () => void;
 
     /**
      * Static method to register a callback called by the runtime when it receives the signal to be terminated.