@vertigis/workflow 5.36.0 → 5.37.1

package/Hooks.d.ts

@@ -1,32 +1,32 @@
-import { IFacility } from "./Activator";
-import { IActivityHandler, IActivityContext } from "./IActivityHandler";
-/** Do not reference. */
-export interface IActivityHandlerConstructorWithFacility<T> {
-    new (): IActivityHandlerWithFacility<T>;
-    prototype: IActivityHandlerWithFacility<T>;
-}
-/** Do not reference. */
-export interface IActivityHandlerConstructorWithTwoFacilities<T1, T2> {
-    new (): IActivityHandlerWithTwoFacilities<T1, T2>;
-    prototype: IActivityHandlerWithTwoFacilities<T1, T2>;
-}
-/** Do not reference. */
-export interface IActivityHandlerWithFacility<T> {
-    execute(inputs: {}, context: IActivityContext, facility: T, ...args: any[]): Promise<{}> | {};
-}
-/** Do not reference. */
-export interface IActivityHandlerWithTwoFacilities<T1, T2> {
-    execute(inputs: {}, context: IActivityContext, facility1: T1, facility2: T2, ...args: any[]): Promise<{}>;
-}
-/**
- * Decorates activity handlers which require a facility.
- * @public
- */
-export declare function activate<T extends IFacility>(basis: T): (target: IActivityHandlerConstructorWithFacility<T>) => void;
-/** Decorates activity handlers which require two facilities. */
-export declare function activateTwo<T1 extends IFacility, T2 extends IFacility>(basis1: T1, basis2: T2): (target: IActivityHandlerConstructorWithTwoFacilities<T1, T2>) => void;
-/**
- * Discovered facility types previously assigned to the specified handler.
- * @param handler An activity handler to inspect for associated facilities.
- */
-export declare function query(handler: IActivityHandler): IFacility[];
+import { IFacility } from "./Activator";
+import { IActivityHandler, IActivityContext } from "./IActivityHandler";
+/** Do not reference. */
+export interface IActivityHandlerConstructorWithFacility<T> {
+    new (): IActivityHandlerWithFacility<T>;
+    prototype: IActivityHandlerWithFacility<T>;
+}
+/** Do not reference. */
+export interface IActivityHandlerConstructorWithTwoFacilities<T1, T2> {
+    new (): IActivityHandlerWithTwoFacilities<T1, T2>;
+    prototype: IActivityHandlerWithTwoFacilities<T1, T2>;
+}
+/** Do not reference. */
+export interface IActivityHandlerWithFacility<T> {
+    execute(inputs: {}, context: IActivityContext, facility: T, ...args: any[]): Promise<{}> | {};
+}
+/** Do not reference. */
+export interface IActivityHandlerWithTwoFacilities<T1, T2> {
+    execute(inputs: {}, context: IActivityContext, facility1: T1, facility2: T2, ...args: any[]): Promise<{}>;
+}
+/**
+ * Decorates activity handlers which require a facility.
+ * @public
+ */
+export declare function activate<T extends IFacility>(basis: T): (target: IActivityHandlerConstructorWithFacility<T>) => void;
+/** Decorates activity handlers which require two facilities. */
+export declare function activateTwo<T1 extends IFacility, T2 extends IFacility>(basis1: T1, basis2: T2): (target: IActivityHandlerConstructorWithTwoFacilities<T1, T2>) => void;
+/**
+ * Discovered facility types previously assigned to the specified handler.
+ * @param handler An activity handler to inspect for associated facilities.
+ */
+export declare function query(handler: IActivityHandler): IFacility[];

package/IActivityHandler.d.ts

