@genesislcap/foundation-state-machine 14.408.0 → 14.409.0

package/README.md

@@ -1,45 +1,25 @@
-# Foundation State Machine
+# @genesislcap/foundation-state-machine
 
-[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
-[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
-
-State machines in `foundation-ui` are built upon the [xState](https://github.com/statelyai/xstate) v5+ library and provide bindable properties and other hooks. `foundation-state-machine` provides a collection of pre-built state machines and utilities to build your own machines.
-
-For details on how machines work see the API Docs and the v5+ version of the [xstate docs](https://stately.ai/docs/xstate-v5). 
-
-### Pre-built state machines
-
-Overtime this package will provide a number of pre-built machines that offer common functionality. Visit their README files and API Docs for more information.
-
-* [FetchMachine](./src/machines/fetch/README.md)
-* ...
-
-Domain focused machines like `AuthMachine` will live in different packages.
+Documentation for this package is published on the Genesis docs site:
 
+**Docs: [State management](https://docs.genesis.global/docs/develop/client-capabilities/state-management/)**
 
 ## Installation
 
-To enable this module in your application, follow the steps below.
-
-1. Add `@genesislcap/foundation-state-machine` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 
 ```json
 {
-  ...
   "dependencies": {
-    ...
     "@genesislcap/foundation-state-machine": "latest"
-    ...
-  },
-  ...
+  }
 }
 ```
 
-## [API Docs](./docs/api/index.md)
-
 ## License
 
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 
 ### Licensed components
+
 Genesis low-code platform

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-state-machine",
   "description": "Genesis Foundation State Machine",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -54,18 +54,18 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.408.0",
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0"
+    "@genesislcap/foundation-testing": "14.409.0",
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.408.0",
-    "@genesislcap/foundation-logger": "14.408.0",
-    "@genesislcap/foundation-utils": "14.408.0",
+    "@genesislcap/foundation-comms": "14.409.0",
+    "@genesislcap/foundation-logger": "14.409.0",
+    "@genesislcap/foundation-utils": "14.409.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.50.0",
     "cockatiel": "^3.1.1",
@@ -80,5 +80,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

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

@@ -1,18 +0,0 @@
-<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [actor](./foundation-state-machine.abstractmachine.actor.md)
-
-## AbstractMachine.actor property
-
-Optional actor
-
-**Signature:**
-
-```typescript
-actor: InterpreterFrom<StateMachine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta>>;
-```
-
-## Remarks
-
-Callers can decide to reuse/reference if set or create their own.
-

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

@@ -1,102 +0,0 @@
-<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [binding](./foundation-state-machine.abstractmachine.binding.md)
-
-## AbstractMachine.binding() method
-
-An api to allow the observation of values and arbitrary bindings outside the template engine.
-
-**Signature:**
-
-```typescript
-binding<TReturn = any, TParent = any>(token: ((target: this) => TReturn) | keyof this, subscriberChangeCallback?: SubscriberChangeCallback<TReturn> | undefined, isVolatileBinding?: boolean, context?: ExecutionContext): BindingObserver<this, TReturn, TParent>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-token
-
-
-</td><td>
-
-((target: this) =&gt; TReturn) \| keyof this
-
-
-</td><td>
-
-A target lookup token which can take various forms.
-
-
-</td></tr>
-<tr><td>
-
-subscriberChangeCallback
-
-
-</td><td>
-
-SubscriberChangeCallback&lt;TReturn&gt; \| undefined
-
-
-</td><td>
-
-_(Optional)_ .
-
-
-</td></tr>
-<tr><td>
-
-isVolatileBinding
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Indicates the binding is volatile.
-
-
-</td></tr>
-<tr><td>
-
-context
-
-
-</td><td>
-
-ExecutionContext
-
-
-</td><td>
-
-_(Optional)_ .
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-BindingObserver&lt;this, TReturn, TParent&gt;
-

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

@@ -1,13 +0,0 @@
-<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [complete](./foundation-state-machine.abstractmachine.complete.md)
-
-## AbstractMachine.complete property
-
-Indicates if the machine has completed the happy path.
-
-**Signature:**
-
-```typescript
-complete: boolean;
-```

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

@@ -1,13 +0,0 @@
-<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [context](./foundation-state-machine.abstractmachine.context.md)
-
-## AbstractMachine.context property
-
-The current `context` of the machine. The data points in context may be considered transient in nature.
-
-**Signature:**
-
-```typescript
-context: Partial<TContext>;
-```

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

@@ -1,13 +0,0 @@
-<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [error](./foundation-state-machine.abstractmachine.error.md)
-
-## AbstractMachine.error property
-
-A general machine error. Likely equal to `errors.lastError`<!-- -->.
-
-**Signature:**
-
-```typescript
-error: any;
-```

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

@@ -1,13 +0,0 @@
-<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [errors](./foundation-state-machine.abstractmachine.errors.md)
-
-## AbstractMachine.errors property
-
-An  of errors that may have occurred during the machine's workflows.
-
-**Signature:**
-
-```typescript
-errors: ErrorMap<ErrorDetailMap>;
-```

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

@@ -1,23 +0,0 @@
-<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [getFromContainer](./foundation-state-machine.abstractmachine.getfromcontainer.md)
-
-## AbstractMachine.getFromContainer() method
-
-Gets the machine from the container.
-
-**Signature:**
-
-```typescript
-abstract getFromContainer(): this;
-```
-**Returns:**
-
-this
-
-## Remarks
-
-Calling `getFromContainer` on an injected machine will return a new instance providing it was registered with the DI as `transient`<!-- -->. This is simply a convenience method, and may be useful as some machines contain 'final' states, meaning once they complete they can no longer receive events. However, if you want to continue to work with your injected machine reference, re-calling [start](./foundation-state-machine.machine.start.md) may also be a viable option.
-
-Please note that machines are injected into other machines to form parts of complex workflows. In such cases, the parent machine will `invoke` or `spawn` the injected machine's `logic` directly to always create a new actor.
-

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

@@ -1,58 +0,0 @@
-<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [getMetaValuesByKey](./foundation-state-machine.abstractmachine.getmetavaluesbykey.md)
-
-## AbstractMachine.getMetaValuesByKey() method
-
-Get `meta` values by key.
-
-**Signature:**
-
-```typescript
-getMetaValuesByKey<T = string>(key?: string): T[];
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-key
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ A key within the `meta` object. Defaults to `content`<!-- -->.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-T\[\]
-
-## Remarks
-
-Meta is cumulative across all state nodes represented by the state value.
-

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

@@ -1,58 +0,0 @@
-<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [hasTag](./foundation-state-machine.abstractmachine.hastag.md)
-
-## AbstractMachine.hasTag() method
-
-Check `tags` contain provided tag.
-
-**Signature:**
-
-```typescript
-hasTag(tag: string): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-tag
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-A tag.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-
-## Remarks
-
-This differs from `matches`<!-- -->, as multiple states may use common tags such as `pending` to indicate some async work is occurring. As with `matches`<!-- -->, `hasTag` can be useful if you need to conditionally run logic or render markup.
-

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

@@ -1,18 +0,0 @@
-<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [machine](./foundation-state-machine.abstractmachine.machine.md)
-
-## AbstractMachine.machine property
-
-Mandatory machine property.
-
-**Signature:**
-
-```typescript
-machine: StateMachine<TContext, TEvent, TAction, TActor, TInput, TResolvedTypesMeta>;
-```
-
-## Remarks
-
-The logic / config that goes into a machine is not accessible from the outside, and is owned by the implementing class. However, consumers of that may provide custom `implementations` in the xstate sense via the `provide()` api.
-

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

@@ -1,58 +0,0 @@
-<!-- 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; [AbstractMachine](./foundation-state-machine.abstractmachine.md) &gt; [matches](./foundation-state-machine.abstractmachine.matches.md)
-
-## AbstractMachine.matches() method
-
-Check `state` matches provided value.
-
-**Signature:**
-
-```typescript
-matches(value: StateValueFrom<typeof this.machine>): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-value
-
-
-</td><td>
-
-StateValueFrom&lt;typeof [this.machine](./foundation-state-machine.abstractmachine.machine.md)<!-- -->&gt;
-
-
-</td><td>
-
-A state value.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-
-## Remarks
-
-Can be useful if you need to conditionally run logic or render markup.
-