@vertigis/workflow 5.36.0 → 5.37.1

package/Activator.d.ts

@@ -1,25 +1,25 @@
-import Bluebird from "bluebird";
-/**
- * Implemented by workflow containers to customize the creation of various currencies.
- */
-export interface IFacilityFactory {
-    /** Activates an instance. */
-    (type: string): PromiseLike<{}> | {};
-}
-/** Implemented by facilities to uniquely identify that facility. */
-export interface IFacility {
-    type: string;
-}
-/**
- * Exposes functionality for activating well-known facilities.
- */
-export declare class Activator {
-    /** Provides a means to provide a factory implementations. */
-    factories: IFacilityFactory[];
-    /**
-     * Activates an instance of a type.
-     * @param type The type to activate an instnace of.
-     * @param name The cardinal name of the instance.
-     */
-    activate<T extends IFacility>(basis: T): Bluebird<T>;
-}
+import Bluebird from "bluebird";
+/**
+ * Implemented by workflow containers to customize the creation of various currencies.
+ */
+export interface IFacilityFactory {
+    /** Activates an instance. */
+    (type: string): PromiseLike<{}> | {} | undefined;
+}
+/** Implemented by facilities to uniquely identify that facility. */
+export interface IFacility {
+    type: string;
+}
+/**
+ * Exposes functionality for activating well-known facilities.
+ */
+export declare class Activator {
+    /** Provides a means to provide a factory implementations. */
+    factories: IFacilityFactory[];
+    /**
+     * Activates an instance of a type.
+     * @param type The type to activate an instnace of.
+     * @param name The cardinal name of the instance.
+     */
+    activate<T extends IFacility>(basis: T): Bluebird<T>;
+}

package/Collections.d.ts

