@olympeio/runtime-web 8.5.1 → 8.6.2

package/index.d.ts

@@ -134,6 +134,51 @@ export class SubscribeService extends Service {
  * an API to observe and set values of this brick's properties.
  */
 export class Context {
+
+    /**
+     * Register a callback to execute when the context is destroyed. Return the callback id.
+     *
+     * @param callback the callback function
+     * @return the callback id
+     */
+    onDestroy(callback: () => void): string;
+
+    /**
+     * Remove a previously registered callback with {@link Context#onDestroy} method using its id.
+     *
+     * @param id the id of the callback to unregister
+     */
+    offDestroy(id: string): void;
+
+    /**
+     * Register a callback to execute every time the context is cleared.
+     * This happens every time the brick is refreshed with new inputs and during the brick destruction.
+     * Return the callback id.
+     *
+     * @param callback the callback function
+     * @return the callback id
+     */
+    onClear(callback: () => void): string;
+
+    /**
+     * Remove a previously registered callback with {@link Context#onClear} method using its id.
+     *
+     * @param id the id of the callback to unregister
+     */
+    offClear(id: string): void;
+
+    /**
+     * Destroy the current context. It destroys all children context attached to this one and clear their values.
+     * The context cannot be reused after calling this function.
+     */
+    destroy(): void;
+
+    /**
+     * Clear the current context: detach and destroys all children context.
+     * The context can be reused.
+     */
+    clear(): void;
+
     /**
      * Set the specified property value and propagate the update to anyone observing it.
      *
@@ -166,6 +211,37 @@ export class Context {
      */
     observe<T>(property: PropertyDescriptor<T> | string, nullable?: boolean): Observable<T>;
 
+    /**
+     * Create and return a new context, child of the current one.
+     * Mainly used to run other bricks within the current one (e.g.: the iterator of the brick For Each).
+     *
+     * @param debugName a name to give to the context for debugging purpose.
+     */
+    createChild(debugName?: string): Context;
+
+    /**
+     * Return the context with the specified id if accessible (in the hierarchy) from this context.
+     * Otherwise, return null.
+     *
+     * @param id the context id we want to retrieve
+     */
+    getOtherContext(id: string): Context | null;
+
+    /**
+     * Listen to the creation of the context with the specified id.
+     * Executes the callback when that context becomes accessible by this current context.
+     * Return a function to unregister the listener.
+     *
+     * @param id the context id, which corresponds to the tag of the brick to be retrieved.
+     * @param callback the function to execute when the specified brick context is available
+     */
+    onContext(id: string, callback: (context: Context) => void): () => void;
+
+    /**
+     * Return the parent context if it exists.
+     */
+    getParent(): Context | null;
+
     /**
      * Return the closest transaction from this context :
      * - look in its own transaction stack
@@ -207,25 +283,6 @@ export class Context {
      * @return the transaction if exists
      */
     popTransaction(): Transaction | null;
-
-    /**
-     * Return the specified context from the hierarchy of this context, if it exists.
-     *
-     * @param tag the context id, which correspond to the tag of the brick.
-     */
-    getOtherContext(tag: string): Context | null;
-
-    /**
-     * Register a callback to get a context that could not be created yet. Returns a function that unregister the context.
-     *
-     * @param tag the context id, which correspond to the tag of the brick.
-     */
-    onContext(tag: string, callback: (context: Context) => void): () => void;
-
-    /**
-     * Return the parent context if it exists.
-     */
-    getParent(): Context | null;
 }
 
 /**
@@ -253,6 +310,14 @@ export class UIContext extends Context {
      * @param properties list of properties to observe simultaneously
      */
     observeMany(...properties: string[]): Observable<any[]>;
+
+    /**
+     * Create and return a new UIContext, child of the current one.
+     * Mainly used to run other bricks within the current one (e.g.: a list renderer).
+     *
+     * @param debugName a name to give to the context for debugging purpose.
+     */
+    createChild(debugName?: string): UIContext;
 }
 
 /**
@@ -399,12 +464,12 @@ export class FunctionBrick extends Brick {
     /**
      * Return the list of inputs tags as an ordered array.
      */
-    protected readonly getInputs: () => string[];
+    readonly getInputs: () => string[];
 
     /**
      * Return the list of outputs tags as an ordered array
      */
-    protected readonly getOutputs: () => string[];
+    readonly getOutputs: () => string[];
 }
 
  /**
@@ -495,6 +560,11 @@ export class Auth {
      */
     static getToken(): string;
 
+    /**
+     * Return the SAML token (zipped & base64 encoded XML) for the current user.
+     */
+    static getSAMLToken(): string;
+
     /**
      * Return the tag of the current authenticated user.
      */
@@ -599,6 +669,19 @@ export class ColorPrimitive extends Sync {
     static valueProp: PropertyDescriptor<Color>;
 }
 
+export class Enum extends Sync {
+    create(transaction: Transaction, name?: string): string;
+    getValues(): ListDef;
+}
+
+export class EnumValue extends StringPrimitive {
+    static create(transaction: Transaction, enumModel: InstanceTag, value: string, name?: string, rank?: number): string;
+
+    static nameProp: PropertyDescriptor<string>;
+    static valueProp: PropertyDescriptor<string>;
+    static rankProp: PropertyDescriptor<number>;
+}
+
 export class File extends Sync {
     static nameProp: PropertyDescriptor<string>;
     static creationDateProp: PropertyDescriptor<Date>;