@genesislcap/foundation-state-machine 14.95.0 → 14.96.0

package/dist/foundation-state-machine.api.json

@@ -732,6 +732,75 @@
               "isAbstract": true,
               "name": "getFromContainer"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-state-machine!AbstractMachine#getMetaValuesByKey:member(1)",
+              "docComment": "/**\n * Get `meta` values by key.\n *\n * @remarks\n *\n * Meta is cumulative across all state nodes represented by the state value.\n *\n * @param key - A key within the `meta` object. Defaults to `content`.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getMetaValuesByKey<T = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">(key?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "T[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "typeParameters": [
+                {
+                  "typeParameterName": "T",
+                  "constraintTokenRange": {
+                    "startIndex": 0,
+                    "endIndex": 0
+                  },
+                  "defaultTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "key",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getMetaValuesByKey"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-state-machine!AbstractMachine#hasTag:member(1)",
@@ -877,6 +946,41 @@
               "isAbstract": false,
               "name": "matches"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-state-machine!AbstractMachine#meta:member",
+              "docComment": "/**\n * The `meta` from the current `state`.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "meta: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Record",
+                  "canonicalReference": "!Record:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string, any>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "meta",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-state-machine!AbstractMachine#onSendEvent:member",
@@ -1047,6 +1151,41 @@
               "isAbstract": false,
               "name": "send"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-state-machine!AbstractMachine#snapshot:member",
+              "docComment": "/**\n * The last `snapshot` from the actor.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "snapshot: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "State",
+                  "canonicalReference": "xstate!State:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<TContext, TEvent, TActor, TResolvedTypesMeta>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "snapshot",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-state-machine!AbstractMachine#start:member(1)",
@@ -1364,6 +1503,37 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-state-machine!APIError#isUnauthorized:member(1)",
+              "docComment": "/**\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "isUnauthorized(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "isUnauthorized"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-state-machine!APIError#status:member",
@@ -2158,7 +2328,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-state-machine!escalateError:var",
-          "docComment": "/**\n * Escalate error action.\n *\n * @remarks\n *\n * Guard this call with a parent check to avoid warnings when there's no parent.\n *\n * @public\n */\n",
+          "docComment": "/**\n * Escalate context error action.\n *\n * @remarks\n *\n * Guard this call with a parent check to avoid warnings when there's no parent.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -3418,7 +3588,21 @@
             },
             {
               "kind": "Content",
-              "text": "(error: unknown) => boolean"
+              "text": "(error: unknown) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "error",
+              "canonicalReference": "@genesislcap/foundation-state-machine!~error"
+            },
+            {
+              "kind": "Content",
+              "text": " is "
+            },
+            {
+              "kind": "Reference",
+              "text": "APIError",
+              "canonicalReference": "@genesislcap/foundation-state-machine!APIError:class"
             }
           ],
           "fileUrlPath": "src/machines/fetch/errors.ts",
@@ -3427,7 +3611,7 @@
           "name": "isAPIError",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 2
+            "endIndex": 5
           }
         },
         {
@@ -3639,6 +3823,52 @@
             "endIndex": 4
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-state-machine!isEventWithParams:var",
+          "docComment": "/**\n * isEventWithParams.\n *\n * @param event - An event.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "isEventWithParams: "
+            },
+            {
+              "kind": "Content",
+              "text": "(event: "
+            },
+            {
+              "kind": "Reference",
+              "text": "AnyEventObject",
+              "canonicalReference": "xstate!AnyEventObject:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Reference",
+              "text": "event",
+              "canonicalReference": "@genesislcap/foundation-state-machine!~event"
+            },
+            {
+              "kind": "Content",
+              "text": " is "
+            },
+            {
+              "kind": "Reference",
+              "text": "ParameterizedObject",
+              "canonicalReference": "xstate!ParameterizedObject:interface"
+            }
+          ],
+          "fileUrlPath": "src/core/guards.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "isEventWithParams",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 7
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-state-machine!isGenesisServerError:var",
@@ -3650,7 +3880,21 @@
             },
             {
               "kind": "Content",
-              "text": "(error: unknown) => boolean"
+              "text": "(error: unknown) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "error",
+              "canonicalReference": "@genesislcap/foundation-state-machine!~error"
+            },
+            {
+              "kind": "Content",
+              "text": " is "
+            },
+            {
+              "kind": "Reference",
+              "text": "GenesisServerError",
+              "canonicalReference": "@genesislcap/foundation-state-machine!GenesisServerError:class"
             }
           ],
           "fileUrlPath": "src/core/errors.ts",
