From f00e60a866c9abf4d83bd442af543cfe8a9b0bb5 Mon Sep 17 00:00:00 2001 From: geoffhendrey Date: Tue, 8 Oct 2024 21:13:12 +0000 Subject: [PATCH] deploy: 62255533c0bacc39c89fc4483a28ff8d33cdd28f --- classes/CliCore.default.html | 12 +-- classes/CliCoreBase.CliCoreBase.html | 12 +-- classes/ConsoleLogger.default.html | 4 +- classes/DependencyFinder.default.html | 6 +- classes/ExecutionStatus.ExecutionStatus.html | 8 +- classes/FancyLogger.default.html | 4 +- classes/JsonPointer.default.html | 24 +++--- .../LifecycleManager.LifecycleManager.html | 10 +-- classes/MetaInfoProducer.default.html | 4 +- classes/StatedREPL.default.html | 4 +- classes/TemplateProcessor.default.html | 76 +++++++++---------- classes/TimerManager.TimerManager.html | 4 +- classes/VizGraph.default.html | 4 +- enums/Lifecycle.LifecycleState.html | 12 +-- ...tUtils.parseMarkdownAndTestCodeblocks.html | 2 +- functions/TestUtils.parseMarkdownTests.html | 2 +- functions/index.stringifyTemplateJSON.html | 2 +- interfaces/ConsoleLogger.StatedLogger.html | 4 +- interfaces/Lifecycle.LifecycleOwner.html | 6 +- interfaces/MetaInfoProducer.MetaInfo.html | 4 +- modules/CliCore.html | 2 +- modules/CliCoreBase.html | 2 +- modules/ConsoleLogger.html | 2 +- modules/DependencyFinder.html | 2 +- modules/ExecutionStatus.html | 2 +- modules/FancyLogger.html | 2 +- modules/JsonPointer.html | 2 +- modules/Lifecycle.html | 2 +- modules/LifecycleManager.html | 2 +- modules/MetaInfoProducer.html | 2 +- modules/StatedREPL.html | 2 +- modules/TemplateProcessor.html | 2 +- modules/TestUtils.html | 2 +- modules/TimerManager.html | 2 +- modules/VizGraph.html | 2 +- modules/index.html | 2 +- types/ConsoleLogger.Levels.html | 2 +- types/ConsoleLogger.LogLevel.html | 2 +- types/JsonPointer.DescentCallback.html | 2 +- types/JsonPointer.DescentIterator.html | 2 +- types/Lifecycle.LifecycleCallback.html | 2 +- types/MetaInfoProducer.JsonPointerString.html | 2 +- ...nfoProducer.JsonPointerStructureArray.html | 2 +- .../TemplateProcessor.DataChangeCallback.html | 2 +- types/TemplateProcessor.Fork.html | 2 +- .../TemplateProcessor.FunctionGenerator.html | 2 +- types/TemplateProcessor.MetaInfoMap.html | 2 +- types/TemplateProcessor.Op.html | 2 +- types/TemplateProcessor.Plan.html | 2 +- types/TemplateProcessor.PlanStep.html | 2 +- types/TemplateProcessor.Snapshot.html | 2 +- types/TemplateProcessor.StatedError.html | 2 +- types/TestUtils.CommandAndResponse.html | 2 +- variables/ConsoleLogger.LOG_LEVELS.html | 2 +- 54 files changed, 136 insertions(+), 136 deletions(-) diff --git a/classes/CliCore.default.html b/classes/CliCore.default.html index e56202b9..8d44d632 100644 --- a/classes/CliCore.default.html +++ b/classes/CliCore.default.html @@ -1,6 +1,6 @@ default | stated-js

Base class for building CLIs. By itself can be used for a CLI that does not support the tail command. Tail command uses Node repl class that is not implemented in other JS runtimes such as Bun. CliCoreBase should run in Bun.

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

currentDirectory: string
onInit: (() => void | Promise<void>)

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

replServer: REPLServer
templateProcessor: default

Methods

  • this method is just here as a stub to allow tests to pass. Color is in reality handled only by StatedRepl, +

Constructors

Properties

currentDirectory: string
onInit: (() => void | Promise<void>)

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

replServer: REPLServer
templateProcessor: default

Methods

  • this method is just here as a stub to allow tests to pass. Color is in reality handled only by StatedRepl, it is not something that is possible to 'see' from the CLI since CLI returns pure JSON which has no concept of terminal colors.

    -

    Returns void

  • Parameters

    • args: string

    Returns {
        format: string;
        jsonPointer: string;
        jsonataExpression: undefined;
        number: number;
    } | {
        format: string;
        jsonPointer: string;
        jsonataExpression: string;
        number?: undefined;
    }

  • This Cli core command may be invoked directly from the REPL init command or from restore command

    +

    Returns void

  • Parameters

    • args: string

    Returns {
        format: string;
        jsonPointer: string;
        jsonataExpression: undefined;
        number: number;
    } | {
        format: string;
        jsonPointer: string;
        jsonataExpression: string;
        number?: undefined;
    }

  • This Cli core command may be invoked directly from the REPL init command or from restore command

    • fromSnapshot=false, replCmdInoutStr example: -f "example/ex23.json" --tags=["PEACE"] --xf=example/myEnv.json
    • fromSnapshot=true, replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json

    Parameters

    • replCmdInputStr: string
    • fromSnapshot: boolean = false

      when set to true, template processor will treat input as a snapshot of a previous templateProcessor state

      -

    Returns Promise<any>

  • Parameters

    • directory: string = ...

    Returns Promise<"open... (type 'abort' to cancel)" | {
        error: string;
    }>

  • replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json

    +

Returns Promise<any>

  • Parameters

    • directory: string = ...

    Returns Promise<"open... (type 'abort' to cancel)" | {
        error: string;
    }>

  • replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json

    Parameters

    • replCmdInputStr: string

      the command line string that will be parsed into arguments

      -

    Returns Promise<any>

  • Parameters

    • replCmdInputStr: string

    Returns {
        --?: string[];
        _: string[];
        ctx: any;
        filepath: any;
        oneshot: any;
        options: any;
        tags: any;
    }

    • Optional --?: string[]

      If opts['--'] is true, populated with everything after the --

      +

Returns Promise<any>

Generated using TypeDoc

