@genesislcap/foundation-auth 14.71.1-auth-mf.3 → 14.71.1-auth-mf.6

package/dist/foundation-auth.api.json

@@ -198,35 +198,115 @@
           "preserveMemberOrder": false,
           "members": [
             {
-              "kind": "Property",
-              "canonicalReference": "@genesislcap/foundation-auth!Auth#store:member",
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-auth!Auth#loginWithCookies:member(1)",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "store: "
+                  "text": "loginWithCookies(): "
                 },
                 {
-                  "kind": "Reference",
-                  "text": "AuthStore",
-                  "canonicalReference": "@genesislcap/foundation-auth!AuthStore:interface"
+                  "kind": "Content",
+                  "text": "void"
                 },
                 {
                   "kind": "Content",
                   "text": ";"
                 }
               ],
-              "isReadonly": false,
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
               "isOptional": false,
+              "isAbstract": false,
+              "name": "loginWithCookies"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-auth!Auth#loginWithCredentials:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "loginWithCredentials(credentials: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AuthInfo",
+                  "canonicalReference": "@genesislcap/foundation-comms!AuthInfo:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
               "releaseTag": "Public",
-              "name": "store",
-              "propertyTypeTokenRange": {
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "credentials",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "loginWithCredentials"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-auth!Auth#logout:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "logout(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
               },
-              "isStatic": false,
+              "releaseTag": "Public",
               "isProtected": false,
-              "isAbstract": false
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "logout"
             }
           ],
           "extendsTokenRange": {
@@ -927,7 +1007,7 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    'auth-login-refresh': void;\n    'auth-login-details': void;\n    'auth-logout': void;\n}"
+              "text": ";\n    'auth-login-details': void;\n    'auth-logout': void;\n}"
             },
             {
               "kind": "Content",
@@ -953,7 +1033,7 @@
             },
             {
               "kind": "Content",
-              "text": "{\n    'auth-organisation-changed': string;\n    'auth-username-changed': string;\n    'auth-email-changed': string;\n    'auth-password-changed': string;\n    'auth-password2-changed': string;\n    'auth-showPasswords-changed': boolean;\n}"
+              "text": "{\n    'auth-autofill-form': void;\n    'auth-organisation-changed': string;\n    'auth-username-changed': string;\n    'auth-email-changed': string;\n    'auth-password-changed': string;\n    'auth-password2-changed': string;\n    'auth-showPasswords-changed': boolean;\n}"
             },
             {
               "kind": "Content",
@@ -1186,6 +1266,56 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-auth!AuthFormEntryStore#onAutofillForm:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onAutofillForm(event: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CustomEvent",
+                  "canonicalReference": "!CustomEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 4,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "event",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 3
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "onAutofillForm"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-auth!AuthFormEntryStore#onEmailChanged:member(1)",
@@ -1912,7 +2042,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@genesislcap/foundation-auth!AuthMachineContext#authDTO:member",
-              "docComment": "/**\n * The login/login/refresh DTO from the fetch machine.\n */\n",
+              "docComment": "/**\n * The login/login DTO from the fetch machine.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1940,7 +2070,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@genesislcap/foundation-auth!AuthMachineContext#authEntity:member",
-              "docComment": "/**\n * The login/login/refresh Entity mapped from the DTO.\n */\n",
+              "docComment": "/**\n * The login/login Entity mapped from the DTO.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1968,7 +2098,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@genesislcap/foundation-auth!AuthMachineContext#credentials:member",
-              "docComment": "/**\n * The authentication credentials.\n *\n * @remarks\n *\n * These are optional as it may be possible to reauthenticate using a refresh token.\n */\n",
+              "docComment": "/**\n * The authentication credentials.\n *\n * @remarks\n *\n * Optional as it's possible to reauthenticate silently.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -2099,7 +2229,7 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n} | {\n    type: 'refresh';\n} | {\n    type: 'logout';\n} | {\n    type: 'openSocket';\n} | {\n    type: 'closeSocket';\n} | {\n    type: 'login-details';\n} | "
+              "text": ";\n    };\n} | {\n    type: 'logout';\n} | {\n    type: 'openSocket';\n} | {\n    type: 'closeSocket';\n} | {\n    type: 'login-details';\n} | "
             },
             {
               "kind": "Reference",
@@ -2333,6 +2463,56 @@
               ],
               "name": "onLogin"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-auth!AuthStore#onLoginDetails:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onLoginDetails(event: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CustomEvent",