@@ -3659,7 +3903,7 @@
           "name": "isGenesisServerError",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 2
+            "endIndex": 5
           }
         },
         {
@@ -3673,7 +3917,21 @@
             },
             {
               "kind": "Content",
-              "text": "(error: unknown) => boolean"
+              "text": "(error: unknown) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "error",
+              "canonicalReference": "@genesislcap/foundation-state-machine!~error"
+            },
+            {
+              "kind": "Content",
+              "text": " is "
+            },
+            {
+              "kind": "Reference",
+              "text": "MappingError",
+              "canonicalReference": "@genesislcap/foundation-state-machine!MappingError:class"
             }
           ],
           "fileUrlPath": "src/core/errors.ts",
@@ -3682,7 +3940,7 @@
           "name": "isMappingError",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 2
+            "endIndex": 5
           }
         },
         {
@@ -3696,7 +3954,21 @@
             },
             {
               "kind": "Content",
-              "text": "(error: unknown) => boolean"
+              "text": "(error: unknown) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "error",
+              "canonicalReference": "@genesislcap/foundation-state-machine!~error"
+            },
+            {
+              "kind": "Content",
+              "text": " is "
+            },
+            {
+              "kind": "Reference",
+              "text": "NetworkError",
+              "canonicalReference": "@genesislcap/foundation-state-machine!NetworkError:class"
             }
           ],
           "fileUrlPath": "src/machines/fetch/errors.ts",
@@ -3705,7 +3977,7 @@
           "name": "isNetworkError",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 2
+            "endIndex": 5
           }
         },
         {
@@ -3719,7 +3991,21 @@
             },
             {
               "kind": "Content",
-              "text": "(error: {\n    status?: number;\n}) => boolean"
+              "text": "(error: {\n    status?: number;\n}) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "error",
+              "canonicalReference": "@genesislcap/foundation-state-machine!~error"
+            },
+            {
+              "kind": "Content",
+              "text": " is "
+            },
+            {
+              "kind": "Reference",
+              "text": "APIError",
+              "canonicalReference": "@genesislcap/foundation-state-machine!APIError:class"
             }
           ],
           "fileUrlPath": "src/machines/fetch/errors.ts",
@@ -3728,7 +4014,7 @@
           "name": "isNotFoundError",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 2
+            "endIndex": 5
           }
         },
         {
@@ -3777,6 +4063,43 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-state-machine!isUnauthorizedError:var",
+          "docComment": "/**\n * @param error - An error.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "isUnauthorizedError: "
+            },
+            {
+              "kind": "Content",
+              "text": "(error: {\n    status?: number;\n}) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "error",
+              "canonicalReference": "@genesislcap/foundation-state-machine!~error"
+            },
+            {
+              "kind": "Content",
+              "text": " is "
+            },
+            {
+              "kind": "Reference",
+              "text": "APIError",
+              "canonicalReference": "@genesislcap/foundation-state-machine!APIError:class"
+            }
+          ],
+          "fileUrlPath": "src/machines/fetch/errors.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "isUnauthorizedError",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-state-machine!logger:var",
@@ -4330,6 +4653,72 @@
               "parameters": [],
               "name": "getFromContainer"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-state-machine!Machine#getMetaValuesByKey:member(1)",
+              "docComment": "/**\n * Get `meta` values by key.\n *\n * @remarks\n *\n * Meta is cumulative across all state nodes represented by the state value.\n *\n * @param key - A key within the `meta` object. Defaults to `content`.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getMetaValuesByKey<T = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">(key?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "T[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "key",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                }
+              ],
+              "typeParameters": [
+                {
+                  "typeParameterName": "T",
+                  "constraintTokenRange": {
+                    "startIndex": 0,
+                    "endIndex": 0
+                  },
+                  "defaultTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                }
+              ],
+              "name": "getMetaValuesByKey"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-state-machine!Machine#hasTag:member(1)",
@@ -4466,6 +4855,38 @@
               ],
               "name": "matches"
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-state-machine!Machine#meta:member",
+              "docComment": "/**\n * The `meta` from the current `state`.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly meta: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Record",
+                  "canonicalReference": "!Record:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string, any>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "meta",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-state-machine!Machine#onSendEvent:member(1)",
@@ -4638,6 +5059,38 @@
               ],
               "name": "send"
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-state-machine!Machine#snapshot:member",
+              "docComment": "/**\n * The last `snapshot` from the actor.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly snapshot: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "State",
+                  "canonicalReference": "xstate!State:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<TContext, TEvent, TActor, TResolvedTypesMeta>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "snapshot",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-state-machine!Machine#start:member(1)",