@@ -1,101 +1,101 @@
-import Bluebird from "bluebird";
-import { Task } from "./Task";
-import { LogLevel } from "./diagnostics/logging";
-/**
- * Implemented by activity handlers.
- * @public
- */
-export interface IActivityHandler {
-    /** Executes the logic for an activity. */
-    execute(inputs: {}, context: IActivityContext, ...args: any[]): PromiseLike<{}> | {};
-}
-/**
- * Describes ambient-level state.
- * @public
- */
-export interface IAmbientState {
-    /** Indicates the ActivityContexts with group name monikers that are in scope. */
-    activityContexts: {};
-    /** Indicates the completion object. */
-    completion: Bluebird<{}>;
-    /** Indicates the environment for expressions evaluation. */
-    environment: {};
-    /** Indicates the resources for expression evaluation. */
-    resources: {};
-    /** Indicates the error given to the workflow consumer. */
-    error: Error;
-    /** Indicates the inputs given to the workflow consumer. */
-    inputs: {};
-    /** Indicates the current workflow locale. */
-    locale: string | undefined;
-    /** Indicates the current workflow log level. */
-    logLevel: LogLevel;
-    /** Indicates the outputs that the workflow should return. */
-    outputs: {};
-    /** Indicates the trivia for storing ambient-level state. */
-    trivia: {};
-    /** Immediately completes the workflow. */
-    complete(outputs?: {}): void;
-    /** Immediately completes the workflow with an error. */
-    reject(error?: Error): void;
-}
-/**
- * Describes something that can be aborted via an `AbortController`.
- */
-export interface Abortable {
-    /**
-     * An `AbortSignal` to be passed to Esri's web-based APIs.
-     * When aborted, the operation will be cancelled.
-     */
-    signal?: AbortSignal;
-}
-/**
- * Describes an activity currently being executed.
- * @public
- */
-export interface IActivityContext {
-    /** Indicates the locally-unique identifier that changes per-run per-activity. */
-    luid: any;
-    /** Indicates the ambient state. */
-    ambient: IAmbientState;
-    /** Indicates the action being executed. */
-    action: string;
-    /** Indicates the branch being executed. */
-    branch: boolean | number | string;
-    /** Indicates the cancellation token. */
-    cancellationToken: Task<void> & Abortable;
-    /** Indicates the number of passes on the current step. */
-    passes: number;
-    /** Indicates the state that was persisted. */
-    state: any;
-    /** Indicates the error that was caught. */
-    caught: Error;
-    /** Attempts to call on a transition chain. */
-    call(branch?: boolean | number | string): void;
-    /** Attempts to fork to a transition chain. */
-    fork(branch?: boolean | number | string): void;
-    /** Attempts to jump to a transition chain. */
-    jump(branch?: boolean | number | string): void;
-    /** Instructs the engine to allow the activity to handle errors. */
-    registerForErrors(): void;
-    /** Indicates if any transitions are available for the given branch. */
-    hasBranch(branch?: boolean | number | string): boolean;
-    /** Persists state across invocations. */
-    persist(state: any): void;
-    /** Attempts to restart the workflow at the context. */
-    goto(): void;
-}
-/**
- * Indicates an activity has no inputs. Should only be used in
- * an activity's execute method signature.
- * @public
- */
-export interface EmptyInputs {
-}
-/**
- * Indicates an activity has no outputs. Should only be used in
- * an activity's execute method signature.
- * @public
- */
-export interface EmptyOutputs {
-}
+import Bluebird from "bluebird";
+import { Task } from "./Task";
+import { LogLevel } from "./diagnostics/logging";
+/**
+ * Implemented by activity handlers.
+ * @public
+ */
+export interface IActivityHandler {
+    /** Executes the logic for an activity. */
+    execute(inputs: {}, context: IActivityContext, ...args: any[]): PromiseLike<{}> | {};
+}
+/**
+ * Describes ambient-level state.
+ * @public
+ */
+export interface IAmbientState {
+    /** Indicates the ActivityContexts with group name monikers that are in scope. */
+    activityContexts: Record<string, any>;
+    /** Indicates the completion object. */
+    completion: Bluebird<{}>;
+    /** Indicates the environment for expressions evaluation. */
+    environment: Record<string, any>;
+    /** Indicates the resources for expression evaluation. */
+    resources?: Record<string, any>;
+    /** Indicates the error given to the workflow consumer. */
+    error: Error;
+    /** Indicates the inputs given to the workflow consumer. */
+    inputs: Record<string, any>;
+    /** Indicates the current workflow locale. */
+    locale?: string;
+    /** Indicates the current workflow log level. */
+    logLevel?: LogLevel;
+    /** Indicates the outputs that the workflow should return. */
+    outputs: Record<string, any>;
+    /** Indicates the trivia for storing ambient-level state. */
+    trivia?: Record<string, any>;
+    /** Immediately completes the workflow. */
+    complete(outputs?: Record<string, any>): void;
+    /** Immediately completes the workflow with an error. */
+    reject(error?: Error): void;
+}
+/**
+ * Describes something that can be aborted via an `AbortController`.
+ */
+export interface Abortable {
+    /**
+     * An `AbortSignal` to be passed to Esri's web-based APIs.
+     * When aborted, the operation will be cancelled.
+     */
+    signal?: AbortSignal;
+}
+/**
+ * Describes an activity currently being executed.
+ * @public
+ */
+export interface IActivityContext {
+    /** Indicates the locally-unique identifier that changes per-run per-activity. */
+    luid: any;
+    /** Indicates the ambient state. */
+    ambient: IAmbientState;
+    /** Indicates the action being executed. */
+    action?: string;
+    /** Indicates the branch being executed. */
+    branch?: boolean | number | string;
+    /** Indicates the cancellation token. */
+    cancellationToken: Task<void> & Abortable;
+    /** Indicates the number of passes on the current step. */
+    passes: number;
+    /** Indicates the state that was persisted. */
+    state: any;
+    /** Indicates the error that was caught. */
+    caught?: Error;
+    /** Attempts to call on a transition chain. */
+    call(branch?: boolean | number | string): void;
+    /** Attempts to fork to a transition chain. */
+    fork(branch?: boolean | number | string): void;
+    /** Attempts to jump to a transition chain. */
+    jump(branch?: boolean | number | string): void;
+    /** Instructs the engine to allow the activity to handle errors. */
+    registerForErrors(): void;
+    /** Indicates if any transitions are available for the given branch. */
+    hasBranch(branch?: boolean | number | string): boolean;
+    /** Persists state across invocations. */
+    persist(state: any): void;
+    /** Attempts to restart the workflow at the context. */
+    goto(): void;
+}
+/**
+ * Indicates an activity has no inputs. Should only be used in
+ * an activity's execute method signature.
+ * @public
+ */
+export interface EmptyInputs {
+}
+/**
+ * Indicates an activity has no outputs. Should only be used in
+ * an activity's execute method signature.
+ * @public
+ */
+export interface EmptyOutputs {
+}