+                  "canonicalReference": "!CustomEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 4,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "event",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 3
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "onLoginDetails"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-auth!AuthStore#onLogout:member(1)",
@@ -2930,6 +3110,37 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-auth!DefaultAuthFormEntryStore#onAutofillForm:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onAutofillForm: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "EventListener",
+                  "canonicalReference": "!EventListener:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "onAutofillForm",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-auth!DefaultAuthFormEntryStore#onEmailChanged:member",
@@ -3653,6 +3864,103 @@
                 }
               ]
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-auth!DefaultAuthMachine#addLoginEvents:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "addLoginEvents(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        login: {\n            actions: string[];\n            target: string;\n        };\n        \"login-details\": {\n            target: string;\n        };\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "addLoginEvents"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-auth!DefaultAuthMachine#createFetchMachineEvent:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "createFetchMachineEvent(url: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", msg?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Message",
+                  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FetchMachineEvent",
+                  "canonicalReference": "@genesislcap/foundation-state-machine!FetchMachineEvent:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "url",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "msg",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "createFetchMachineEvent"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-auth!DefaultAuthMachine#getFromContainer:member(1)",
@@ -4081,6 +4389,37 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-auth!DefaultAuthStore#onLoginDetails:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onLoginDetails: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "EventListener",
+                  "canonicalReference": "!EventListener:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "onLoginDetails",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-auth!DefaultAuthStore#onLogout:member",
@@ -6256,6 +6595,37 @@
             }
           ]
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/foundation-auth!EVENT_LOGIN_DETAILS_ACK:interface",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface EVENT_LOGIN_DETAILS_ACK extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "EVENT_LOGIN_AUTH_ACK",
+              "canonicalReference": "@genesislcap/foundation-auth!EVENT_LOGIN_AUTH_ACK:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/dto/EVENT_LOGIN_DETAILS_ACK.ts",
+          "releaseTag": "Public",
+          "name": "EVENT_LOGIN_DETAILS_ACK",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-auth!EVENT_LOGOUT_NACK:interface",
@@ -6966,6 +7336,118 @@
           ],
           "name": "isLoginAckEntity"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-auth!isLoginDetailsAckDTO:function(1)",
+          "docComment": "/**\n * isLoginDetailsAckDTO.\n *\n * @param dto - Potential DTO.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function isLoginDetailsAckDTO(dto: "
+            },
+            {
+              "kind": "Reference",
+              "text": "LoginDTO",
+              "canonicalReference": "@genesislcap/foundation-auth!LoginDTO:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "dto",
+              "canonicalReference": "@genesislcap/foundation-auth!~dto"
+            },
+            {
+              "kind": "Content",
+              "text": " is "
+            },
+            {
+              "kind": "Reference",
+              "text": "EVENT_LOGIN_DETAILS_ACK",
+              "canonicalReference": "@genesislcap/foundation-auth!EVENT_LOGIN_DETAILS_ACK:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/mapper/loginMapper.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "dto",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "isLoginDetailsAckDTO"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-auth!isLoginDetailsAckEntity:function(1)",
+          "docComment": "/**\n * isLoginDetailsAckEntity.\n *\n * @param entity - Potential entity.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function isLoginDetailsAckEntity(entity: "
+            },
+            {
+              "kind": "Reference",
+              "text": "LoginEntity",
+              "canonicalReference": "@genesislcap/foundation-auth!LoginEntity:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "entity",
+              "canonicalReference": "@genesislcap/foundation-auth!~entity"
+            },
+            {
+              "kind": "Content",
+              "text": " is "
+            },
+            {
+              "kind": "Reference",
+              "text": "LoginDetailsAck",
+              "canonicalReference": "@genesislcap/foundation-auth!LoginDetailsAck:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/mapper/loginMapper.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "entity",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "isLoginDetailsAckEntity"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-auth!isLoginNackDTO:function(1)",
@@ -7801,6 +8283,37 @@
             }
           ]
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/foundation-auth!LoginDetailsAck:interface",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface LoginDetailsAck extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "LoginAck",
+              "canonicalReference": "@genesislcap/foundation-auth!LoginAck:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/entity/loginDetailsAck.ts",
+          "releaseTag": "Public",
+          "name": "LoginDetailsAck",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-auth!LoginDTO:type",
@@ -7819,6 +8332,15 @@
               "kind": "Content",
               "text": " | "
             },
+            {
+              "kind": "Reference",
+              "text": "EVENT_LOGIN_DETAILS_ACK",
+              "canonicalReference": "@genesislcap/foundation-auth!EVENT_LOGIN_DETAILS_ACK:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
             {
               "kind": "Reference",
               "text": "EVENT_LOGIN_AUTH_NACK",
@@ -7834,7 +8356,7 @@
           "name": "LoginDTO",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 4
+            "endIndex": 6
           }
         },
         {
@@ -7855,6 +8377,15 @@
               "kind": "Content",
               "text": " | "
             },
+            {
+              "kind": "Reference",
+              "text": "LoginDetailsAck",
+              "canonicalReference": "@genesislcap/foundation-auth!LoginDetailsAck:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
             {
               "kind": "Reference",
               "text": "LoginNack",
@@ -7870,7 +8401,7 @@
           "name": "LoginEntity",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 4
+            "endIndex": 6
           }
         },
         {