@@ -1,91 +1,83 @@
-/**
- * Describes a dictionary oriented collection.
- * @public
- */
-export interface Lookup<T> {
-    [id: number]: T;
-    [name: string]: T;
-}
-/** Describes a dictionary of literal values. */
-export interface PropertySet {
-    [name: string]: boolean | number | string;
-}
-/** Provides a means to iterate over a collection efficiently. */
-export declare class Iterator<T> {
-    key: string | number | undefined;
-    current: T | undefined;
-    /** Exposes the remaining assets of the collection as an array. */
-    list(): T[];
-    /** Selects the next asset of the collection. */
-    next(): boolean;
-    /** Peeks at the next item. */
-    peek(): T | undefined;
-    /** Maps the iterator to another collection. */
-    map<TResult>(itemSelector: (item: T) => Iterable<TResult>, keySelector?: (result: TResult, key: string | number) => string | number): Iterator<TResult>;
-    /** Returns an iterable which filters. */
-    filter(predicate: (item: T, key: string | number) => boolean): Iterator<T>;
-    /** Returns an iterable which represents the concatenation of two iterables. */
-    concat(items: Iterable<T>): Iterator<T>;
-    /** Returns an empty iterable. */
-    static empty: Iterator<any>;
-    /** Wraps the items or item as an iterable. */
-    static from<T>(items: Iterable<T>): Iterator<T>;
-}
-/** Used internally by Dictionary to track items. */
-export interface DictionaryEntry<T> {
-    /** Used to track the key of the entry. */
-    key: string;
-    /** Used to track the index of the entry. */
-    index: number;
-    /** Used to track the value of the entry. */
-    value: T;
-}
-export declare class Dictionary<T> {
-    /** Assign the value to the given key. */
-    protected iterating: boolean;
-    /** Assign the value to the given key. */
-    protected array: DictionaryEntry<T>[];
-    /** Assign the value to the given key. */
-    protected lookup: Lookup<DictionaryEntry<T>>;
-    /** Ensures the array internal array is mutable so that iterators are not corrupted. */
-    protected ensureMutable(): DictionaryEntry<T>[];
-    /** Performs an iteration of the items. */
-    iterate(): Iterator<T>;
-    /** Assigns the value to the given key. */
-    assign(key: any, value: T): T | undefined;
-    /** Removes an item given the key. */
-    remove(key: any): boolean;
-    /** Tests if the key exists. */
-    exists(key: any): boolean;
-    /** Finds the specific item given the key. */
-    find(key: any): T;
-    /** Clears the collection. */
-    clear(): void;
-    /** Gets the length. */
-    get length(): number;
-}
-/** Offers a means to tie an item to a result. */
-export interface Thunk {
-    /** Exposes the result for the thunk. */
-    item: any;
-    /** Exposes the result for the thunk. */
-    result: any;
-}
-/** Offers a means of using an array to hold many thunks. */
-export interface ThunkArray extends Array<Thunk> {
-    /** Indicates the owner. */
-    owner?: any;
-}
-/** Provides a means to stash per key per object values. */
-export declare class Stash {
-    /** Structure for managing the internal state. */
-    protected lookup: Lookup<Thunk | ThunkArray>;
-    /** Indicates if the thunk(s) is a singleton or a provisioned array. */
-    protected isArray(thunks: Thunk | ThunkArray): thunks is ThunkArray;
-    /** Reads the result for a particular key/item. */
-    read(key: any, item: any): any;
-    /** Writes the result for a particular key/item. */
-    write(key: any, item: any, result: any): any;
-}
-/** Convenience for specifying an iterable type. */
-export declare type Iterable<T> = T | T[] | Iterator<T>;
+/** Describes a dictionary of literal values. */
+export interface PropertySet {
+    [name: string]: boolean | number | string;
+}
+/** Provides a means to iterate over a collection efficiently. */
+export declare class Iterator<T> {
+    key: string | number | undefined;
+    current: T | undefined;
+    /** Exposes the remaining assets of the collection as an array. */
+    list(): T[];
+    /** Selects the next asset of the collection. */
+    next(): boolean;
+    /** Peeks at the next item. */
+    peek(): T | undefined;
+    /** Maps the iterator to another collection. */
+    map<TResult>(itemSelector: (item: T) => Iterable<TResult>, keySelector?: (result: TResult, key: string | number) => string | number): Iterator<TResult>;
+    /** Returns an iterable which filters. */
+    filter(predicate: (item: T, key: string | number) => boolean): Iterator<T>;
+    /** Returns an iterable which represents the concatenation of two iterables. */
+    concat(items: Iterable<T>): Iterator<T>;
+    /** Returns an empty iterable. */
+    static empty: Iterator<any>;
+    /** Wraps the items or item as an iterable. */
+    static from<T>(items: Iterable<T>): Iterator<T>;
+}
+/** Used internally by Dictionary to track items. */
+export interface DictionaryEntry<T> {
+    /** Used to track the key of the entry. */
+    key: string;
+    /** Used to track the index of the entry. */
+    index: number;
+    /** Used to track the value of the entry. */
+    value: T;
+}
+export declare class Dictionary<T> {
+    /** Assign the value to the given key. */
+    protected iterating: boolean;
+    /** Assign the value to the given key. */
+    protected array: DictionaryEntry<T>[];
+    /** Assign the value to the given key. */
+    protected lookup: Record<string, DictionaryEntry<T>>;
+    /** Ensures the array internal array is mutable so that iterators are not corrupted. */
+    protected ensureMutable(): DictionaryEntry<T>[];
+    /** Performs an iteration of the items. */
+    iterate(): Iterator<T>;
+    /** Assigns the value to the given key. */
+    assign(key: any, value: T): T | undefined;
+    /** Removes an item given the key. */
+    remove(key: any): boolean;
+    /** Tests if the key exists. */
+    exists(key: any): boolean;
+    /** Finds the specific item given the key. */
+    find(key: any): T | undefined;
+    /** Clears the collection. */
+    clear(): void;
+    /** Gets the length. */
+    get length(): number;
+}
+/** Offers a means to tie an item to a result. */
+export interface Thunk {
+    /** Exposes the result for the thunk. */
+    item: any;
+    /** Exposes the result for the thunk. */
+    result: any;
+}
+/** Offers a means of using an array to hold many thunks. */
+export interface ThunkArray extends Array<Thunk> {
+    /** Indicates the owner. */
+    owner?: any;
+}
+/** Provides a means to stash per key per object values. */
+export declare class Stash {
+    /** Structure for managing the internal state. */
+    protected lookup: Record<string, Thunk | ThunkArray>;
+    /** Indicates if the thunk(s) is a singleton or a provisioned array. */
+    protected isArray(thunks: Thunk | ThunkArray): thunks is ThunkArray;
+    /** Reads the result for a particular key/item. */
+    read(key: any, item: any): any;
+    /** Writes the result for a particular key/item. */
+    write(key: any, item: any, result: any): any;
+}
+/** Convenience for specifying an iterable type. */
+export type Iterable<T> = T | T[] | Iterator<T>;

package/EnumUtils.d.ts