package/LanguageStringUtils.d.ts

@@ -1,17 +1,16 @@
-import { Lookup } from "./Collections";
-import { ProgramInspector } from "./definition/ProgramInspector";
-import { RunOptions } from "./execution/Engine";
-/**
- * Gets the language strings to be used by the program. These are accumulated from three different places in
- * the following order:
- *
- *   * Firstly, we start with the hard-coded `defaultStrings`.
- *   * Secondly, any language strings provided by the host application are added.
- *   * Finally, any language strings defined in the workflow for the specified locale are added.
- *
- * In each case, when a language key is already present, the new value replaces the existing one.
- *
- * @param inspector The `ProgramInspector` for the workflow being executed.
- * @param options The `RunOptions` provided by the host application.
- */
-export declare function getStringsForProgram(inspector: ProgramInspector, options: RunOptions): Lookup<string>;
+import type { ProgramInspector } from "./definition/ProgramInspector";
+import type { RunOptions } from "./execution/Engine";
+/**
+ * Gets the language strings to be used by the program. These are accumulated from three different places in
+ * the following order:
+ *
+ *   * Firstly, we start with the hard-coded `defaultStrings`.
+ *   * Secondly, any language strings provided by the host application are added.
+ *   * Finally, any language strings defined in the workflow for the specified locale are added.
+ *
+ * In each case, when a language key is already present, the new value replaces the existing one.
+ *
+ * @param inspector The `ProgramInspector` for the workflow being executed.
+ * @param options The `RunOptions` provided by the host application.
+ */
+export declare function getStringsForProgram(inspector: ProgramInspector, options: RunOptions): Record<string, string>;

