@genesislcap/foundation-state-machine 14.70.0

package/docs/api/foundation-state-machine.machine.start.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [Machine](./foundation-state-machine.machine.md) &gt; [start](./foundation-state-machine.machine.start.md)
+
+## Machine.start() method
+
+Start the machine.
+
+**Signature:**
+
+```typescript
+start(options?: InterpreterOptions<StateMachine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta>>): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | InterpreterOptions&lt;StateMachine&lt;TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta&gt;&gt; | _(Optional)_ Optional InterpreterOptions. Can be used to restore to a previously persisted state. |
+
+**Returns:**
+
+any
+
+## Remarks
+
+Called to ready the machine and create the internal actor (interpreter). This is called internally after `createMachine` by convention, however it should also be called after calling [provide](./foundation-state-machine.machine.provide.md) when overriding logic. Calling `start` on an injected machine allows you to restart/reuse it if needed. This is okay for machines registered as `transient` in the DI, but care should be taken when creating a machine registered as a `singleton`<!-- -->. You may need to check the status of the machine and block re-starts.
+

package/docs/api/foundation-state-machine.machine.startingcontext.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [Machine](./foundation-state-machine.machine.md) &gt; [startingContext](./foundation-state-machine.machine.startingcontext.md)
+
+## Machine.startingContext property
+
+The `context` of the machine when started.
+
+**Signature:**
+
+```typescript
+readonly startingContext: Partial<TContext>;
+```

package/docs/api/foundation-state-machine.machine.startingstate.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [Machine](./foundation-state-machine.machine.md) &gt; [startingState](./foundation-state-machine.machine.startingstate.md)
+
+## Machine.startingState property
+
+The `state` of the machine when started. Allows consumers to start a machine from a persisted state.
+
+**Signature:**
+
+```typescript
+readonly startingState: StateValue;
+```

package/docs/api/foundation-state-machine.machine.state.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [Machine](./foundation-state-machine.machine.md) &gt; [state](./foundation-state-machine.machine.state.md)
+
+## Machine.state property
+
+The current `state` of the machine itself. This is not to be confused with state in the data or store sense.
+
+**Signature:**
+
+```typescript
+readonly state: StateValue;
+```

package/docs/api/foundation-state-machine.machine.stop.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [Machine](./foundation-state-machine.machine.md) &gt; [stop](./foundation-state-machine.machine.stop.md)
+
+## Machine.stop() method
+
+Stop the machine.
+
+**Signature:**
+
+```typescript
+stop(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-state-machine.machinecontext.error.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [MachineContext](./foundation-state-machine.machinecontext.md) &gt; [error](./foundation-state-machine.machinecontext.error.md)
+
+## MachineContext.error property
+
+A general machine error. Maybe equal to `errors.lastError`<!-- -->.
+
+**Signature:**
+
+```typescript
+readonly error: any;
+```

package/docs/api/foundation-state-machine.machinecontext.errors.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [MachineContext](./foundation-state-machine.machinecontext.md) &gt; [errors](./foundation-state-machine.machinecontext.errors.md)
+
+## MachineContext.errors property
+
+A `ErrorMap` of errors that may have occurred during the machine's workflows.
+
+**Signature:**
+
+```typescript
+readonly errors: ErrorMap<ErrorDetailMap>;
+```

package/docs/api/foundation-state-machine.machinecontext.md

@@ -0,0 +1,36 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [MachineContext](./foundation-state-machine.machinecontext.md)
+
+## MachineContext interface
+
+MachineContext interface.
+
+**Signature:**
+
+```typescript
+export interface MachineContext extends XMachineContext 
+```
+**Extends:** XMachineContext
+
+## Remarks
+
+The interface of our xstate based machine contexts that include `error` and `errors` properties. Should be extended.
+
+## Example
+
+Creating a machine context.
+
+```ts
+export interface MyMachineContext extends MachineContext {
+  ...
+};
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [error](./foundation-state-machine.machinecontext.error.md) | <code>readonly</code> | any | A general machine error. Maybe equal to <code>errors.lastError</code>. |
+|  [errors](./foundation-state-machine.machinecontext.errors.md) | <code>readonly</code> | ErrorMap&lt;ErrorDetailMap&gt; | A <code>ErrorMap</code> of errors that may have occurred during the machine's workflows. |
+

package/docs/api/foundation-state-machine.mappingerror._constructor_.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [MappingError](./foundation-state-machine.mappingerror.md) &gt; [(constructor)](./foundation-state-machine.mappingerror._constructor_.md)
+
+## MappingError.(constructor)
+
+Constructs a new instance of the `MappingError` class
+
+**Signature:**
+
+```typescript
+constructor(dto?: unknown, message?: string);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  dto | unknown | _(Optional)_ |
+|  message | string | _(Optional)_ |
+

package/docs/api/foundation-state-machine.mappingerror.dto.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [MappingError](./foundation-state-machine.mappingerror.md) &gt; [dto](./foundation-state-machine.mappingerror.dto.md)
+
+## MappingError.dto property
+
+**Signature:**
+
+```typescript
+dto?: unknown;
+```

package/docs/api/foundation-state-machine.mappingerror.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [MappingError](./foundation-state-machine.mappingerror.md)
+
+## MappingError class
+
+MappingError.
+
+**Signature:**
+
+```typescript
+export declare class MappingError extends Error 
+```
+**Extends:** Error
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(dto, message)](./foundation-state-machine.mappingerror._constructor_.md) |  | Constructs a new instance of the <code>MappingError</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [dto?](./foundation-state-machine.mappingerror.dto.md) |  | unknown | _(Optional)_ |
+

