@factorialco/fcode-react-forms 3.4.0 → 3.4.1
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.
- package/dist/components/json-schema-form/oauth/resolve-oauth-value.d.ts +2 -1
- package/dist/components/json-schema-form/oauth/types.d.ts +12 -1
- package/dist/fcode-form.cjs.js +67 -67
- package/dist/fcode-form.cjs.js.map +1 -1
- package/dist/fcode-form.es.js +6586 -6488
- package/dist/fcode-form.es.js.map +1 -1
- package/dist/fcode-form.umd.js +68 -68
- package/dist/fcode-form.umd.js.map +1 -1
- package/dist/hooks/use-form-specs.d.ts +6 -1
- package/dist/utils/oauth-popup.d.ts +54 -4
- package/dist/utils/oauth-relay.d.ts +1 -0
- package/dist/utils/oauth-relay.test.d.ts +1 -0
- package/package.json +1 -1
|
@@ -8,7 +8,12 @@ declare const useFormSpecs: ({ hostUrl, headers, team, processId, processVersion
|
|
|
8
8
|
/**
|
|
9
9
|
* Refetches the specs bypassing the cache, keeping the current form on
|
|
10
10
|
* screen. A failed reload keeps the current specs too and sets no `error`.
|
|
11
|
+
* `silent: true` also skips `reloading` (no overlay): a background refresh
|
|
12
|
+
* the user should not notice, e.g. while an OAuth field is still waiting
|
|
13
|
+
* for a severed popup's completion.
|
|
11
14
|
*/
|
|
12
|
-
reload: (
|
|
15
|
+
reload: (options?: {
|
|
16
|
+
silent?: boolean;
|
|
17
|
+
}) => void;
|
|
13
18
|
};
|
|
14
19
|
export default useFormSpecs;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { OauthCompletionMessage, OauthResult } from '../components/json-schema-form/oauth/types';
|
|
1
|
+
import { OauthCompletionMessage, OauthOutcome, OauthResult } from '../components/json-schema-form/oauth/types';
|
|
2
2
|
export interface OpenOauthPopupOptions {
|
|
3
3
|
url: string;
|
|
4
4
|
/** The window name; re-opening with the same name reuses the popup. */
|
|
@@ -16,14 +16,64 @@ export interface OauthPopupHandle {
|
|
|
16
16
|
/** Stops listening without closing the popup (component unmount). */
|
|
17
17
|
dispose: () => void;
|
|
18
18
|
}
|
|
19
|
+
/**
|
|
20
|
+
* How long a "closed" popup may still deliver its completion. A provider that
|
|
21
|
+
* sends `Cross-Origin-Opener-Policy` (DATEV does) swaps the popup into another
|
|
22
|
+
* browsing context group the moment it navigates there: the opener's window
|
|
23
|
+
* proxy starts reporting `closed: true` while the user is still logging in.
|
|
24
|
+
* The completion then arrives over the BroadcastChannel instead, so a closed
|
|
25
|
+
* popup only counts as cancelled once this grace period passes in silence.
|
|
26
|
+
*/
|
|
27
|
+
export declare const CLOSED_GRACE_MS = 1500;
|
|
28
|
+
/**
|
|
29
|
+
* A popup that reports closed within this window of being opened is most
|
|
30
|
+
* likely not closed at all but COOP-severed — the swap happens the moment the
|
|
31
|
+
* provider's page commits, seconds in, while a user genuinely closing the
|
|
32
|
+
* window takes longer. Such a cancel is flagged `possiblySevered` so the
|
|
33
|
+
* control can keep its waiting state for the late completion.
|
|
34
|
+
*/
|
|
35
|
+
export declare const SEVERANCE_WINDOW_MS = 8000;
|
|
36
|
+
/**
|
|
37
|
+
* The same-origin channel `oauth-callback.html` broadcasts its completion on,
|
|
38
|
+
* for openers a `Cross-Origin-Opener-Policy` header disconnected. The name is
|
|
39
|
+
* a contract with that page.
|
|
40
|
+
*/
|
|
41
|
+
export declare const OAUTH_CHANNEL_NAME = "fcode-forms:oauth";
|
|
42
|
+
/** A channel to listen for completions on, or null where unsupported (jsdom). */
|
|
43
|
+
export declare const openOauthChannel: () => BroadcastChannel | null;
|
|
44
|
+
/**
|
|
45
|
+
* The OAuth `state` an authorization URL carries, or null. The SDK never mints
|
|
46
|
+
* the state (the author's pre-render process does), but it can read it — and
|
|
47
|
+
* when the callback webhook echoes it back to `oauth-callback.html`, a
|
|
48
|
+
* completion can be bound to the very flow that opened the popup.
|
|
49
|
+
*/
|
|
50
|
+
export declare const oauthStateOf: (url: string) => string | null;
|
|
51
|
+
/**
|
|
52
|
+
* State binding for channel-delivered completions, where no sender identity
|
|
53
|
+
* exists: whenever this side knows the states it opened popups for, the
|
|
54
|
+
* payload MUST echo one of them — the callback contract requires echoing the
|
|
55
|
+
* `state` back to `oauth-callback.html`. A merely-optional echo would be no
|
|
56
|
+
* binding at all (a forger could just omit it). Only a flow whose
|
|
57
|
+
* authorization URL carried no `state` cannot be bound and stays accept-any.
|
|
58
|
+
*/
|
|
59
|
+
export declare const completionMatchesState: (data: OauthCompletionMessage, knownStates: ReadonlySet<string>) => boolean;
|
|
19
60
|
/** Whether `data` is the payload `oauth-callback.html` posts. */
|
|
20
61
|
export declare const isOauthCompletionMessage: (data: unknown) => data is OauthCompletionMessage;
|
|
62
|
+
/** The outcome a completion payload describes, with params sanitised. */
|
|
63
|
+
export declare const completionToResult: (data: OauthCompletionMessage) => OauthOutcome;
|
|
21
64
|
/**
|
|
22
65
|
* Opens the authorization URL in a popup and reports how it ended, once:
|
|
23
|
-
* `success`/`error` when the callback page
|
|
66
|
+
* `success`/`error` when the callback page delivers its completion message,
|
|
24
67
|
* `cancelled` when the popup closes without one, `blocked` when the browser
|
|
25
|
-
* refused to open it.
|
|
26
|
-
*
|
|
68
|
+
* refused to open it. After a completion the popup is closed once `closeDelay`
|
|
69
|
+
* elapses.
|
|
70
|
+
*
|
|
71
|
+
* The completion arrives on two redundant paths: a `postMessage` from the
|
|
72
|
+
* popup (accepted only when `event.source` is that very window) and the
|
|
73
|
+
* same-origin `BroadcastChannel` — the fallback for providers whose
|
|
74
|
+
* `Cross-Origin-Opener-Policy` severs the opener link mid-flow. A channel is
|
|
75
|
+
* same-origin by construction, and the payload travelled in a URL anyway; the
|
|
76
|
+
* submit-side process must verify the connection regardless.
|
|
27
77
|
*
|
|
28
78
|
* Must be called synchronously from a user gesture, or popup blockers step in.
|
|
29
79
|
*/
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const ensureOauthRelay: (sdkOrigin: string) => (() => void);
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@factorialco/fcode-react-forms",
|
|
3
|
-
"version": "3.4.
|
|
3
|
+
"version": "3.4.1",
|
|
4
4
|
"description": "Factorial Code allows start process executions from any webpage embedding process input parameters forms. This allows each form submission to start one execution with the information filled in the form, and also allows to manage the execution result into that webpage.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"homepage": "https://code.factorialhr.com/docs/forms/",
|