package/LanguageStringUtils.js

@@ -1 +1 @@
-const defaultStrings={"common-all":"All","common-cancel":"Cancel","common-clear":"Clear","common-done":"Done","common-end":"End","common-none":"None","common-ok":"OK","common-start":"Start","common-to":"to","common-today":"Today","common-undo":"Undo","date-range-picker-end-text":"End Date","date-range-picker-start-text":"Start Date","file-picker-remove-item-label":"Remove file","form-element-status-failure":"Failure","form-element-status-invalid":"Invalid input","form-element-status-missing":"Required","form-element-status-pending":"Working...","form-element-status-trivial":"No data","geometry-picker-remove-item-label":"Remove location"};function getStringsForProgram(e,t){const o={...defaultStrings};if(t.strings)for(const r of Object.keys(t.strings))o[r]=t.strings[r];var n=e.getStrings(t.locale);for(const m of Object.keys(n))o[m]=n[m];return o}export{getStringsForProgram};
+const defaultStrings={"common-all":"All","common-cancel":"Cancel","common-clear":"Clear","common-done":"Done","common-end":"End","common-none":"None","common-ok":"OK","common-start":"Start","common-to":"to","common-today":"Today","common-undo":"Undo","date-range-picker-end-text":"End Date","date-range-picker-start-text":"Start Date","file-picker-remove-item-label":"Remove file","form-element-status-failure":"Failure","form-element-status-invalid":"Invalid input","form-element-status-missing":"Required","form-element-status-pending":"Working...","form-element-status-trivial":"No data","geometry-picker-remove-item-label":"Remove location","item-picker-hidden-selected-item":"1 hidden item is also selected.","item-picker-hidden-selected-items":"hidden items are also selected.","item-picker-select":"Select","item-picker-select-visible":"Select Visible"};function getStringsForProgram(e,t){const o={...defaultStrings};if(t.strings)for(const i of Object.keys(t.strings))o[i]=t.strings[i];var n=e.getStrings(t.locale);for(const m of Object.keys(n))o[m]=n[m];return o}export{getStringsForProgram};

package/ProgramInspectorFacility.d.ts