@@ -1,28 +1,28 @@
-/**
- * This class allows us to dynamically iterate through the names or value in an
- * enumeration. It was found here: https://stackoverflow.com/a/21294925/5322405
- * @product This is intended for internal use only within VertiGIS Studio products.
- */
-export declare class EnumUtils {
-    /**
-     * Returns all the names and values defined in an enumeration as an array
-     * of name/value pairs.
-     * @param enumeration An enumeration
-     */
-    static getNamesAndValues<T extends number>(enumeration: any): any[];
-    /**
-     * Returns an array of all the names defined in an enumeration.
-     * @param enumeration An enumeration
-     */
-    static getNames(enumeration: any): string[];
-    /**
-     * Returns an array of all the numeric values defined in an enumeration.
-     * @param enumeration An enumeration
-     */
-    static getValues<T extends number>(enumeration: any): number[];
-    /**
-     * Returns an array of all the names and numeric values defined in an enumeration.
-     * @param enumeration An enumeration
-     */
-    private static getObjValues;
-}
+/**
+ * This class allows us to dynamically iterate through the names or value in an
+ * enumeration. It was found here: https://stackoverflow.com/a/21294925/5322405
+ * @product This is intended for internal use only within VertiGIS Studio products.
+ */
+export declare class EnumUtils {
+    /**
+     * Returns all the names and values defined in an enumeration as an array
+     * of name/value pairs.
+     * @param enumeration An enumeration
+     */
+    static getNamesAndValues<T extends number>(enumeration: any): any[];
+    /**
+     * Returns an array of all the names defined in an enumeration.
+     * @param enumeration An enumeration
+     */
+    static getNames(enumeration: any): string[];
+    /**
+     * Returns an array of all the numeric values defined in an enumeration.
+     * @param enumeration An enumeration
+     */
+    static getValues<T extends number>(enumeration: any): number[];
+    /**
+     * Returns an array of all the names and numeric values defined in an enumeration.
+     * @param enumeration An enumeration
+     */
+    private static getObjValues;
+}

package/Errors.d.ts

