@olympeio/runtime-node 9.10.4 → 9.11.0

package/types/{base.d.ts → data.d.ts}

@@ -1,10 +1,11 @@
+import { Class, Context } from "./other";
+import { Direction, HasTag, Property, Relation } from "./composition";
+import { PropertyModel } from "./models";
+import { Query, QuerySingle, QueryResult } from "./query";
+import { Source } from "./data-connector";
+import { Transaction } from "./transaction";
 // @ts-ignore
-import {Observable} from 'rxjs';
-import {PropertyModel, Query, QueryResult, QuerySingle, Source} from "./cloud";
-
-// **********************************
-// Primitives
-// **********************************
+import { Observable } from "rxjs";
 
 /**
  * A InstanceOrTag can be either a `string`, a `HasTag` (CloudObject instance, Property, Relation, ...)
@@ -12,100 +13,183 @@ import {PropertyModel, Query, QueryResult, QuerySingle, Source} from "./cloud";
  */
 export type InstanceOrTag = string | HasTag | typeof CloudObject;
 
-export type List<T> = Array<T> | (T extends CloudObject | CloudObject[] ? QueryResult<T> : never);
-
-export type Class<T> = {new (): T};
-
 /**
- * Generates a unique olympe tag used to identify `CloudObjects`
- *
- * @return {string} tag
+ * File is the main class used to create business objects with a binary/string data content.
+ * It is a Data Type so can be extended and associated to a data source.
  */