\ No newline at end of file +
  • ctx: any
  • filepath: any
  • oneshot: any
  • options: any
  • tags: any
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/CliCoreBase.CliCoreBase.html b/classes/CliCoreBase.CliCoreBase.html index 7bb27b57..436eb7d8 100644 --- a/classes/CliCoreBase.CliCoreBase.html +++ b/classes/CliCoreBase.CliCoreBase.html @@ -1,6 +1,6 @@ CliCoreBase | stated-js

    Base class for building CLIs. By itself can be used for a CLI that does not support the tail command. Tail command uses Node repl class that is not implemented in other JS runtimes such as Bun. CliCoreBase should run in Bun.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    currentDirectory: string
    logLevel: keyof LogLevel
    onInit: (() => void | Promise<void>)

    Type declaration

      • (): void | Promise<void>
      • Returns void | Promise<void>

    server: Server<typeof IncomingMessage, typeof ServerResponse>
    templateProcessor: default

    Methods

    • this method is just here as a stub to allow tests to pass. Color is in reality handled only by StatedRepl, +

    Constructors

    Properties

    currentDirectory: string
    logLevel: keyof LogLevel
    onInit: (() => void | Promise<void>)

    Type declaration

      • (): void | Promise<void>
      • Returns void | Promise<void>

    server: Server<typeof IncomingMessage, typeof ServerResponse>
    templateProcessor: default

    Methods

    • this method is just here as a stub to allow tests to pass. Color is in reality handled only by StatedRepl, it is not something that is possible to 'see' from the CLI since CLI returns pure JSON which has no concept of terminal colors.

      -

      Returns void

    • Parameters

      • replCmdInputStr: string

      Returns Promise<any>

    • Parameters

      • args: string

      Returns {
          format: string;
          jsonPointer: string;
          jsonataExpression: undefined;
          number: number;
      } | {
          format: string;
          jsonPointer: string;
          jsonataExpression: string;
          number?: undefined;
      }

    • This Cli core command may be invoked directly from the REPL init command or from restore command

      +

      Returns void

    • Parameters

      • replCmdInputStr: string

      Returns Promise<any>

    • Parameters

      • args: string

      Returns {
          format: string;
          jsonPointer: string;
          jsonataExpression: undefined;
          number: number;
      } | {
          format: string;
          jsonPointer: string;
          jsonataExpression: string;
          number?: undefined;
      }

    • This Cli core command may be invoked directly from the REPL init command or from restore command

      • fromSnapshot=false, replCmdInoutStr example: -f "example/ex23.json" --tags=["PEACE"] --xf=example/myEnv.json
      • fromSnapshot=true, replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json

      Parameters

      • replCmdInputStr: string
      • fromSnapshot: boolean = false

        when set to true, template processor will treat input as a snapshot of a previous templateProcessor state

        -

      Returns Promise<any>

    • Parameters

      • replCmdInputStr: string

      Returns null | object

    • Parameters

      • filepath: string
      • Optional importPath: string

      Returns Promise<any>

    • replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json

      +

    Returns Promise<any>

    • Parameters

      • replCmdInputStr: string

      Returns null | object

    • Parameters

      • filepath: string
      • Optional importPath: string

      Returns Promise<any>

    • replCmdInoutStr example: -f "example/restoreSnapshot.json" --tags=["PEACE"] --xf=example/myEnv.json

      Parameters

      • replCmdInputStr: string

        the command line string that will be parsed into arguments

        -

      Returns Promise<any>

    • Parameters

      • replCmdInputStr: string

      Returns ParsedArgs

    • Parameters

      • replCmdInputStr: string

      Returns {
          --?: string[];
          _: string[];
          ctx: any;
          filepath: any;
          oneshot: any;
          options: any;
          tags: any;
      }

      • Optional --?: string[]

        If opts['--'] is true, populated with everything after the --

        +

    Returns Promise<any>

    Generated using TypeDoc

    \ No newline at end of file +
  • ctx: any
  • filepath: any
  • oneshot: any
  • options: any
  • tags: any
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ConsoleLogger.default.html b/classes/ConsoleLogger.default.html index c66f374f..5e78000b 100644 --- a/classes/ConsoleLogger.default.html +++ b/classes/ConsoleLogger.default.html @@ -1,4 +1,4 @@ -default | stated-js

    Implements

    Constructors

    constructor +default | stated-js

    Implements

    Constructors

    Properties

    Methods

    debug error @@ -6,4 +6,4 @@ log verbose warn -

    Constructors

    Properties

    level: Levels

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    level: Levels

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/DependencyFinder.default.html b/classes/DependencyFinder.default.html index b7442e4a..0ebf87e5 100644 --- a/classes/DependencyFinder.default.html +++ b/classes/DependencyFinder.default.html @@ -1,4 +1,4 @@ -default | stated-js

    Constructors

    constructor +default | stated-js

    Constructors

    Properties

    Constructors

    Properties

    ast: ExprNode
    compiledExpression: Expression
    currentSteps: StepRecord[][]
    dependencies: string[][]
    nodeStack: GeneratedExprNode[]

    Methods

    • Parameters

      • node: GeneratedExprNode

      Returns GeneratedExprNode[]

    • Parameters

      • scopeWeExited: GeneratedExprNode

      Returns void

    • If we are looking to analyze only a portion of the jsonata program we can provide another jsonata expression +

      Parameters

      • program: string | ExprNode

      Returns default

    Properties

    ast: ExprNode
    compiledExpression: Expression
    currentSteps: StepRecord[][]
    dependencies: string[][]
    nodeStack: GeneratedExprNode[]

    Methods

    • Parameters

      • node: GeneratedExprNode

      Returns GeneratedExprNode[]

    • Parameters

      • scopeWeExited: GeneratedExprNode

      Returns void

    • If we are looking to analyze only a portion of the jsonata program we can provide another jsonata expression such as '[procedure.value='serial']' which will filter the AST down to what is defined. In the case of '[procedure.value='serial']' the expression will extract the AST for $serial(...) as it may exist in the original program.

      -

      Parameters

      • jsonatExpr: string

      Returns Promise<default>

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • jsonatExpr: string

    Returns Promise<default>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/ExecutionStatus.ExecutionStatus.html b/classes/ExecutionStatus.ExecutionStatus.html index a0dc1944..79bd714e 100644 --- a/classes/ExecutionStatus.ExecutionStatus.html +++ b/classes/ExecutionStatus.ExecutionStatus.html @@ -1,4 +1,4 @@ -ExecutionStatus | stated-js

    Constructors

    constructor +ExecutionStatus | stated-js

    Constructors

    Properties

    metaInfoByJsonPointer: MetaInfoMap
    statuses: Set<Plan>

    Methods

    • Restores ExecutionStatuses, initialize plans and executes all plans in-flight

      +

    Constructors

    Properties

    metaInfoByJsonPointer: MetaInfoMap
    statuses: Set<Plan>

    Methods

    • Restores ExecutionStatuses, initialize plans and executes all plans in-flight

      Parameters

      Returns Promise<void>

    • Reconstructs execution status and template processor internal states form an execution status snapshot

      +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +
  • obj: any
  • Returns ExecutionStatus

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/FancyLogger.default.html b/classes/FancyLogger.default.html index 1d57f383..8ab22804 100644 --- a/classes/FancyLogger.default.html +++ b/classes/FancyLogger.default.html @@ -1,3 +1,3 @@ -default | stated-js

    Constructors

    constructor +default | stated-js

    Constructors

    Methods

    Constructors

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/JsonPointer.default.html b/classes/JsonPointer.default.html index f692ab8d..41cc30ee 100644 --- a/classes/JsonPointer.default.html +++ b/classes/JsonPointer.default.html @@ -1,4 +1,4 @@ -default | stated-js

    Constructors

    constructor +default | stated-js

    Constructors

    Methods

    api compile dict @@ -15,15 +15,15 @@ Calls .get when called with an object and a pointer. Calls .set when also called with value. If only supplied object, returns a partially applied function, mapped to the object.

    -

    Parameters

    Returns any

    • Escapes a reference token

      -

      Parameters

      • str: string | number

      Returns string

    • Converts a JSON pointer into an array of reference tokens

      -

      Parameters

      • pointer: string

      Returns string[]

    • Unescapes a reference token

      -

      Parameters

      • str: string

      Returns string

    • Escapes a reference token

      +

      Parameters

      • str: string | number

      Returns string

    • Converts a JSON pointer into an array of reference tokens

      +

      Parameters

      • pointer: string

      Returns string[]

    • Unescapes a reference token

      +

      Parameters

      • str: string

      Returns string

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/LifecycleManager.LifecycleManager.html b/classes/LifecycleManager.LifecycleManager.html index 591d6bac..c455025c 100644 --- a/classes/LifecycleManager.LifecycleManager.html +++ b/classes/LifecycleManager.LifecycleManager.html @@ -1,17 +1,17 @@ LifecycleManager | stated-js

    Class for managing lifecycle callbacks.

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    lifecycleCallbacks: Map<LifecycleState, Set<LifecycleCallback>>
    templateProcessor: default

    Methods

    • Removes a specific lifecycle callback or all callbacks for a lifecycle state.

      +

    Constructors

    Properties

    lifecycleCallbacks: Map<LifecycleState, Set<LifecycleCallback>>
    templateProcessor: default

    Methods

    • Calls all lifecycle callbacks registered for a specific lifecycle state.

      +

    Returns void

    • Calls all lifecycle callbacks registered for a specific lifecycle state.

      Parameters

      Returns Promise<void>

    • Registers a lifecycle callback for a specific lifecycle state.

      +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/MetaInfoProducer.default.html b/classes/MetaInfoProducer.default.html index 94e10c51..6f273ac1 100644 --- a/classes/MetaInfoProducer.default.html +++ b/classes/MetaInfoProducer.default.html @@ -1,4 +1,4 @@ -default | stated-js

    Constructors

    constructor +default | stated-js

    Constructors

    Properties

    Methods

    Constructors

    Properties

    EMBEDDED_EXPR_REGEX: RegExp = ...

    Methods

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    EMBEDDED_EXPR_REGEX: RegExp = ...

    Methods

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/StatedREPL.default.html b/classes/StatedREPL.default.html index e6f3d008..a2839322 100644 --- a/classes/StatedREPL.default.html +++ b/classes/StatedREPL.default.html @@ -1,4 +1,4 @@ -default | stated-js

    Constructors

    constructor +default | stated-js

    Constructors

    Properties

    cliCore: default
    isColorized: boolean = false
    replServer: REPLServer
    CLICORE_COMMANDS: string[][] = ...

    Methods

    • Parameters

      • cliCoreMethodName: string
      • args: string

      Returns Promise<boolean>

    • Parameters

      • methodName: string
      • result: any

      Returns any

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    cliCore: default
    isColorized: boolean = false
    replServer: REPLServer
    CLICORE_COMMANDS: string[][] = ...

    Methods

    • Parameters

      • cliCoreMethodName: string
      • args: string

      Returns Promise<boolean>

    • Parameters

      • methodName: string
      • result: any

      Returns any

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/TemplateProcessor.default.html b/classes/TemplateProcessor.default.html index 34e5ae7a..867380a1 100644 --- a/classes/TemplateProcessor.default.html +++ b/classes/TemplateProcessor.default.html @@ -10,7 +10,7 @@

    Example: Parse template from JSON or YAML

    
     

    Example: React to changes using data change callbacks on various locations in the template

     test("test 1", async () => {
    const tp = new TemplateProcessor({
    "a": "aaa",
    "b": "${a}"
    });
    await tp.initialize();
    const received = [];
    tp.setDataChangeCallback("/a", (data, jsonPtr) => {
    received.push({data, jsonPtr})
    });
    tp.setDataChangeCallback("/b", (data, jsonPtr) => {
    received.push({data, jsonPtr})
    });
    tp.setDataChangeCallback("/", (data, jsonPtr) => {
    received.push({data, jsonPtr})
    });
    await tp.setData("/a", 42);
    expect(received).toEqual([
    {
    "data": 42,
    "jsonPtr": "/a"
    },
    {
    "data": 42,
    "jsonPtr": "/b"
    },
    {
    "data": {
    "a": 42,
    "b": 42
    },
    "jsonPtr": [
    "/a",
    "/b"
    ]
    }
    ]);
    });
    -

    Constructors

    Constructors

    Properties

    changeCallbacks context debugger @@ -113,14 +113,14 @@

    Example: React to changes using data change callbacks on various locations i fromString load simpleUniqueId -

    Constructors

    Properties

    changeCallbacks: Map<string, Set<DataChangeCallback>>

    for every json pointer, we have multiple callbacks that are stored in a Set

    -
    context: any

    Contextual data for the template processing.

    -
    debugger: any

    Debugger utility for the template processor.

    -
    errorReport: {
        [key: JsonPointerString]: any;
    } = {}

    Contains any errors encountered during template processing.

    -

    Type declaration

    executionPlans: {
        [key: JsonPointerString]: JsonPointerString[];
    } = {}

    Execution plans 'from' a given JSON Pointer. So key is JSON Pointer and value is array of JSON +

    Constructors

    Properties

    changeCallbacks: Map<string, Set<DataChangeCallback>>

    for every json pointer, we have multiple callbacks that are stored in a Set

    +
    context: any

    Contextual data for the template processing.

    +
    debugger: any

    Debugger utility for the template processor.

    +
    errorReport: {
        [key: JsonPointerString]: any;
    } = {}

    Contains any errors encountered during template processing.

    +

    Type declaration

    executionPlans: {
        [key: JsonPointerString]: JsonPointerString[];
    } = {}

    Execution plans 'from' a given JSON Pointer. So key is JSON Pointer and value is array of JSON pointers (a plan)

    -

    Type declaration

    executionQueue: (Plan | SnapshotPlan)[] = []

    A queue of execution plans awaiting processing.

    -
    executionStatus: ExecutionStatus
    functionGenerators: Map<string, FunctionGenerator>

    function generators can be provided by a caller when functions need to be +

    Type declaration

    executionQueue: (Plan | SnapshotPlan)[] = []

    A queue of execution plans awaiting processing.

    +
    executionStatus: ExecutionStatus
    functionGenerators: Map<string, FunctionGenerator>

    function generators can be provided by a caller when functions need to be created in such a way that they are somehow 'responsive' or dependent on their location inside the template. Both the generator function, and the function it generates are asynchronous functions (ie they return a promise). @@ -129,26 +129,26 @@

    Example: React to changes using data change callbacks on various locations i is actually genrated on the fly, using knowledge of the json path that it was called at, to replace the content of the template at that path with the downloaded content.

    -

    generatorManager: GeneratorManager
    input: any

    Represents the raw input for the template processor.

    -
    isClosed: boolean = false
    isInitializing: boolean

    Flag indicating if the template processor is currently initializing.

    -
    lifecycleManager: LifecycleOwner = ...
    logger: StatedLogger

    Represents the logger used within the template processor.

    -
    metaInfoByJsonPointer: MetaInfoMap = {}

    Maps JSON pointers of import paths to their associated meta information.

    -
    onInitialize: Map<string, (() => void | Promise<void>)>

    Allows caller to set a callback to propagate initialization into their framework

    +
    generatorManager: GeneratorManager
    input: any

    Represents the raw input for the template processor.

    +
    isClosed: boolean = false
    isInitializing: boolean

    Flag indicating if the template processor is currently initializing.

    +
    lifecycleManager: LifecycleOwner = ...
    logger: StatedLogger

    Represents the logger used within the template processor.

    +
    metaInfoByJsonPointer: MetaInfoMap = {}

    Maps JSON pointers of import paths to their associated meta information.

    +
    onInitialize: Map<string, (() => void | Promise<void>)>

    Allows caller to set a callback to propagate initialization into their framework

    Type declaration

      • (): void | Promise<void>
      • Returns void | Promise<void>

    Deprecated

    use lifecycleManager instead

    -
    options: any = {}

    Configuration options for the template processor.

    -
    output: {} = {}

    Contains the processed output after template processing.

    -

    Type declaration

      postInitialize: (() => Promise<void>) = ...

      Allows a caller to receive a callback after the template is evaluated, but before any temporary variables are +

      options: any = {}

      Configuration options for the template processor.

      +
      output: {} = {}

      Contains the processed output after template processing.

      +

      Type declaration

        postInitialize: (() => Promise<void>) = ...

        Allows a caller to receive a callback after the template is evaluated, but before any temporary variables are removed. This function is slated to be replaced with a map of functions like onInitialize

        Type declaration

          • (): Promise<void>
          • Allows a caller to receive a callback after the template is evaluated, but before any temporary variables are removed. This function is slated to be replaced with a map of functions like onInitialize

            Returns Promise<void>

            Deprecated

            use lifecycleManager instead

        Deprecated

        use lifecycleManager instead

        -
        tagSet: Set<string>

        A set of tags associated with the template.

        -
        tempVars: string[] = []
        templateMeta: any

        This object mirrors the template output in structure but where the output contains actual data, +

        tagSet: Set<string>

        A set of tags associated with the template.

        +
        tempVars: string[] = []
        templateMeta: any

        This object mirrors the template output in structure but where the output contains actual data, this object contains MetaInfo nodes that track metadata on the actual nodes

        -
        timerManager: TimerManager
        uniqueId: string

        A unique string identifier for the template processor instance like '3b12f1df-5232-4e1f-9c1b-3c6fc5ac7d3f'.

        -
        warnings: any[] = []

        List of warnings generated during template processing.

        -
        DEFAULT_FUNCTIONS: {
            Date: DateConstructor;
            console: Console;
            debounce: (<T>(func, wait?) => T);
            env: ((variableName, defaultValue?) => string);
            fetch: ((url, opts?) => Promise<Response>);
            rateLimit: (<T>(func, maxWait?) => T);
        } = ...

        Default set of functions provided for the template processor.

        +
        timerManager: TimerManager
        uniqueId: string

        A unique string identifier for the template processor instance like '3b12f1df-5232-4e1f-9c1b-3c6fc5ac7d3f'.

        +
        warnings: any[] = []

        List of warnings generated during template processing.

        +
        DEFAULT_FUNCTIONS: {
            Date: DateConstructor;
            console: Console;
            debounce: (<T>(func, wait?) => T);
            env: ((variableName, defaultValue?) => string);
            fetch: ((url, opts?) => Promise<Response>);
            rateLimit: (<T>(func, maxWait?) => T);
        } = ...

        Default set of functions provided for the template processor.

        Type declaration

        • Date: DateConstructor
        • console: Console
        • debounce: (<T>(func, wait?) => T)
            • <T>(func, wait?): T
            • Debounces a function, ensuring that it is only called once after a specified time has elapsed since the last call.

              Type Parameters

              • T extends AnyFunction

              Parameters

              • func: T

                The function to debounce.

                @@ -169,24 +169,24 @@

                Example: React to changes using data change callbacks on various locations i

          • rateLimit: (<T>(func, maxWait?) => T)
              • <T>(func, maxWait?): T
              • Type Parameters

                • T extends AnyFunction

                Parameters

                • func: T
                • maxWait: number = 1000

                Returns T

        Remarks

        These functions are commonly used utilities available for usage within the template processor's context. You can replace set this to determine which functions are available from templates

        -

        Static

        NOOP: symbol = ...
        _isNodeJS: boolean = ...

        Methods

        • Private

          Sometimes we need to import a simple expression string that is not nested in an object. +

          Static

        NOOP: symbol = ...
        _isNodeJS: boolean = ...

        Methods

        • Private

          Sometimes we need to import a simple expression string that is not nested in an object. for example if we {"msg":"$import('${'hello ' & to }')"), then we are importing an expression directly into the parent, not nesting in an object. In this case we must slice off the last element of the rootJsonPointer, because to not slice it off would imply that the target of the expression is inside the msg field, but the intention when we import a simple expression is target the parent object which holds the msg field.

          Parameters

          • template: any
          • rootJsonPtr: any[]

          Returns any[]

          either the original rootJsonPointer, or one that has been trimmed to point to the parent of rootJsonPtr

          -
        • Parameters

          • tagSetOnTheExpression: Set<string>

          Returns boolean

        • Parameters

          • data: any
          • jsonPointer: string | string[]
          • removed: boolean = false

          Returns Promise<void>

        • Create an initialization plan from the execution plan

          -

          Parameters

          Returns Promise<void>

        • Parameters

          • removeTmpVars: boolean = true

          Returns Promise<void>

        • This method is used to compile and evaluate function expressions and their dependencies.

          +
        • Parameters

          • tagSetOnTheExpression: Set<string>

          Returns boolean

        • Parameters

          • data: any
          • jsonPointer: string | string[]
          • removed: boolean = false

          Returns Promise<void>

        • Create an initialization plan from the execution plan

          +

          Parameters

          Returns Promise<void>

        • Parameters

          • removeTmpVars: boolean = true

          Returns Promise<void>

        • This method is used to compile and evaluate function expressions and their dependencies.

          Based on the metadata, we should identify all functions, and their dependencies

          -

          Parameters

          Returns Promise<void>

        • Parameters

          • metaInfo: any

          Returns ((jsonPointer, timeoutMs) => object)

            • (jsonPointer, timeoutMs): object
            • Parameters

              • jsonPointer: string
              • timeoutMs: number

              Returns object

        • Private

          When $forked is called, it must push the current output onto the forkStack so it can be restored on +

          Parameters

          Returns Promise<void>

        • Parameters

          • metaInfo: any

          Returns ((jsonPointer, timeoutMs) => object)

            • (jsonPointer, timeoutMs): object
            • Parameters

              • jsonPointer: string
              • timeoutMs: number

              Returns object

        • Private

          When $forked is called, it must push the current output onto the forkStack so it can be restored on $joined, and it must replace the output with a copy of the output.

          -

          Parameters

          Returns ((jsonPtr, data, op?) => Promise<void>)

            • (jsonPtr, data, op?): Promise<void>
            • Parameters

              • jsonPtr: string
              • data: any
              • op: Op = 'set'

              Returns Promise<void>

        • Private

          The $joined(/foo, data) function pops the forkstack and can return us to ordinary +

          Parameters

          Returns ((jsonPtr, data, op?) => Promise<void>)

            • (jsonPtr, data, op?): Promise<void>
            • Parameters

              • jsonPtr: string
              • data: any
              • op: Op = 'set'

              Returns Promise<void>

        • Private

          The $joined(/foo, data) function pops the forkstack and can return us to ordinary non-forked operation if the pop operation empties the fork stack

          -

          Parameters

          Returns ((jsonPtr, data, op?) => Promise<void>)

            • (jsonPtr, data, op?): Promise<void>
            • Parameters

              • jsonPtr: string
              • data: any
              • op: Op = 'set'

              Returns Promise<void>

        • Private

          The $set(/foo, data) command may be operating inside the context of a $forked. If this is the case +

          Parameters

          Returns ((jsonPtr, data, op?) => Promise<void>)

            • (jsonPtr, data, op?): Promise<void>
            • Parameters

              • jsonPtr: string
              • data: any
              • op: Op = 'set'

              Returns Promise<void>

        • Private

          The $set(/foo, data) command may be operating inside the context of a $forked. If this is the case then $setData is intercepted here and we use the setDataForked function which applies changes to forked output

          -

          Parameters

          Returns ((jsonPtr, data?, op?) => Promise<string[]>) | ((jsonPtr, data, op?) => Promise<void>)

        • Parameters

          Returns ((templateToImport) => Promise<symbol>)

            • (templateToImport): Promise<symbol>
            • Parameters

              • templateToImport: string

              Returns Promise<symbol>

        • Parameters

          • template: string | object
          • jsonPtrImportPath: string

          Returns Promise<void>

        • Template processor initialize can be called from 2 major use cases

          +

          Parameters

          Returns ((jsonPtr, data?, op?) => Promise<string[]>) | ((jsonPtr, data, op?) => Promise<void>)

        • Parameters

          Returns ((templateToImport) => Promise<symbol>)

            • (templateToImport): Promise<symbol>
            • Parameters

              • templateToImport: string

              Returns Promise<symbol>

        • Parameters

          • template: string | object
          • jsonPtrImportPath: string

          Returns Promise<void>

        • Parameters

          • exectuionStatusStr: string

          Returns Promise<void>

        • Private

          temp vars are in scope if all tags are present OR the expression's fieldname ends in !, which makes +

        • executionStatusSnapshot: undefined | {} = undefined

        Returns Promise<void>

        • Parameters

          • exectuionStatusStr: string

          Returns Promise<void>

        • Private

          temp vars are in scope if all tags are present OR the expression's fieldname ends in !, which makes it an absolutely temporary variable since.

          -

          Parameters

          Returns boolean

        • Parameters

          • tmpVars: string[]
          • jsonPtrOfTemplate: string

          Returns void

        • Parameters

          • literalTemplateToImport: any
          • metaInfo: MetaInfo

          Returns Promise<void>

        • Sets or deletes data based on the specified operation.

          +

          Parameters

          Returns boolean

        • Parameters

          • tmpVars: string[]
          • jsonPtrOfTemplate: string

          Returns void

        • Parameters

          • literalTemplateToImport: any
          • metaInfo: MetaInfo

          Returns Promise<void>

        • Sets or deletes data based on the specified operation.

          Parameters

          • jsonPtr: string

            The JSON pointer indicating where to apply the operation.

          • Optional data: any = null

            The data to be used with the set or setDeferred operation.

          • Optional op: Op = "set"

            The operation to perform - setDeferred is for internal use

          Returns Promise<string[]>

          A promise with the list of json pointers touched by the plan

          -

          Async

        • Sets a data change callback function that will be called whenever the value at the json pointer has changed

          +

          Async

        • Sets a data change callback function that will be called whenever the value at the json pointer has changed

          Parameters

          • jsonPtr: string
          • cbFn: DataChangeCallback

            of form (data, ptr:JsonPointerString, removed?:boolean)=>void

            -

          Returns void

        • Calling setDataForked allows the mutation and its reaction (fromPlan) to begin executing immediately without +

        Returns void

        • Calling setDataForked allows the mutation and its reaction (fromPlan) to begin executing immediately without queuing/seriealizing/blocking on other plans. This is possible because a forked planStep contains a write-safe copy of this.output (essentially a 'snapshot' in MVCC terminology) and therefore the mutation and propagation of the fromPlan are isolated, just like snapshot isolation levels on Postres or other MVCC databases. So, do not await this method. Just let 'er rip.

          -

          Parameters

          Returns Promise<string[]>

        • allows direct injection of ${expression} into template at given jsonPointer.

          -

          Parameters

          • expression: string
          • jsonPointer: string

          Returns Promise<void>

        • Creates a stringified snapshot of the current state of the TemplateProcessor instance, +

          Parameters

          Returns Promise<string[]>

        • allows direct injection of ${expression} into template at given jsonPointer.

          +

          Parameters

          • expression: string
          • jsonPointer: string

          Returns Promise<void>

        • Creates a stringified snapshot of the current state of the TemplateProcessor instance, including its execution status, input, output, and options.

          Returns Promise<string>

          A JSON string representing the snapshot of the TemplateProcessor's current state, including template input, processed output, and options.

          Example

          const tp = new TemplateProcessor(template, context, options);
          const snapshotString = await tp.snapshot();
          // snapshotString contains a JSON string with the execution plans, mvcc, template, output, and options of the
          TemplateProcessor
          -
        • Parameters

          • metaInfos: MetaInfo[]
          • exprsOnly: boolean = true
          • fanout: boolean = true

          Returns string[]

        • Type Parameters

          • T extends any[]

          Parameters

          • fn: ((...args) => any)
              • (...args): any
              • Parameters

                • Rest ...args: T

                Returns any

          Returns ((...args) => any)

            • (...args): any
            • Parameters

              • Rest ...args: T

              Returns any

        • Parameters

          • jsonataLambda: any

          Returns {
              _stated_function__: boolean;
              apply(_this, args): any;
              (...args): any;
          }

            • (...args): any
            • Parameters

              • Rest ...args: any[]

              Returns any

          • _stated_function__: boolean
          • apply:function
        • Constructs a new TemplateProcessor instance from a given snapshot object, but does NOT initialize it. +

        • Parameters

          • metaInfos: MetaInfo[]
          • exprsOnly: boolean = true
          • fanout: boolean = true

          Returns string[]

        • Type Parameters

          • T extends any[]

          Parameters

          • fn: ((...args) => any)
              • (...args): any
              • Parameters

                • Rest ...args: T

                Returns any

          Returns ((...args) => any)

            • (...args): any
            • Parameters

              • Rest ...args: T

              Returns any

        • Parameters

          • jsonataLambda: any

          Returns {
              _stated_function__: boolean;
              apply(_this, args): any;
              (...args): any;
          }

            • (...args): any
            • Parameters

              • Rest ...args: any[]

              Returns any

          • _stated_function__: boolean
          • apply:function
        • Constructs a new TemplateProcessor instance from a given snapshot object, but does NOT initialize it. This method allows the caller the opportunity to register dataChangeCallbacks and so forth before template evaluation begins, providing more control over the initialization process.

          Parameters

          • snapshot: Snapshot

            A snapshot object containing template, options, and output data for initializing the TemplateProcessor.

            @@ -223,10 +223,10 @@

            Static

          Returns default

          A new TemplateProcessor instance constructed from the snapshot data, not yet initialized.

          Example

          const snapshot = {"template":"...", "options":{}, "output":"..."};
          const tp = TemplateProcessor.constructFromSnapshot(snapshot);
          // Register callbacks or perform other setup operations here
          await tp.initialize();
          -
          • this function is used to make a deep copy of the output so that when we $fork we are operating +

          • this function is used to make a deep copy of the output so that when we $fork we are operating on a copy of the output, not co-mutating the original

            -

            Parameters

            • output: object

            Returns any

          • Loads a template and initializes a new template processor instance.

            +

            Parameters

            • output: object

            Returns any

          • Loads a template and initializes a new template processor instance.

            Parameters

            • template: object

              The template data to be processed.

            • Optional context: {} = {}

              Optional context data for the template.

              Returns Promise<default>

              Returns an initialized instance of TemplateProcessor.

              -

              Static

            Generated using TypeDoc

            \ No newline at end of file +

            Static

            Generated using TypeDoc

            \ No newline at end of file diff --git a/classes/TimerManager.TimerManager.html b/classes/TimerManager.TimerManager.html index 2036abf3..487050f9 100644 --- a/classes/TimerManager.TimerManager.html +++ b/classes/TimerManager.TimerManager.html @@ -1,4 +1,4 @@ -TimerManager | stated-js

            Constructors

            constructor +TimerManager | stated-js

            Constructors

            Properties

            intervals: Set<Timeout>
            jsonPointerByInterval: Map<Timeout, string>
            timeouts: Set<Timeout>

            Methods

            • Parameters

              Returns ((interval) => Promise<void>)

                • (interval): Promise<void>
                • Parameters

                  • interval: Timeout

                  Returns Promise<void>

            • Parameters

              Returns ((callback, delay, ...args) => Timeout)

                • (callback, delay, ...args): Timeout
                • Parameters

                  • callback: ((...args) => void)
                      • (...args): void
                      • Parameters

                        • Rest ...args: any[]

                        Returns void

                  • delay: number
                  • Rest ...args: any[]

                  Returns Timeout

            • Parameters

              • callback: ((...args) => void)
                  • (...args): void
                  • Parameters

                    • Rest ...args: any[]

                    Returns void

              • delay: number
              • Rest ...args: any[]

              Returns Timeout

            • Parameters

              • callback: ((...args) => void)
                  • (...args): void
                  • Parameters

                    • Rest ...args: any[]

                    Returns void

              • delay: number
              • Rest ...args: any[]

              Returns Timeout

            Generated using TypeDoc

            \ No newline at end of file +

            Constructors

            Properties

            intervals: Set<Timeout>
            jsonPointerByInterval: Map<Timeout, string>
            timeouts: Set<Timeout>

            Methods

            • Parameters

              Returns ((interval) => Promise<void>)

                • (interval): Promise<void>
                • Parameters

                  • interval: Timeout

                  Returns Promise<void>

            • Parameters

              Returns ((callback, delay, ...args) => Timeout)

                • (callback, delay, ...args): Timeout
                • Parameters

                  • callback: ((...args) => void)
                      • (...args): void
                      • Parameters

                        • Rest ...args: any[]

                        Returns void

                  • delay: number
                  • Rest ...args: any[]

                  Returns Timeout

            • Parameters

              • callback: ((...args) => void)
                  • (...args): void
                  • Parameters

                    • Rest ...args: any[]

                    Returns void

              • delay: number
              • Rest ...args: any[]

              Returns Timeout

            • Parameters

              • callback: ((...args) => void)
                  • (...args): void
                  • Parameters

                    • Rest ...args: any[]

                    Returns void

              • delay: number
              • Rest ...args: any[]

              Returns Timeout

            Generated using TypeDoc

            \ No newline at end of file diff --git a/classes/VizGraph.default.html b/classes/VizGraph.default.html index a621f140..f1f3b46e 100644 --- a/classes/VizGraph.default.html +++ b/classes/VizGraph.default.html @@ -1,4 +1,4 @@ -default | stated-js

            Constructors

            constructor +default | stated-js

            Constructors

            Methods

            • Parameters

              • str: string

              Returns string

            Generated using TypeDoc

            \ No newline at end of file +

            Constructors

            Methods

            • Parameters

              • str: string

              Returns string

            Generated using TypeDoc

            \ No newline at end of file diff --git a/enums/Lifecycle.LifecycleState.html b/enums/Lifecycle.LifecycleState.html index 6dbb23a2..aacc4a8d 100644 --- a/enums/Lifecycle.LifecycleState.html +++ b/enums/Lifecycle.LifecycleState.html @@ -1,13 +1,13 @@ LifecycleState | stated-js

            Enumeration LifecycleState

            Enum representing the various states of the lifecycle. This is used to track different phases during the operation of the system.

            -

            Enumeration Members

            Enumeration Members

            Closed: "Closed"

            The state when the system has fully closed and is no longer operational.

            -
            Initialized: "Initialized"

            The state when the system has been fully initialized and is ready for use.

            -
            PreTmpVarRemoval: "PreTmpVarRemoval"

            The state before temporary variables are removed from the system.

            -
            StartClose: "StartClose"

            The state when the process to close the system begins.

            -
            StartInitialize: "StartInitialize"

            The state representing the start of the initialization process.

            -

            Generated using TypeDoc

            \ No newline at end of file +
            Initialized: "Initialized"

            The state when the system has been fully initialized and is ready for use.

            +
            PreTmpVarRemoval: "PreTmpVarRemoval"

            The state before temporary variables are removed from the system.

            +
            StartClose: "StartClose"

            The state when the process to close the system begins.

            +
            StartInitialize: "StartInitialize"

            The state representing the start of the initialization process.

            +

            Generated using TypeDoc

            \ No newline at end of file diff --git a/functions/TestUtils.parseMarkdownAndTestCodeblocks.html b/functions/TestUtils.parseMarkdownAndTestCodeblocks.html index 23540beb..4b51782a 100644 --- a/functions/TestUtils.parseMarkdownAndTestCodeblocks.html +++ b/functions/TestUtils.parseMarkdownAndTestCodeblocks.html @@ -1 +1 @@ -parseMarkdownAndTestCodeblocks | stated-js

            Function parseMarkdownAndTestCodeblocks

            • Parameters

              • md: string
              • cliCore: default
              • printFunction: ((k, v) => any) = stringifyTemplateJSON
                  • (k, v): any
                  • Parameters

                    • k: any
                    • v: any

                    Returns any

              Returns Promise<void>

            Generated using TypeDoc

            \ No newline at end of file +parseMarkdownAndTestCodeblocks | stated-js

            Function parseMarkdownAndTestCodeblocks

            • Parameters

              • md: string
              • cliCore: default
              • printFunction: ((k, v) => any) = stringifyTemplateJSON
                  • (k, v): any
                  • Parameters

                    • k: any
                    • v: any

                    Returns any

              Returns Promise<void>

            Generated using TypeDoc

            \ No newline at end of file diff --git a/functions/TestUtils.parseMarkdownTests.html b/functions/TestUtils.parseMarkdownTests.html index 8d4940a6..eb068c0c 100644 --- a/functions/TestUtils.parseMarkdownTests.html +++ b/functions/TestUtils.parseMarkdownTests.html @@ -2,4 +2,4 @@

            Parameters

            Returns CommandAndResponse[]

            Array of test data including commands and expected responses.

            -

            Generated using TypeDoc

            \ No newline at end of file +

            Generated using TypeDoc

            \ No newline at end of file diff --git a/functions/index.stringifyTemplateJSON.html b/functions/index.stringifyTemplateJSON.html index aae347dc..b3a4284b 100644 --- a/functions/index.stringifyTemplateJSON.html +++ b/functions/index.stringifyTemplateJSON.html @@ -1 +1 @@ -stringifyTemplateJSON | stated-js

            Function stringifyTemplateJSON

            • Parameters

              • o: any
              • printFunction: ((key, value) => any) = circularReplacer
                  • (key, value): any
                  • Parameters

                    • key: any
                    • value: any

                    Returns any

              Returns string

            Generated using TypeDoc

            \ No newline at end of file +stringifyTemplateJSON | stated-js

            Function stringifyTemplateJSON

            • Parameters

              • o: any
              • printFunction: ((key, value) => any) = circularReplacer
                  • (key, value): any
                  • Parameters

                    • key: any
                    • value: any

                    Returns any

              Returns string

            Generated using TypeDoc

            \ No newline at end of file diff --git a/interfaces/ConsoleLogger.StatedLogger.html b/interfaces/ConsoleLogger.StatedLogger.html index 99a9df30..c4a56bf2 100644 --- a/interfaces/ConsoleLogger.StatedLogger.html +++ b/interfaces/ConsoleLogger.StatedLogger.html @@ -1,8 +1,8 @@ -StatedLogger | stated-js
            interface StatedLogger {
                level: Levels;
                debug(...args): void;
                error(...args): void;
                info(...args): void;
                log(level, ...args): void;
                verbose(...args): void;
                warn(...args): void;
            }

            Implemented by

            Properties

            level +StatedLogger | stated-js
            interface StatedLogger {
                level: Levels;
                debug(...args): void;
                error(...args): void;
                info(...args): void;
                log(level, ...args): void;
                verbose(...args): void;
                warn(...args): void;
            }

            Implemented by

            Properties

            Methods

            Properties

            level: Levels

            Methods

            Generated using TypeDoc

            \ No newline at end of file +

            Properties

            level: Levels

            Methods

            Generated using TypeDoc

            \ No newline at end of file diff --git a/interfaces/Lifecycle.LifecycleOwner.html b/interfaces/Lifecycle.LifecycleOwner.html index 7e4280bd..2ca7cc23 100644 --- a/interfaces/Lifecycle.LifecycleOwner.html +++ b/interfaces/Lifecycle.LifecycleOwner.html @@ -1,10 +1,10 @@ LifecycleOwner | stated-js

            Interface LifecycleOwner

            Interface for managing lifecycle callbacks.

            -
            interface LifecycleOwner {
                removeLifecycleCallback(state, cbFn?): void;
                setLifecycleCallback(state, cbFn): void;
            }

            Implemented by

            Methods

            interface LifecycleOwner {
                removeLifecycleCallback(state, cbFn?): void;
                setLifecycleCallback(state, cbFn): void;
            }

            Implemented by

            Methods

            • Removes a specific lifecycle callback or all callbacks for a lifecycle state.

              Parameters

              • state: LifecycleState

                The lifecycle state to remove the callback from.

              • Optional cbFn: LifecycleCallback

                The specific callback function to remove. If not provided, all callbacks for the state will be removed.

                -

              Returns void

            • Registers a lifecycle callback for a specific lifecycle state.

              +

            Returns void

            • Registers a lifecycle callback for a specific lifecycle state.

              Parameters

              • state: LifecycleState

                The lifecycle state to register the callback for.

              • cbFn: LifecycleCallback

                The callback function to execute when the lifecycle state is triggered.

                -

              Returns void

            Generated using TypeDoc

            \ No newline at end of file +

            Returns void

            Generated using TypeDoc

            \ No newline at end of file diff --git a/interfaces/MetaInfoProducer.MetaInfo.html b/interfaces/MetaInfoProducer.MetaInfo.html index f0b8c53b..10041c88 100644 --- a/interfaces/MetaInfoProducer.MetaInfo.html +++ b/interfaces/MetaInfoProducer.MetaInfo.html @@ -1,4 +1,4 @@ -MetaInfo | stated-js
            interface MetaInfo {
                absoluteDependencies__: string[] | JsonPointerStructureArray[];
                compiledExpr__?: Expression;
                data__?: any;
                dependees__: string[] | JsonPointerStructureArray[];
                dependencies__: string[] | JsonPointerStructureArray[];
                exprRootPath__?: string;
                exprTargetJsonPointer__?: string | JsonPointerStructureArray;
                expr__?: string;
                isFunction__?: boolean;
                jsonPointer__: string | JsonPointerStructureArray;
                materialized__: boolean;
                parent__: string | JsonPointerStructureArray;
                tags__: Set<string>;
                temp__?: boolean;
                treeHasExpressions__: boolean;
            }

            Properties

            absoluteDependencies__ +MetaInfo | stated-js
            interface MetaInfo {
                absoluteDependencies__: string[] | JsonPointerStructureArray[];
                compiledExpr__?: Expression;
                data__?: any;
                dependees__: string[] | JsonPointerStructureArray[];
                dependencies__: string[] | JsonPointerStructureArray[];
                exprRootPath__?: string;
                exprTargetJsonPointer__?: string | JsonPointerStructureArray;
                expr__?: string;
                isFunction__?: boolean;
                jsonPointer__: string | JsonPointerStructureArray;
                materialized__: boolean;
                parent__: string | JsonPointerStructureArray;
                tags__: Set<string>;
                temp__?: boolean;
                treeHasExpressions__: boolean;
            }

            Properties

            absoluteDependencies__: string[] | JsonPointerStructureArray[]
            compiledExpr__?: Expression
            data__?: any
            dependees__: string[] | JsonPointerStructureArray[]
            dependencies__: string[] | JsonPointerStructureArray[]
            exprRootPath__?: string
            exprTargetJsonPointer__?: string | JsonPointerStructureArray
            expr__?: string
            isFunction__?: boolean
            jsonPointer__: string | JsonPointerStructureArray
            materialized__: boolean
            parent__: string | JsonPointerStructureArray
            tags__: Set<string>
            temp__?: boolean
            treeHasExpressions__: boolean

            Generated using TypeDoc

            \ No newline at end of file +

            Properties

            absoluteDependencies__: string[] | JsonPointerStructureArray[]
            compiledExpr__?: Expression
            data__?: any
            dependees__: string[] | JsonPointerStructureArray[]
            dependencies__: string[] | JsonPointerStructureArray[]
            exprRootPath__?: string
            exprTargetJsonPointer__?: string | JsonPointerStructureArray
            expr__?: string
            isFunction__?: boolean
            jsonPointer__: string | JsonPointerStructureArray
            materialized__: boolean
            parent__: string | JsonPointerStructureArray
            tags__: Set<string>
            temp__?: boolean
            treeHasExpressions__: boolean

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/CliCore.html b/modules/CliCore.html index 16741ad4..55b54d7b 100644 --- a/modules/CliCore.html +++ b/modules/CliCore.html @@ -1,2 +1,2 @@ -CliCore | stated-js

            Module CliCore

            Index

            Classes

            default +CliCore | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/CliCoreBase.html b/modules/CliCoreBase.html index 5869c433..4206da57 100644 --- a/modules/CliCoreBase.html +++ b/modules/CliCoreBase.html @@ -1,2 +1,2 @@ -CliCoreBase | stated-js

            Module CliCoreBase

            Index

            Classes

            CliCoreBase +CliCoreBase | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/ConsoleLogger.html b/modules/ConsoleLogger.html index dc3476f9..0f4bf5cf 100644 --- a/modules/ConsoleLogger.html +++ b/modules/ConsoleLogger.html @@ -1,4 +1,4 @@ -ConsoleLogger | stated-js

            Module ConsoleLogger

            Index

            Classes

            default +ConsoleLogger | stated-js

            Module ConsoleLogger

            Index

            Classes

            Interfaces

            Type Aliases

            Levels LogLevel diff --git a/modules/DependencyFinder.html b/modules/DependencyFinder.html index eae90d8d..e827a13a 100644 --- a/modules/DependencyFinder.html +++ b/modules/DependencyFinder.html @@ -1,2 +1,2 @@ -DependencyFinder | stated-js

            Module DependencyFinder

            Index

            Classes

            default +DependencyFinder | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/ExecutionStatus.html b/modules/ExecutionStatus.html index a575198c..d3b6f108 100644 --- a/modules/ExecutionStatus.html +++ b/modules/ExecutionStatus.html @@ -1,2 +1,2 @@ -ExecutionStatus | stated-js

            Module ExecutionStatus

            Index

            Classes

            ExecutionStatus +ExecutionStatus | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/FancyLogger.html b/modules/FancyLogger.html index 7aceba66..62da3c58 100644 --- a/modules/FancyLogger.html +++ b/modules/FancyLogger.html @@ -1,2 +1,2 @@ -FancyLogger | stated-js

            Module FancyLogger

            Index

            Classes

            default +FancyLogger | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/JsonPointer.html b/modules/JsonPointer.html index 8b78bc67..15c07574 100644 --- a/modules/JsonPointer.html +++ b/modules/JsonPointer.html @@ -1,4 +1,4 @@ -JsonPointer | stated-js

            Module JsonPointer

            Index

            Classes

            default +JsonPointer | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/Lifecycle.html b/modules/Lifecycle.html index 3871bc34..8f21d284 100644 --- a/modules/Lifecycle.html +++ b/modules/Lifecycle.html @@ -1,4 +1,4 @@ -Lifecycle | stated-js

            Module Lifecycle

            Index

            Enumerations

            LifecycleState +Lifecycle | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/LifecycleManager.html b/modules/LifecycleManager.html index 50cd60ba..c3b1ae40 100644 --- a/modules/LifecycleManager.html +++ b/modules/LifecycleManager.html @@ -1,2 +1,2 @@ -LifecycleManager | stated-js

            Module LifecycleManager

            Index

            Classes

            LifecycleManager +LifecycleManager | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/MetaInfoProducer.html b/modules/MetaInfoProducer.html index 405fdb89..b0aea77d 100644 --- a/modules/MetaInfoProducer.html +++ b/modules/MetaInfoProducer.html @@ -1,4 +1,4 @@ -MetaInfoProducer | stated-js

            Module MetaInfoProducer

            Index

            Classes

            default +MetaInfoProducer | stated-js

            Module MetaInfoProducer

            Index

            Classes

            Interfaces

            Type Aliases

            JsonPointerString JsonPointerStructureArray diff --git a/modules/StatedREPL.html b/modules/StatedREPL.html index ed326c3e..a72539fc 100644 --- a/modules/StatedREPL.html +++ b/modules/StatedREPL.html @@ -1,2 +1,2 @@ -StatedREPL | stated-js

            Module StatedREPL

            Index

            Classes

            default +StatedREPL | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/TemplateProcessor.html b/modules/TemplateProcessor.html index 10686149..67644552 100644 --- a/modules/TemplateProcessor.html +++ b/modules/TemplateProcessor.html @@ -1,4 +1,4 @@ -TemplateProcessor | stated-js

            Module TemplateProcessor

            Index

            Classes

            default +TemplateProcessor | stated-js

            Module TemplateProcessor

            Index

            Classes

            Type Aliases

            DataChangeCallback Fork FunctionGenerator diff --git a/modules/TestUtils.html b/modules/TestUtils.html index 12178db6..5cfa967c 100644 --- a/modules/TestUtils.html +++ b/modules/TestUtils.html @@ -1,4 +1,4 @@ -TestUtils | stated-js

            Module TestUtils

            Index

            Type Aliases

            CommandAndResponse +TestUtils | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/TimerManager.html b/modules/TimerManager.html index b2a72a82..8dd9dfcb 100644 --- a/modules/TimerManager.html +++ b/modules/TimerManager.html @@ -1,2 +1,2 @@ -TimerManager | stated-js

            Module TimerManager

            Index

            Classes

            TimerManager +TimerManager | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/VizGraph.html b/modules/VizGraph.html index 92d32c26..59c77660 100644 --- a/modules/VizGraph.html +++ b/modules/VizGraph.html @@ -1,2 +1,2 @@ -VizGraph | stated-js

            Module VizGraph

            Index

            Classes

            default +VizGraph | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/modules/index.html b/modules/index.html index 3fc6a8b3..4e6b65f2 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | stated-js

            Module index

            References

            CliCoreBase +index | stated-js

            Module index

            References

            CliCoreBase DataChangeCallback Fork FunctionGenerator diff --git a/types/ConsoleLogger.Levels.html b/types/ConsoleLogger.Levels.html index 5f38a09f..82739b6e 100644 --- a/types/ConsoleLogger.Levels.html +++ b/types/ConsoleLogger.Levels.html @@ -1 +1 @@ -Levels | stated-js
            Levels: "silent" | "error" | "warn" | "info" | "verbose" | "debug"

            Generated using TypeDoc

            \ No newline at end of file +Levels | stated-js
            Levels: "silent" | "error" | "warn" | "info" | "verbose" | "debug"

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/ConsoleLogger.LogLevel.html b/types/ConsoleLogger.LogLevel.html index ee149793..d96768c6 100644 --- a/types/ConsoleLogger.LogLevel.html +++ b/types/ConsoleLogger.LogLevel.html @@ -1 +1 @@ -LogLevel | stated-js
            LogLevel: {
                debug: number;
                error: number;
                info: number;
                silent: number;
                verbose: number;
                warn: number;
            }

            Type declaration

            • debug: number
            • error: number
            • info: number
            • silent: number
            • verbose: number
            • warn: number

            Generated using TypeDoc

            \ No newline at end of file +LogLevel | stated-js
            LogLevel: {
                debug: number;
                error: number;
                info: number;
                silent: number;
                verbose: number;
                warn: number;
            }

            Type declaration

            • debug: number
            • error: number
            • info: number
            • silent: number
            • verbose: number
            • warn: number

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/JsonPointer.DescentCallback.html b/types/JsonPointer.DescentCallback.html index 365bbfea..31e1342b 100644 --- a/types/JsonPointer.DescentCallback.html +++ b/types/JsonPointer.DescentCallback.html @@ -1 +1 @@ -DescentCallback | stated-js

            Type alias DescentCallback

            DescentCallback: ((value, jsonPointer) => boolean)

            Type declaration

              • (value, jsonPointer): boolean
              • Parameters

                Returns boolean

            Generated using TypeDoc

            \ No newline at end of file +DescentCallback | stated-js

            Type alias DescentCallback

            DescentCallback: ((value, jsonPointer) => boolean)

            Type declaration

              • (value, jsonPointer): boolean
              • Parameters

                Returns boolean

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/JsonPointer.DescentIterator.html b/types/JsonPointer.DescentIterator.html index ea9a21b3..bbb8d1c1 100644 --- a/types/JsonPointer.DescentIterator.html +++ b/types/JsonPointer.DescentIterator.html @@ -1 +1 @@ -DescentIterator | stated-js

            Type alias DescentIterator

            DescentIterator: ((value, localFieldName) => void)

            Type declaration

              • (value, localFieldName): void
              • Parameters

                • value: any
                • localFieldName: string

                Returns void

            Generated using TypeDoc

            \ No newline at end of file +DescentIterator | stated-js

            Type alias DescentIterator

            DescentIterator: ((value, localFieldName) => void)

            Type declaration

              • (value, localFieldName): void
              • Parameters

                • value: any
                • localFieldName: string

                Returns void

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/Lifecycle.LifecycleCallback.html b/types/Lifecycle.LifecycleCallback.html index 9f3ac436..3babe006 100644 --- a/types/Lifecycle.LifecycleCallback.html +++ b/types/Lifecycle.LifecycleCallback.html @@ -5,4 +5,4 @@

            Type declaration

              • (state, templateProcessor): Promise<void>
              • Parameters

                • state: LifecycleState

                  The new lifecycle state that the system has transitioned to.

                • templateProcessor: default

                  The TemplateProcessor instance to be used for handling the state transition.

                Returns Promise<void>

            Returns

            A Promise<void> indicating the asynchronous operation is complete.

            -

            Generated using TypeDoc

            \ No newline at end of file +

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/MetaInfoProducer.JsonPointerString.html b/types/MetaInfoProducer.JsonPointerString.html index efed83bd..080ece2e 100644 --- a/types/MetaInfoProducer.JsonPointerString.html +++ b/types/MetaInfoProducer.JsonPointerString.html @@ -1 +1 @@ -JsonPointerString | stated-js

            Generated using TypeDoc

            \ No newline at end of file +JsonPointerString | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/MetaInfoProducer.JsonPointerStructureArray.html b/types/MetaInfoProducer.JsonPointerStructureArray.html index 4ccb1f5d..7fa19e48 100644 --- a/types/MetaInfoProducer.JsonPointerStructureArray.html +++ b/types/MetaInfoProducer.JsonPointerStructureArray.html @@ -1 +1 @@ -JsonPointerStructureArray | stated-js

            Generated using TypeDoc

            \ No newline at end of file +JsonPointerStructureArray | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.DataChangeCallback.html b/types/TemplateProcessor.DataChangeCallback.html index d6ee72f5..7f26091f 100644 --- a/types/TemplateProcessor.DataChangeCallback.html +++ b/types/TemplateProcessor.DataChangeCallback.html @@ -1,2 +1,2 @@ DataChangeCallback | stated-js
            DataChangeCallback: ((data, ptr, removed?) => void)

            defines the function signature for data change callbacks, called when data at the ptr changes

            -

            Type declaration

              • (data, ptr, removed?): void
              • Parameters

                Returns void

            Generated using TypeDoc

            \ No newline at end of file +

            Type declaration

              • (data, ptr, removed?): void
              • Parameters

                Returns void

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.Fork.html b/types/TemplateProcessor.Fork.html index 684cab39..c3a4224b 100644 --- a/types/TemplateProcessor.Fork.html +++ b/types/TemplateProcessor.Fork.html @@ -1 +1 @@ -Fork | stated-js
            Fork: {
                forkId: string;
                output: object;
            }

            Type declaration

            • forkId: string
            • output: object

            Generated using TypeDoc

            \ No newline at end of file +Fork | stated-js
            Fork: {
                forkId: string;
                output: object;
            }

            Type declaration

            • forkId: string
            • output: object

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.FunctionGenerator.html b/types/TemplateProcessor.FunctionGenerator.html index 23f8af9c..a15a9253 100644 --- a/types/TemplateProcessor.FunctionGenerator.html +++ b/types/TemplateProcessor.FunctionGenerator.html @@ -1,3 +1,3 @@ FunctionGenerator | stated-js
            FunctionGenerator: ((metaInfo, templateProcessor) => Promise<((arg) => Promise<any>)>)

            a FunctionGenerator is used to generate functions that need the context of which expression they were called from which is made available to them in the MetaInf

            -

            Type declaration

              • (metaInfo, templateProcessor): Promise<((arg) => Promise<any>)>
              • Parameters

                Returns Promise<((arg) => Promise<any>)>

            Generated using TypeDoc

            \ No newline at end of file +

            Type declaration

              • (metaInfo, templateProcessor): Promise<((arg) => Promise<any>)>
              • Parameters

                Returns Promise<((arg) => Promise<any>)>

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.MetaInfoMap.html b/types/TemplateProcessor.MetaInfoMap.html index 5b721dd0..9ebd59ff 100644 --- a/types/TemplateProcessor.MetaInfoMap.html +++ b/types/TemplateProcessor.MetaInfoMap.html @@ -1 +1 @@ -MetaInfoMap | stated-js

            Generated using TypeDoc

            \ No newline at end of file +MetaInfoMap | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.Op.html b/types/TemplateProcessor.Op.html index ad9a6b35..7db2f729 100644 --- a/types/TemplateProcessor.Op.html +++ b/types/TemplateProcessor.Op.html @@ -1 +1 @@ -Op | stated-js

            Generated using TypeDoc

            \ No newline at end of file +Op | stated-js

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.Plan.html b/types/TemplateProcessor.Plan.html index 9c7e554c..4af6c48f 100644 --- a/types/TemplateProcessor.Plan.html +++ b/types/TemplateProcessor.Plan.html @@ -1 +1 @@ -Plan | stated-js
            Plan: {
                data?: any;
                didUpdate: boolean[];
                forkId: string;
                forkStack: Fork[];
                lastCompletedStep?: PlanStep;
                op?: Op;
                output: object;
                restoreJsonPtrs: JsonPointerString[];
                sortedJsonPtrs: JsonPointerString[];
            }

            Type declaration

            Generated using TypeDoc

            \ No newline at end of file +Plan | stated-js
            Plan: {
                data?: any;
                didUpdate: boolean[];
                forkId: string;
                forkStack: Fork[];
                lastCompletedStep?: PlanStep;
                op?: Op;
                output: object;
                restoreJsonPtrs: JsonPointerString[];
                sortedJsonPtrs: JsonPointerString[];
            }

            Type declaration

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.PlanStep.html b/types/TemplateProcessor.PlanStep.html index 48447e9c..a27a9bfa 100644 --- a/types/TemplateProcessor.PlanStep.html +++ b/types/TemplateProcessor.PlanStep.html @@ -1 +1 @@ -PlanStep | stated-js
            PlanStep: {
                data?: any;
                didUpdate: boolean;
                forkId: string;
                forkStack: Fork[];
                jsonPtr: JsonPointerString;
                op?: Op;
                output: object;
            }

            Type declaration

            • Optional data?: any
            • didUpdate: boolean
            • forkId: string
            • forkStack: Fork[]
            • jsonPtr: JsonPointerString
            • Optional op?: Op
            • output: object

            Generated using TypeDoc

            \ No newline at end of file +PlanStep | stated-js
            PlanStep: {
                data?: any;
                didUpdate: boolean;
                forkId: string;
                forkStack: Fork[];
                jsonPtr: JsonPointerString;
                op?: Op;
                output: object;
            }

            Type declaration

            • Optional data?: any
            • didUpdate: boolean
            • forkId: string
            • forkStack: Fork[]
            • jsonPtr: JsonPointerString
            • Optional op?: Op
            • output: object

            Generated using TypeDoc

            \ No newline at end of file diff --git a/types/TemplateProcessor.Snapshot.html b/types/TemplateProcessor.Snapshot.html index 51a24318..36a54b68 100644 --- a/types/TemplateProcessor.Snapshot.html +++ b/types/TemplateProcessor.Snapshot.html @@ -1 +1 @@ -Snapshot | stated-js
            Snapshot: {
                metaInfoByJsonPointer: any;
                mvcc: any;
                options: {};
                output: any;
                plans: any;
                template: object;
            }

            Type declaration

            • metaInfoByJsonPointer: any
            • mvcc: any
            • options: {}
              • output: any
              • plans: any
              • template: object

              Generated using TypeDoc

              \ No newline at end of file +Snapshot | stated-js
              Snapshot: {
                  metaInfoByJsonPointer: any;
                  mvcc: any;
                  options: {};
                  output: any;
                  plans: any;
                  template: object;
              }

              Type declaration

              • metaInfoByJsonPointer: any
              • mvcc: any
              • options: {}
                • output: any
                • plans: any
                • template: object

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/TemplateProcessor.StatedError.html b/types/TemplateProcessor.StatedError.html index 94305151..df3c5cb4 100644 --- a/types/TemplateProcessor.StatedError.html +++ b/types/TemplateProcessor.StatedError.html @@ -1 +1 @@ -StatedError | stated-js
                StatedError: {
                    error: {
                        message: string;
                        name?: string;
                        stack?: string | null;
                    };
                }

                Type declaration

                • error: {
                      message: string;
                      name?: string;
                      stack?: string | null;
                  }
                  • message: string
                  • Optional name?: string
                  • Optional stack?: string | null

                Generated using TypeDoc

                \ No newline at end of file +StatedError | stated-js
                StatedError: {
                    error: {
                        message: string;
                        name?: string;
                        stack?: string | null;
                    };
                }

                Type declaration

                • error: {
                      message: string;
                      name?: string;
                      stack?: string | null;
                  }
                  • message: string
                  • Optional name?: string
                  • Optional stack?: string | null

                Generated using TypeDoc

                \ No newline at end of file diff --git a/types/TestUtils.CommandAndResponse.html b/types/TestUtils.CommandAndResponse.html index 63a13c19..1de0f071 100644 --- a/types/TestUtils.CommandAndResponse.html +++ b/types/TestUtils.CommandAndResponse.html @@ -1 +1 @@ -CommandAndResponse | stated-js

                Type alias CommandAndResponse

                CommandAndResponse: {
                    args: string[];
                    cmdName: string;
                    expectedResponse: string;
                    jsonataExpr: string;
                }

                Type declaration

                • args: string[]
                • cmdName: string
                • expectedResponse: string
                • jsonataExpr: string

                Generated using TypeDoc

                \ No newline at end of file +CommandAndResponse | stated-js

                Type alias CommandAndResponse

                CommandAndResponse: {
                    args: string[];
                    cmdName: string;
                    expectedResponse: string;
                    jsonataExpr: string;
                }

                Type declaration

                • args: string[]
                • cmdName: string
                • expectedResponse: string
                • jsonataExpr: string

                Generated using TypeDoc

                \ No newline at end of file diff --git a/variables/ConsoleLogger.LOG_LEVELS.html b/variables/ConsoleLogger.LOG_LEVELS.html index 0257f81a..845241fb 100644 --- a/variables/ConsoleLogger.LOG_LEVELS.html +++ b/variables/ConsoleLogger.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | stated-js

                Generated using TypeDoc

                \ No newline at end of file +LOG_LEVELS | stated-js

                Generated using TypeDoc

                \ No newline at end of file