@pontive/pontkit-core 1.7.2 → 1.7.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,19 @@
1
+ /**
2
+ * What a flow failure says to the person on the screen.
3
+ *
4
+ * A step that fails and can be retried (a wrong password, an invalid code)
5
+ * comes back as a screen with the error banner already in it. Everything else
6
+ * comes back as an exception: the request failed, or the flow is over. Those
7
+ * used to reach only the console, so the page sat on the screen it was showing
8
+ * with nothing to say what had happened.
9
+ */
10
+ export interface FlowErrorDescription {
11
+ /** A sentence for the banner. */
12
+ message: string;
13
+ /**
14
+ * The flow has ended and takes no more events, so the screen on show is dead.
15
+ * The only way on is to start the flow again.
16
+ */
17
+ restartable: boolean;
18
+ }
19
+ export declare function describeFlowError(error: unknown): FlowErrorDescription;
@@ -0,0 +1,12 @@
1
+ /**
2
+ * The identifier the page was opened with as OpenID Connect's `login_hint`, or
3
+ * undefined when there is none.
4
+ *
5
+ * /oauth2/authorize forwards an app's `login_hint` to the hosted pages, and an
6
+ * accepted invitation sends the invitee to the app's sign-in page
7
+ * (initiate_login_uri) with the address it was sent to. Either way it is in the
8
+ * page's query string, and the identifier fields pre-fill from it so nobody
9
+ * types the address they were just invited at. It only pre-fills: the user can
10
+ * change it, and nothing is trusted because of it.
11
+ */
12
+ export declare function loginHint(search?: string | undefined): string | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pontive/pontkit-core",
3
- "version": "1.7.2",
3
+ "version": "1.7.4",
4
4
  "license": "MIT",
5
5
  "description": "A collection of core components for Pontive",
6
6
  "main": "dist/index.js",