-export function generateTag(): string;
+export class File extends CloudObject {
 
-/**
- * Get the unique identifier of the specified InstanceOrTag as a string
- *
- * If the given tag is a `CloudObject` instance, the tag of that instance is returned.
- * If a class constructor is given, the tag of the corresponding `CloudObject` is returned.
- *
- * @param tag
- * @return string tag of given input
- */
-export function tagToString(tag: InstanceOrTag): string;
+    /**
+     * @deprecated because conflict with {@link CloudObject.nameProp}. Use {@link File.fileNameProp} instead.
+     */
+    static nameProp: Property<string>;
+    static fileNameProp: Property<string>;
+    static creationDateProp: Property<Date>;
+    static modificationDateProp: Property<Date>;
+    static mimeTypeProp: Property<string>;
+    static urlProp: Property<string>;
 
-/**
- * The HasTag interface defines objects that have a tag.
- * The tag of these objects must be returned by the overridden method: `getTag()`
- */
-export interface HasTag {
     /**
-     * @return tag of this instance
+     * Set the binary content of a specified file
+     * @param transaction transaction in which to create the file
+     * @param file tag of the file
+     * @param name file name
+     * @param content byte content of the file
+     * @param mimeType optional mime type of the file
      */
-    getTag(): string;
-}
+    static setContent(transaction: Transaction, file: InstanceOrTag, name: string, content: Uint8Array | ArrayBuffer, mimeType?: string): void;
+
+    /**
+     * Set the content of a `File` from a specified URL
+     * @param transaction transaction in which to create the file
+     * @param file tag of the file
+     * @param name filename
+     * @param url url to retrieve content from
+     * @param mimeType optional mime type of the file
+     */
+    static setURLContent(transaction: Transaction, file: InstanceOrTag, name: string, url: string, mimeType?: string): void;
+
+    /**
+     * @deprecated Please use {@link File.setContent}
+     * Create a `File` from its content
+     *
+     * @param transaction transaction in which to create the file
+     * @param name filename
+     * @param content byte content of the file
+     * @param mimeType optional mime type of the file
+     * @param source optional source where file will be stored ({@link {PredefinedDataSource}} or DBConnector tag)
+     * @param tag optional tag for the file
+     * @return tag string of the file
+     */
+    static createFromContent(transaction: Transaction, name: string, content: Uint8Array | ArrayBuffer, mimeType?: string, source?: Source, tag?: string): string;
+
+    /**
+     * @deprecated Please use {@link File.setURLContent}
+     * Create a `File` from a specified URL
+     * @param transaction transaction in which to create the file
+     * @param name filename
+     * @param url url to retrieve content from
+     * @param mimeType optional mime type of the file
+     * @param source optional source where file will be stored ({@link {PredefinedDataSource}} or DBConnector tag)
+     * @param tag optional tag for the file
+     * @return tag string of the file
+     */
+    static createFromURL(transaction: Transaction, name: string, url: string, mimeType?: string, source?: Source, tag?: string): string;
+
+    /**
+     * Gets the file content as an ArrayBuffer.
+     *
+     * @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);
+
+    /**
+     * Gets the file content as an ArrayBuffer.
+     *
+     * @return promise resolving with the content as a byte array
+     */
+    getContentAsBinary(): Promise<ArrayBuffer>;
+
+    /**
+     * 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.
+     *
+     * @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
+     */
+    getContentAsString(onSuccess: (content: string) => void, onFailure?: (errMsg: string) => void);
 
-/**
- * Softcoded application context
- *
- * Contexts have parents and children, they represent the lifecycle of bricks.
- * They contain callbacks executed at specific time of the brick lifespan.
- *
- * Each time a brick is updated with new inputs, {@apilink Context.clear} is called,
- * executing all callbacks registered with {@apilink Context.onClear}.
- *
- * When a brick is destroyed, {@apilink Context.destroy} is called,
- * executing all callbacks registered with {@apilink Context.onClear} and {@apilink Context.onDestroy}
- */
-export abstract class Context {
     /**
-     * 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.
+     * 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
      */
-    destroy(): void;
+    getContentAsString(): Promise<string>;
 
     /**
-     * Clear the current context: detach and destroys all children context.
-     * The context can be reused.
+     * 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
      */
-    clear(): void;
+    getContentUrl(onSuccess: (content: string) => void, onFailure?: () => void);
 
     /**
-     * Register a callback to execute when the context is destroyed. Return the callback id.
+     * 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
      *
-     * @param callback the callback function
-     * @return the callback id
+     * @return promise resolving with the content as a string
      */
-    onDestroy(callback: () => void): string;
+    getContentUrl(): Promise<string>;
 
     /**
-     * Remove a previously registered callback with {@apilink Context.onDestroy} method using its id.
+     * Save this file with specified name
      *
-     * @param callbackId the id of the callback to unregister
+     * @param name filename
      */
-    offDestroy(callbackId: string): boolean;
+    saveAs(name: string): void;
+}
+
 
+/**
+ * An Enum is an ordered list of string key-values mappings
+ */
+export class Enum extends CloudObject {
     /**
-     * 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.
+     * Create an empty `Enum?`  without any value
+     *
+     * See {@link EnumValue.createValue} to create values for an Enum.
      *
-     * @param callback the callback function
-     * @return the callback id
+     * @param transaction transaction in which to create the Enum
+     * @param name optional name of the Enum
+     * @return string tag of the Enum object
+     */
+    create(transaction: Transaction, name?: string): string;
+
+    /**
+     * Get the values defined for this `Enum`
      */
-    onClear(callback: () => void): string;
+    getValues(): QueryResult<EnumValue>;
+}
 
+/**
+ * An `EnumValue` is a single value part of an `Enum`.
+ * It has a `string` name, a rank (its position in the Enum list).
+ *
+ * The values for `EnumValue` are always stringified.
+ */
+export class EnumValue extends CloudObject {
     /**
-     * Remove a previously registered callback with {@apilink Context.onClear} method using its id.
+     * Add a `EnumValue` to a specified `Enum`
      *
-     * @param id the id of the callback to unregister
+     * @param transaction transaction in which to add the EnumValue to the Enum
+     * @param enumModel `EnumModel` containing the specified `EnumValue`
+     * @param value value of the `EnumValue`
+     * @param name name of the `EnumValue`
+     * @param rank position of the `EnumValue` in the `Enum`
      */
-    offClear(id: string): void;
+    static createValue(transaction: Transaction, enumModel: InstanceOrTag, value: string, name?: string, rank?: number): string;
 
     /**
-     * Whether the context is destroyed or currently being destroyed.
+     * Name property for an EnumValue
+     */
+    static nameProp: Property<string>;
+    /**
+     * Value property for an EnumValue
      */
-    isDestroyed(): boolean;
+    static valueProp: Property<string>;
+    /**
+     * Rank property for an EnumValue
+     */
+    static rankProp: Property<number>;
 }
 
 /**
@@ -113,7 +197,7 @@ export abstract class Context {
  * In essence, it represents a remote reference to an object in the data cloud.
  * It is identified by its unique ID, or tag. From a `CloudObject` you can access related `CloudObjects`.
  *
- * A `CloudObject` can be instantiated via the {@apilink InstanceOrTag} of its model, and it can be instantiated multiple times with different properties values.
+ * A `CloudObject` can be instantiated via the {@link InstanceOrTag} of its model, and it can be instantiated multiple times with different properties values.
  * *Data types* defined in DRAW are such `CloudObjects`, instances of Data types are also `CloudObjects`.
  *
  * **Example:**
@@ -135,7 +219,7 @@ export abstract class CloudObject implements HasTag {
     static getProperties(): Property<any>[];
 
     /**
-     * Return all the relations whose origin OR destination is the {@apilink CloudObject} associated to this class.
+     * Return all the relations whose origin OR destination is the {@link CloudObject} associated to this class.
      *
      * @return All relations defined on the current data type. It can be the destination or the origin of the relations.
      */
@@ -153,7 +237,7 @@ export abstract class CloudObject implements HasTag {
      * Get the CloudObject whose tag is specified.
      *
      * This only works if the `CloudObject` is already present in the local datacloud cache.
-     * (NB: you can use a {@apilink Query} to retrieve a distant {@apilink CloudObject})
+     * (NB: you can use a {@link Query} to retrieve a distant {@link CloudObject})
      *
      * @static
      * @param tag tag of the `CloudObject`
@@ -253,7 +337,7 @@ export abstract class CloudObject implements HasTag {
     /**
      * Start a query from this instance and follow the relation given as argument.
      * The query starts from this single instance, and follows a relation to an arbitrary
-     * number of destination instances. See {@apilink Query.follow | Query.follow(relation)}
+     * number of destination instances. See {@link Query.follow | Query.follow(relation)}
      *
      * The following are equivalent:
      * ```javascript
@@ -279,7 +363,7 @@ export abstract class CloudObject implements HasTag {
 
     // Properties getters
     /**
-     * Get the current value of the specified property for this {@apilink CloudObject} instance
+     * Get the current value of the specified property for this {@link CloudObject} instance
      *
      * @param property property or property's tag
      * @return property value
@@ -290,7 +374,7 @@ export abstract class CloudObject implements HasTag {
      * Get an observable to the current value of the specified property for this `CloudObject` instance.
      *
      * The observable gets the new value each time the property gets updated in the datacloud.
-     * The observable gets completed automatically once the specified context is {@apilink Context.onClear | cleared}.
+     * The observable gets completed automatically once the specified context is {@link Context.onClear | cleared}.
      * If `waitForValue` is set to FALSE (TRUE by default), the first value received by the observable is null if there is no value at call time.
      *
      * @param context context to which the Observable is attached
@@ -304,7 +388,7 @@ export abstract class CloudObject implements HasTag {
      * Get an observable to pair [property, value] for this `CloudObject` instance.
      *
      * The observable gets the new value each time any property gets updated in the datacloud.
-     * The observable gets completed automatically once the specified context is {@apilink Context.onClear | cleared}.
+     * The observable gets completed automatically once the specified context is {@link Context.onClear | cleared}.
      *
      * @param context Context to which the Observable will be attached
      * @return Observable of property values
@@ -320,7 +404,7 @@ export abstract class CloudObject implements HasTag {
 
     /**
      * Create a Javascript object from this CloudObject current state, including its tag and property values.
-     * It provides the same result as {@apilink CloudObject.toObject | toObject} called with nameAsKey = true and inheritedProperties = false.
+     * It provides the same result as {@link CloudObject.toObject | toObject} called with nameAsKey = true and inheritedProperties = false.
      */
     toJSON(): Object;
 
@@ -337,7 +421,7 @@ export abstract class CloudObject implements HasTag {
     static modelRel: Relation<CloudObject, CloudObject>;
 
     /**
-     * Inverse relation of {@apilink modelRel} between a model and its instances
+     * Inverse relation of {@link modelRel} between a model and its instances
      * Equivalent to `modelRel.getInverse()`
      */
     static instancesRel: Relation<CloudObject, CloudObject>;
@@ -351,7 +435,7 @@ export abstract class CloudObject implements HasTag {
      */
     static extendRel: Relation<CloudObject, CloudObject>;
     /**
-     * Inverse relation of {@apilink extendRel}
+     * Inverse relation of {@link extendRel}
      */
     static extendedByRel: Relation<CloudObject, CloudObject>;
     /**
@@ -366,89 +450,13 @@ export abstract class CloudObject implements HasTag {
     static propertyRel: Relation<CloudObject, PropertyModel>;
 }
 
-/**
- * A property of a model defines an attribute. A property has a `tag`.
- * Each instance of a model can have value for these defined properties.
- */
-export interface Property<T> extends HasTag {}
-
-/**
- * Relations are directed from A to B and can be followed in either direction.
- */
-export enum Direction {
-    /**
-     * For relation A to B, go to A, the origin
-     */
-    ORIGIN = '<',
-    /**
-     * For relation A to B, go to B, the destination
-     */
-    DESTINATION = '>'
-}
-
-interface RelationConstructor {
-    /**
-     * Create a relation between two CloudObject classes
-     * @param tag tag of the relation to create
-     * @param direction whether the relation points to the origin or destination
-     */
-    new(tag: InstanceOrTag, direction?: Direction): Relation<CloudObject, CloudObject>;
-
-    /**
-     * Create a relation between two CloudObject classes
-     * @param tag tag of the relation to create
-     * @param direction whether the relation points to the origin or destination
-     * @param origin origin class of the relation
-     * @param destination destination class of the relation
-     */
-    new<O extends CloudObject, D extends CloudObject>(tag: InstanceOrTag, direction?: Direction, origin?: Class<O>, destination?: Class<D>): Relation<O, D>;
-}
-
-/**
- * Global variable, constructor of class Relation.
- */
-export declare const Relation: RelationConstructor;
-
-/**
- * Relations can be defined between from a `CloudObject` to another, for example between two data types.
- * Relations are directed and have two types: the origin type, the destination type.
- *
- * Defining a relation between two data types means that instances of these data types can be related with that relation.
- */
-export interface Relation<O extends CloudObject, D extends CloudObject> extends HasTag {
-
-    /**
-     * @return tag of the relation
-     */
-    getTag(): string;
-
-    /**
-     * @return direction of the relation, whether it points to origin or destination
-     */
-    getDirection(): Direction;
-
-    /**
-     * @return class type for the destination of the relation
-     */
-    type(): Class<D>;
-
-    /**
-     * @return class type for the origin of the relation
-     */
-    originType(): Class<O>;
-
-    /**
-     * @return inverse relation where newOrigin = oldDestination, newDestination = oldOrigin
-     */
-    getInverse(): Relation<D, O>;
-}
 
 /**
  * Register the class constructor as the class associated to the specified tag.
  *
  * This creates the link between a class and an DataType in the database.
  * Once this link is created, all the instances of the DataType (model)
- * are instantiated as JS objects using the specified class (see {@apilink CloudObject.get})
+ * are instantiated as JS objects using the specified class (see {@link CloudObject.get})
  *
  * @param tag tag of the DataType
  * @param object `CloudObject` constructor
@@ -464,10 +472,11 @@ export function register(tag: InstanceOrTag, object: typeof CloudObject): void;
  */
 export function defineProperty<T>(tag: InstanceOrTag, type?: Class<T>): Property<T>;
 
+
 /**
  * Create a constant relation object between two specified DataTypes.
  *
- * That constant is used especially to create queries see {@apilink Query.follow | Query.follow(relation)}
+ * That constant is used especially to create queries see {@link Query.follow | Query.follow(relation)}
  *
  * @param tag tag of the relation
  * @param origin origin DataType of the relation
@@ -479,7 +488,7 @@ export function defineRelation<O extends CloudObject, D extends CloudObject>(tag
 /**
  * Create a constant relation object between two generic `CloudObjects`
  *
- * That constant is used especially to create queries see {@apilink Query.follow | Query.follow(relation)}
+ * That constant is used especially to create queries see {@link Query.follow | Query.follow(relation)}
  *
  * @param tag tag of the relation
  * @param direction direction of the relation, pointing towards origin or destination. Default is `DESTINATION`
@@ -487,6 +496,7 @@ export function defineRelation<O extends CloudObject, D extends CloudObject>(tag
  */
 export function defineRelation(tag: InstanceOrTag, direction?: Direction): Relation<CloudObject, CloudObject>;
 
+
 /**
  * Returns a constant object corresponding to the specified relation going to the opposite direction
  *

package/types/index.d.ts

@@ -1,5 +1,11 @@
-export * from './base';
 export * from './runtime';
-export * from './cloud';
-export * from './utils';
+export * from './query';
+export * from './transaction';
+export * from './data';
+export * from './service';
+export * from './composition';
+export * from './transaction-advanced';
+export * from './data-connector';
+export * from './models';
+export * from './other';
 export * from './legacy';

package/types/legacy.d.ts

@@ -1,6 +1,7 @@
 // @ts-ignore
 import {Observable} from 'rxjs';
-import {CloudObject, Direction, HasTag, Property, Relation, InstanceOrTag} from "./base";
+import {CloudObject, InstanceOrTag} from "./data";
+import {Direction, HasTag, Property, Relation} from "./composition";
 import {Brick, VisualBrick} from "./runtime";
 /**
  * The entry of a brick is a static object linked to the brick class itself that is used to make the link between the