@@ -1,24 +1,23 @@
-import Bluebird from "bluebird";
-import { ProgramInspector } from "./definition/ProgramInspector";
-export interface ResolveArgs {
-    id?: string;
-    program?: string | {};
-    url?: string;
-}
-/** @product This is intended for internal use only within VertiGIS Studio products. */
-export declare class ProgramInspectorFacility {
-    private _cache;
-    constructor();
-    /**
-     * Resolves the program inspector for a specified workflow `Program`. This function will cache the workflow program by default
-     * and will return the cached version in subsequent lookups, unless instructed otherwise.
-     * @param args The input `ResolveArgs` argument. Depending on the host, this may be a url or an object containing an id, url or workflow `Program` object.
-     * @param useCache An optional boolean which determines whether caching is allowed for retrieved workflow programs. Defaults to true.
-     * @param workflowDownloader An optional function which may be used to override the default download function for retrieving a workflow `Program`
-     *                           This is useful on hosts like GVH where special processing may be required before downloading resources.
-     */
-    resolveInspector(args: ResolveArgs | string, useCache?: boolean, workflowDownloader?: (url: string) => Bluebird<any>): Bluebird<ProgramInspector>;
-    private downloadAndResolveInspector;
-    private loadWorkflow;
-    private createInspector;
-}
+import { ProgramInspector } from "./definition/ProgramInspector";
+export interface ResolveArgs {
+    id?: string;
+    program?: string | {};
+    url?: string;
+}
+/** @product This is intended for internal use only within VertiGIS Studio products. */
+export declare class ProgramInspectorFacility {
+    private _cache;
+    constructor();
+    /**
+     * Resolves the program inspector for a specified workflow `Program`. This function will cache the workflow program by default
+     * and will return the cached version in subsequent lookups, unless instructed otherwise.
+     * @param args The input `ResolveArgs` argument. Depending on the host, this may be a url or an object containing an id, url or workflow `Program` object.
+     * @param useCache An optional boolean which determines whether caching is allowed for retrieved workflow programs. Defaults to true.
+     * @param workflowDownloader An optional function which may be used to override the default download function for retrieving a workflow `Program`
+     *                           This is useful on hosts like GVH where special processing may be required before downloading resources.
+     */
+    resolveInspector(args: ResolveArgs | string, useCache?: boolean, workflowDownloader?: (url: string) => Promise<any>): Promise<ProgramInspector>;
+    private downloadAndResolveInspector;
+    private loadWorkflow;
+    private createInspector;
+}

package/Task.d.ts