@@ -1,155 +1,155 @@
-declare const ActivityError_base: {
-    new (): Error;
-    prototype: Error;
-};
-/** Defines an abstract error for when an activity error has occurred. */
-export declare abstract class ActivityError extends ActivityError_base {
-    /** Indicates the error code. */
-    code: string;
-}
-/**
- * Defines an error that occurs when an activity has been aborted.
- * @product This is intended for internal use only within VertiGIS Studio products.
- */
-export declare class ActivityAbortedError extends ActivityError {
-}
-/**
- * Defines an error that occurs when an activity has been cancelled.
- * @product This is intended for internal use only within VertiGIS Studio products.
- */
-export declare class ActivityCancellationError extends ActivityError {
-}
-/** Defines an error that occurs when there is an error executing an activity. */
-export declare class GenericActivityError extends ActivityError {
-    constructor(code?: string, text?: string);
-    /** Indicates the activity that failed. */
-    activityId: number;
-    /** Indicates the inner error. */
-    code: string;
-    /** Indicates the amount of time taken. */
-    elapsed: number;
-    /** Indicates the error was a result of a timeout. */
-    timedOut: boolean;
-    /** Indicates the inner error. */
-    error: any;
-    /** Indicates the inner errors. */
-    errors: Error[];
-    /** Indicates the partial result. */
-    partialResult: any;
-}
-declare const ProgramStartError_base: {
-    new (): Error;
-    prototype: Error;
-};
-/** Defines an error that occurs when there is no starting step given or available. */
-export declare class ProgramStartError extends ProgramStartError_base {
-    code: string;
-}
-declare const UnspecifiedError_base: {
-    new (): Error;
-    prototype: Error;
-};
-/** Defines an error that occurs when there is no starting step given or available. */
-export declare class UnspecifiedError extends UnspecifiedError_base {
-    code: string;
-}
-/** Defines an error that occurs when there is a problem with instantiating an activity handler. */
-export declare class ActivityBindingError extends ActivityError {
-    constructor(id: number, action: string, error?: any);
-    /** Indicates the activity that failed. */
-    activityId: number;
-    /** Indicates the action that failed. */
-    action: string;
-    /** Indicates the underlying error that occurred. */
-    error: any;
-}
-declare const EngineRuntimeError_base: {
-    new (): Error;
-    prototype: Error;
-};
-/** Defines an error that occurs when there is a problem with the workflow engine. */
-export declare class EngineRuntimeError extends EngineRuntimeError_base {
-    constructor(error: any);
-    code: string;
-    error: any;
-}
-declare const ProgramParserError_base: {
-    new (): Error;
-    prototype: Error;
-};
-/** Defines an error that occurs when there is a problem with parsing the workflow program. */
-export declare class ProgramParserError extends ProgramParserError_base {
-    constructor(error: any);
-    code: string;
-    error: any;
-}
-/** Defines an error that occurs when there is a problem evaluating an expression during the execution of a workflow. */
-export declare class ExpressionEvaluationError extends ActivityError {
-    constructor(id: number, inputName: string, expression: string, error?: any);
-    /** Indicates the identifier the failed activity. */
-    activityId: number;
-    /** Indicates the input name of the failed expression. */
-    inputName: string;
-    /** Indicates the expression that failed. */
-    expression: string;
-    /** Indicates the error that failed. */
-    error: any;
-}
-/** Defines an error that occurs when there is a problem parsing an expression during the execution of a workflow. */
-export declare class ExpressionSyntaxError extends ActivityError {
-    constructor(id: number, inputName: string, expression: string, error?: any);
-    /** Indicates the identifier the failed activity. */
-    activityId: number;
-    /** Indicates the input name of the failed expression. */
-    inputName: string;
-    /** Indicates the expression that failed. */
-    expression: string;
-    /** Indicates the error that failed. */
-    error: any;
-}
-/** Defines an error that occurs when there is a problem accesssing the workflow or global scope. */
-export declare class ExpressionAccessorError extends ActivityError {
-    constructor(id: number, accessorName: string, error: any, errors?: Error[]);
-    /** Indicates the identifier the failed activity. */
-    activityId: number;
-    /** Indicates the accessor name within the failed expression. */
-    accessorName: string;
-    /** Indicates the error that failed. */
-    error?: any;
-    /** Indicates the error that failed. */
-    errors?: Error[];
-}
-/** Defines an error that occurs when there is a problem accessing the workflow or global scope. */
-export declare class ActivityActivationError extends ActivityError {
-    constructor(id: number, type: string, error: any);
-    /** Indicates the identifier the failed activity. */
-    activityId: number;
-    /** Indicates the type of the . */
-    type: string;
-    /** Indicates the error that failed. */
-    error?: any;
-}
-/** Defines an error that occurs when there is a failure with an activity. */
-export declare class AggregateActivityError extends ActivityError {
-    constructor(id: number, errors?: Error[]);
-    /** Indicates the identifier the failed activity. */
-    activityId: number;
-    /** Indicates the error that failed. */
-    errors?: Error[];
-}
-/** Defines an error that occurs when there is a problem with an input. */
-export declare class ActivityInputError extends ActivityError {
-    constructor(inputName: string, assertion: string);
-    /** Indicates the assertion for which the input failed. */
-    assertion: string;
-    /** Indicates the input that there was a problem with. */
-    inputName: string;
-}
-/**
- * Defines an error that occurs when an attempt was made to execute an activity
- * which has not been implemented by the host application.
- */
-export declare class ActivityNotImplementedError extends ActivityError {
-    constructor(activityName: string);
-}
-export {};
+declare const ActivityError_base: {
+    new (): Error;
+    prototype: Error;
+};
+/** Defines an abstract error for when an activity error has occurred. */
+export declare abstract class ActivityError extends ActivityError_base {
+    /** Indicates the error code. */
+    code: string | undefined;
+}
+/**
+ * Defines an error that occurs when an activity has been aborted.
+ * @product This is intended for internal use only within VertiGIS Studio products.
+ */
+export declare class ActivityAbortedError extends ActivityError {
+}
+/**
+ * Defines an error that occurs when an activity has been cancelled.
+ * @product This is intended for internal use only within VertiGIS Studio products.
+ */
+export declare class ActivityCancellationError extends ActivityError {
+}
+/** Defines an error that occurs when there is an error executing an activity. */
+export declare class GenericActivityError extends ActivityError {
+    constructor(code?: string, text?: string);
+    /** Indicates the activity that failed. */
+    activityId: number | undefined;
+    /** Indicates the inner error. */
+    code: string;
+    /** Indicates the amount of time taken. */
+    elapsed: number | undefined;
+    /** Indicates the error was a result of a timeout. */
+    timedOut: boolean | undefined;
+    /** Indicates the inner error. */
+    error: any;
+    /** Indicates the inner errors. */
+    errors: Error[] | undefined;
+    /** Indicates the partial result. */
+    partialResult: any;
+}
+declare const ProgramStartError_base: {
+    new (): Error;
+    prototype: Error;
+};
+/** Defines an error that occurs when there is no starting step given or available. */
+export declare class ProgramStartError extends ProgramStartError_base {
+    code: string | undefined;
+}
+declare const UnspecifiedError_base: {
+    new (): Error;
+    prototype: Error;
+};
+/** Defines an error that occurs when there is no starting step given or available. */
+export declare class UnspecifiedError extends UnspecifiedError_base {
+    code: string | undefined;
+}
+/** Defines an error that occurs when there is a problem with instantiating an activity handler. */
+export declare class ActivityBindingError extends ActivityError {
+    constructor(id: number, action: string, error?: any);
+    /** Indicates the activity that failed. */
+    activityId: number | undefined;
+    /** Indicates the action that failed. */
+    action: string;
+    /** Indicates the underlying error that occurred. */
+    error: any;
+}
+declare const EngineRuntimeError_base: {
+    new (): Error;
+    prototype: Error;
+};
+/** Defines an error that occurs when there is a problem with the workflow engine. */
+export declare class EngineRuntimeError extends EngineRuntimeError_base {
+    constructor(error: any);
+    code: string | undefined;
+    error: any;
+}
+declare const ProgramParserError_base: {
+    new (): Error;
+    prototype: Error;
+};
+/** Defines an error that occurs when there is a problem with parsing the workflow program. */
+export declare class ProgramParserError extends ProgramParserError_base {
+    constructor(error: any);
+    code: string | undefined;
+    error: any;
+}
+/** Defines an error that occurs when there is a problem evaluating an expression during the execution of a workflow. */
+export declare class ExpressionEvaluationError extends ActivityError {
+    constructor(id: number, inputName: string, expression: string, error?: any);
+    /** Indicates the identifier the failed activity. */
+    activityId: number;
+    /** Indicates the input name of the failed expression. */
+    inputName: string;
+    /** Indicates the expression that failed. */
+    expression: string;
+    /** Indicates the error that failed. */
+    error: any;
+}
+/** Defines an error that occurs when there is a problem parsing an expression during the execution of a workflow. */
+export declare class ExpressionSyntaxError extends ActivityError {
+    constructor(id: number, inputName: string, expression: string, error?: any);
+    /** Indicates the identifier the failed activity. */
+    activityId: number;
+    /** Indicates the input name of the failed expression. */
+    inputName: string;
+    /** Indicates the expression that failed. */
+    expression: string;
+    /** Indicates the error that failed. */
+    error: any;
+}
+/** Defines an error that occurs when there is a problem accesssing the workflow or global scope. */
+export declare class ExpressionAccessorError extends ActivityError {
+    constructor(id: number, accessorName: string, error: any, errors?: Error[]);
+    /** Indicates the identifier the failed activity. */
+    activityId: number;
+    /** Indicates the accessor name within the failed expression. */
+    accessorName: string;
+    /** Indicates the error that failed. */
+    error?: any;
+    /** Indicates the error that failed. */
+    errors?: Error[];
+}
+/** Defines an error that occurs when there is a problem accessing the workflow or global scope. */
+export declare class ActivityActivationError extends ActivityError {
+    constructor(id: number, type: string, error: any);
+    /** Indicates the identifier the failed activity. */
+    activityId: number;
+    /** Indicates the type of the . */
+    type: string;
+    /** Indicates the error that failed. */
+    error?: any;
+}
+/** Defines an error that occurs when there is a failure with an activity. */
+export declare class AggregateActivityError extends ActivityError {
+    constructor(id: number, errors?: Error[]);
+    /** Indicates the identifier the failed activity. */
+    activityId: number;
+    /** Indicates the error that failed. */
+    errors?: Error[];
+}
+/** Defines an error that occurs when there is a problem with an input. */
+export declare class ActivityInputError extends ActivityError {
+    constructor(inputName: string, assertion: string);
+    /** Indicates the assertion for which the input failed. */
+    assertion: string;
+    /** Indicates the input that there was a problem with. */
+    inputName: string;
+}
+/**
+ * Defines an error that occurs when an attempt was made to execute an activity
+ * which has not been implemented by the host application.
+ */
+export declare class ActivityNotImplementedError extends ActivityError {
+    constructor(activityName: string);
+}
+export {};