package/docs/api/foundation-state-machine.md

@@ -0,0 +1,81 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md)
+
+## foundation-state-machine package
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [APIError](./foundation-state-machine.apierror.md) | APIError. |
+|  [DefaultFetchMachine](./foundation-state-machine.defaultfetchmachine.md) | Default FetchMachine. |
+|  [GenesisServerError](./foundation-state-machine.genesisservererror.md) | GenesisServerError. |
+|  [MappingError](./foundation-state-machine.mappingerror.md) | MappingError. |
+|  [NetworkError](./foundation-state-machine.networkerror.md) | NetworkError. |
+
+## Abstract Classes
+
+|  Abstract Class | Description |
+|  --- | --- |
+|  [AbstractMachine](./foundation-state-machine.abstractmachine.md) | AbstractMachine base class. |
+
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [assertEvent(event, type)](./foundation-state-machine.assertevent.md) | assertEvent. |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [FetchConfig](./foundation-state-machine.fetchconfig.md) | FetchConfig interface. |
+|  [FetchMachine](./foundation-state-machine.fetchmachine.md) | FetchMachine interface. |
+|  [FetchMachineContext](./foundation-state-machine.fetchmachinecontext.md) | FetchMachineContext interface. |
+|  [Machine](./foundation-state-machine.machine.md) | Machine interface. |
+|  [MachineContext](./foundation-state-machine.machinecontext.md) | MachineContext interface. |
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [createErrorStateNode](./foundation-state-machine.createerrorstatenode.md) | Creates an error state node. |
+|  [createFetchPolicy](./foundation-state-machine.createfetchpolicy.md) | A fetch policy factory. |
+|  [createResponseDataExtractorWithDeserializer](./foundation-state-machine.createresponsedataextractorwithdeserializer.md) | Creates an extractor that applies a deserializer to the extracted response data. |
+|  [defaultFetchConfig](./foundation-state-machine.defaultfetchconfig.md) | The default fetch config. |
+|  [defaultFetchMachineContext](./foundation-state-machine.defaultfetchmachinecontext.md) | Default FetchMachineContext. |
+|  [defaultFetchPolicy](./foundation-state-machine.defaultfetchpolicy.md) | The default fetch policy. |
+|  [defaultResponseDataExtractor](./foundation-state-machine.defaultresponsedataextractor.md) | ResponseDataExtractor type. |
+|  [defaultResponseOkChecker](./foundation-state-machine.defaultresponseokchecker.md) | ResponseOkChecker type. |
+|  [defaultRetryStatsCodes](./foundation-state-machine.defaultretrystatscodes.md) | Default retry stats codes. |
+|  [errorWorkflowInput](./foundation-state-machine.errorworkflowinput.md) | Error workflow input. |
+|  [escalateError](./foundation-state-machine.escalateerror.md) | Escalate error action. |
+|  [isAbortError](./foundation-state-machine.isaborterror.md) | isAbortError. |
+|  [isActorErrorEvent](./foundation-state-machine.isactorerrorevent.md) | isActorErrorEvent. |
+|  [isAPIError](./foundation-state-machine.isapierror.md) |  |
+|  [isDoneInvokeEvent](./foundation-state-machine.isdoneinvokeevent.md) | isDoneInvokeEvent. |
+|  [isErrorCustomEvent](./foundation-state-machine.iserrorcustomevent.md) | isErrorCustomEvent. |
+|  [isErrorEvent](./foundation-state-machine.iserrorevent.md) | isErrorEvent. |
+|  [isErrorType](./foundation-state-machine.iserrortype.md) | isErrorType. |
+|  [isGenesisServerError](./foundation-state-machine.isgenesisservererror.md) |  |
+|  [isMappingError](./foundation-state-machine.ismappingerror.md) |  |
+|  [isNetworkError](./foundation-state-machine.isnetworkerror.md) |  |
+|  [isNotFoundError](./foundation-state-machine.isnotfounderror.md) |  |
+|  [isSyntaxError](./foundation-state-machine.issyntaxerror.md) | isSyntaxError. |
+|  [isTypeError](./foundation-state-machine.istypeerror.md) | isTypeError. |
+|  [logger](./foundation-state-machine.logger.md) |  |
+|  [setError](./foundation-state-machine.seterror.md) | Set error action. |
+|  [setErrorByKey](./foundation-state-machine.seterrorbykey.md) | Set error by key action. |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [ErrorWorkflowInput](./foundation-state-machine.errorworkflowinput.md) | ErrorWorkflowInput type. |
+|  [FetchMachineEvent](./foundation-state-machine.fetchmachineevent.md) | FetchMachineEvent type. |
+|  [FetchMachineEventMap](./foundation-state-machine.fetchmachineeventmap.md) | FetchMachineEventMap type. |
+|  [FetchMachineOutput](./foundation-state-machine.fetchmachineoutput.md) | FetchMachineOutput type. |
+|  [ResponseDataExtractor](./foundation-state-machine.responsedataextractor.md) | ResponseDataExtractor type. |
+|  [ResponseOkChecker](./foundation-state-machine.responseokchecker.md) | ResponseOkChecker type. |
+