@@ -1,56 +1,56 @@
-/** @product This is intended for internal use only within VertiGIS Studio products. */
-export declare class Task<T> implements PromiseLike<T> {
-    private _state;
-    private _value;
-    private _reason;
-    private _promise;
-    constructor(executor: (resolve: (value?: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void);
-    static attempt<T>(myFunction: () => T | Task<T>): Task<T>;
-    /**
-     * Creates a Task that is resolved or rejected when any of the provided Tasks are resolved
-     * or rejected.
-     * @param values An array of Tasks.
-     * @returns A new Task.
-     */
-    static race<T>(values: readonly (T | PromiseLike<T>)[]): Task<T>;
-    /**
-     * Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
-     * resolved value cannot be modified from the callback.
-     *
-     * This polyfill is based on a Stack Overflow answer:
-     * https://stackoverflow.com/a/53327815/5322405
-     * @param onfinally The callback to execute when the Promise is settled (fulfilled or rejected).
-     * @returns A Promise for the completion of the callback.
-     */
-    finally(onfinally?: (() => void) | undefined | null): Task<T>;
-    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Task<TResult1 | TResult2>;
-    /**
-     * Returns `true` if the task succeeded, `false` otherwise.
-     */
-    isFulfilled(): boolean;
-    /**
-     * Returns `true` if the task is still running, `false` otherwise.
-     */
-    isPending(): boolean;
-    /**
-     * Returns `true` if the task failed, `false` otherwise.
-     */
-    isRejected(): boolean;
-    /**
-     * Returns `true` if the task's fate has been decided one way or the other.
-     * It is no longer pending.
-     */
-    isResolved(): boolean;
-    /**
-     * Returns the failure object (if any) if the task is rejected.
-     * Otherwise throws an error. Call the `isRejected()` method to confirm
-     * that a Task failed prior to calling this method.
-     */
-    reason(): any;
-    /**
-     * Returns the value (if any) if the task is resolved.
-     * Otherwise throws an error. Call the `isResolved()` method to confirm
-     * that a Task succeeded prior to calling this method.
-     */
-    value(): T;
-}
+/** @product This is intended for internal use only within VertiGIS Studio products. */
+export declare class Task<T> implements PromiseLike<T> {
+    private _state;
+    private _value;
+    private _reason;
+    private _promise;
+    constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void);
+    static attempt<T>(myFunction: () => T | Task<T>): Task<T>;
+    /**
+     * Creates a Task that is resolved or rejected when any of the provided Tasks are resolved
+     * or rejected.
+     * @param values An array of Tasks.
+     * @returns A new Task.
+     */
+    static race<T>(values: readonly (T | PromiseLike<T>)[]): Task<T>;
+    /**
+     * Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
+     * resolved value cannot be modified from the callback.
+     *
+     * This polyfill is based on a Stack Overflow answer:
+     * https://stackoverflow.com/a/53327815/5322405
+     * @param onfinally The callback to execute when the Promise is settled (fulfilled or rejected).
+     * @returns A Promise for the completion of the callback.
+     */
+    finally(onfinally: () => void): Task<T>;
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Task<TResult1 | TResult2>;
+    /**
+     * Returns `true` if the task succeeded, `false` otherwise.
+     */
+    isFulfilled(): boolean;
+    /**
+     * Returns `true` if the task is still running, `false` otherwise.
+     */
+    isPending(): boolean;
+    /**
+     * Returns `true` if the task failed, `false` otherwise.
+     */
+    isRejected(): boolean;
+    /**
+     * Returns `true` if the task's fate has been decided one way or the other.
+     * It is no longer pending.
+     */
+    isResolved(): boolean;
+    /**
+     * Returns the failure object (if any) if the task is rejected.
+     * Otherwise throws an error. Call the `isRejected()` method to confirm
+     * that a Task failed prior to calling this method.
+     */
+    reason(): any;
+    /**
+     * Returns the value (if any) if the task is resolved.
+     * Otherwise throws an error. Call the `isResolved()` method to confirm
+     * that a Task succeeded prior to calling this method.
+     */
+    value(): T;
+}

package/TemplateUtils.d.ts

@@ -1,28 +1,28 @@
-import { MarkdownRef } from "./forms/FormDefinition";
-export interface TokenInstance {
-    token: string;
-    start: number;
-    end: number;
-}
-export interface TokenValues {
-    [token: string]: string;
-}
-export declare function findTokenInstances(formatString: string): TokenInstance[];
-/**
- * Gets a string representation of the supplied value.
- * @param token The name of the token being replaced.
- * @param value The value to replace the token.
- */
-export declare function getTokenValueString(token: string, value: any): string;
-export declare function replacePlaceholders(formatString: string, tokenInstances: TokenInstance[], tokenValues: TokenValues): MarkdownRef;
-/**
- * Returns the value itself, or an empty string if the value is `null` or `undefined`.
- *
- * Care must be taken to handle two cases correctly:
- * 1) A "falsey" value such as zero should be preserved as it is still a legitimate value.
- * 2) Values of `undefined` and `null` must not be mistakenly interpreted to mean
- *    "the field name was invalid".
- * @param value A value to inspect.
- * @returns The value itself, or an empty string if the value is `null` or `undefined`.
- */
-export declare function valueOrEmptyString(value: any): any;
+import { MarkdownRef } from "./forms/FormDefinition";
+export interface TokenInstance {
+    token: string;
+    start: number;
+    end: number;
+}
+export interface TokenValues {
+    [token: string]: string;
+}
+export declare function findTokenInstances(formatString: string | undefined): TokenInstance[];
+/**
+ * Gets a string representation of the supplied value.
+ * @param token The name of the token being replaced.
+ * @param value The value to replace the token.
+ */
+export declare function getTokenValueString(token: string, value: any): string;
+export declare function replacePlaceholders(formatString: string, tokenInstances: TokenInstance[], tokenValues: TokenValues): MarkdownRef;
+/**
+ * Returns the value itself, or an empty string if the value is `null` or `undefined`.
+ *
+ * Care must be taken to handle two cases correctly:
+ * 1) A "falsey" value such as zero should be preserved as it is still a legitimate value.
+ * 2) Values of `undefined` and `null` must not be mistakenly interpreted to mean
+ *    "the field name was invalid".
+ * @param value A value to inspect.
+ * @returns The value itself, or an empty string if the value is `null` or `undefined`.
+ */
+export declare function valueOrEmptyString(value: any): any;