package/docs/api/foundation-state-machine.networkerror._constructor_.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [NetworkError](./foundation-state-machine.networkerror.md) &gt; [(constructor)](./foundation-state-machine.networkerror._constructor_.md)
+
+## NetworkError.(constructor)
+
+Constructs a new instance of the `NetworkError` class
+
+**Signature:**
+
+```typescript
+constructor(url: string, message?: string);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  url | string |  |
+|  message | string | _(Optional)_ |
+

package/docs/api/foundation-state-machine.networkerror.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [NetworkError](./foundation-state-machine.networkerror.md)
+
+## NetworkError class
+
+NetworkError.
+
+**Signature:**
+
+```typescript
+export declare class NetworkError extends Error 
+```
+**Extends:** Error
+
+## Remarks
+
+Failed to reach server.
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(url, message)](./foundation-state-machine.networkerror._constructor_.md) |  | Constructs a new instance of the <code>NetworkError</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [url](./foundation-state-machine.networkerror.url.md) |  | string |  |
+

package/docs/api/foundation-state-machine.networkerror.url.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [NetworkError](./foundation-state-machine.networkerror.md) &gt; [url](./foundation-state-machine.networkerror.url.md)
+
+## NetworkError.url property
+
+**Signature:**
+
+```typescript
+url: string;
+```

package/docs/api/foundation-state-machine.responsedataextractor.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [ResponseDataExtractor](./foundation-state-machine.responsedataextractor.md)
+
+## ResponseDataExtractor type
+
+ResponseDataExtractor type.
+
+**Signature:**
+
+```typescript
+export type ResponseDataExtractor<TData = any> = (response: Response) => Promise<TData>;
+```
+
+## Remarks
+
+Extracts data from the  and processes it accordingly. The default data extractor will inspect `content-type` and call `JSON.parse()` if it includes `application/json`<!-- -->. Custom data extractors can be used here.
+

package/docs/api/foundation-state-machine.responseokchecker.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [ResponseOkChecker](./foundation-state-machine.responseokchecker.md)
+
+## ResponseOkChecker type
+
+ResponseOkChecker type.
+
+**Signature:**
+
+```typescript
+export type ResponseOkChecker = (response: Response) => boolean;
+```

package/docs/api/foundation-state-machine.seterror.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [setError](./foundation-state-machine.seterror.md)
+
+## setError variable
+
+Set error action.
+
+**Signature:**
+
+```typescript
+setError: {
+    (_: import("xstate").ActionArgs<import("xstate").MachineContext, import("xstate").EventObject, import("xstate").ParameterizedObject>): void;
+    type: string;
+    assignment: import("xstate").Assigner<import("xstate").MachineContext, import("xstate").EventObject> | import("xstate").PropertyAssigner<import("xstate").MachineContext, import("xstate").EventObject>;
+    resolve: (actorContext: import("xstate").AnyActorContext, state: import("xstate").AnyState, actionArgs: import("xstate").ActionArgs<any, any, import("xstate").ParameterizedObject>, { assignment }: {
+        assignment: import("xstate").Assigner<any, any> | import("xstate").PropertyAssigner<any, any>;
+    }) => import("xstate").AnyState[];
+}
+```
+
+## Remarks
+
+Used to set a top level error on the machine. This may equal to  `lastError` in the `errors` property.
+

package/docs/api/foundation-state-machine.seterrorbykey.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-state-machine](./foundation-state-machine.md) &gt; [setErrorByKey](./foundation-state-machine.seterrorbykey.md)
+
+## setErrorByKey variable
+
+Set error by key action.
+
+**Signature:**
+
+```typescript
+setErrorByKey: (key: string) => {
+    (_: import("xstate").ActionArgs<import("xstate").MachineContext, import("xstate").EventObject, import("xstate").ParameterizedObject>): void;
+    type: string;
+    assignment: import("xstate").Assigner<import("xstate").MachineContext, import("xstate").EventObject> | import("xstate").PropertyAssigner<import("xstate").MachineContext, import("xstate").EventObject>;
+    resolve: (actorContext: import("xstate").AnyActorContext, state: import("xstate").AnyState, actionArgs: import("xstate").ActionArgs<any, any, import("xstate").ParameterizedObject>, { assignment }: {
+        assignment: import("xstate").Assigner<any, any> | import("xstate").PropertyAssigner<any, any>;
+    }) => import("xstate").AnyState[];
+}
+```
+
+## Remarks
+
+Used to set an error in the  by key.
+

package/docs/api/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [@genesislcap/foundation-state-machine](./foundation-state-machine.md) |  |
+