@factorialco/fcode-react-forms 3.3.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.
Files changed (35) hide show
  1. package/dist/components/json-schema-form/fcode-json-schema-form.d.ts +2 -1
  2. package/dist/components/json-schema-form/fields/index.d.ts +1 -0
  3. package/dist/components/json-schema-form/fields/oauth-field.d.ts +9 -0
  4. package/dist/components/json-schema-form/multistep/types.d.ts +2 -0
  5. package/dist/components/json-schema-form/oauth/default-connect-control.d.ts +8 -0
  6. package/dist/components/json-schema-form/oauth/index.d.ts +5 -0
  7. package/dist/components/json-schema-form/oauth/oauth-callback-page.test.d.ts +1 -0
  8. package/dist/components/json-schema-form/oauth/oauth-connect.d.ts +26 -0
  9. package/dist/components/json-schema-form/oauth/oauth-widget.d.ts +9 -0
  10. package/dist/components/json-schema-form/oauth/oauth-widget.test.d.ts +1 -0
  11. package/dist/components/json-schema-form/oauth/parse-oauth-options.d.ts +9 -0
  12. package/dist/components/json-schema-form/oauth/parse-oauth-options.test.d.ts +1 -0
  13. package/dist/components/json-schema-form/oauth/resolve-oauth-value.d.ts +9 -0
  14. package/dist/components/json-schema-form/oauth/resolve-oauth-value.test.d.ts +1 -0
  15. package/dist/components/json-schema-form/oauth/types.d.ts +89 -0
  16. package/dist/components/json-schema-form/oauth/use-oauth-flow.d.ts +12 -0
  17. package/dist/fcode-form.cjs.js +68 -68
  18. package/dist/fcode-form.cjs.js.map +1 -1
  19. package/dist/fcode-form.es.js +7444 -6960
  20. package/dist/fcode-form.es.js.map +1 -1
  21. package/dist/fcode-form.umd.js +79 -79
  22. package/dist/fcode-form.umd.js.map +1 -1
  23. package/dist/hooks/use-form-specs.d.ts +12 -0
  24. package/dist/index.d.ts +1 -0
  25. package/dist/services/fcode.d.ts +1 -1
  26. package/dist/styles.css +32 -0
  27. package/dist/types.d.ts +5 -0
  28. package/dist/utils/index.d.ts +1 -0
  29. package/dist/utils/is-http-url.d.ts +7 -0
  30. package/dist/utils/is-http-url.test.d.ts +1 -0
  31. package/dist/utils/oauth-popup.d.ts +80 -0
  32. package/dist/utils/oauth-popup.test.d.ts +1 -0
  33. package/dist/utils/oauth-relay.d.ts +1 -0
  34. package/dist/utils/oauth-relay.test.d.ts +1 -0
  35. package/package.json +1 -1
@@ -1,7 +1,19 @@
1
1
  import { FormOptions, FormSpecs } from '../types';
2
2
  declare const useFormSpecs: ({ hostUrl, headers, team, processId, processVersion, locale, }: FormOptions) => {
3
3
  loading: boolean;
4
+ /** A `reload()` is in flight; the previous specs stay available meanwhile. */
5
+ reloading: boolean;
4
6
  formSpecs: FormSpecs | undefined;
5
7
  error: unknown;
8
+ /**
9
+ * Refetches the specs bypassing the cache, keeping the current form on
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.
14
+ */
15
+ reload: (options?: {
16
+ silent?: boolean;
17
+ }) => void;
6
18
  };
7
19
  export default useFormSpecs;
package/dist/index.d.ts CHANGED
@@ -6,4 +6,5 @@ import { resolveErrorMessage } from './components/fcode-form/fcode-form.utils';
6
6
  export { FcodeForm, FcodeJsonSchemaForm, processFormSpecs, buildId, resolveErrorMessage, };
7
7
  export type { RedirectConfig } from './types';
8
8
  export type { FcodeRjsfTheme, MultistepThemeComponents, StepBackButtonProps, StepsNavigationItem, StepsNavigationProps, } from './components/json-schema-form/multistep';
9
+ export type { FcodeFormContext, OauthCompletionMessage, OauthConnectControlProps, OauthConnectStatus, OauthOnComplete, OauthThemeComponents, } from './components/json-schema-form/oauth';
9
10
  export default FcodeForm;
@@ -1,3 +1,3 @@
1
1
  import { SubmitFormParams, SubmitFormResponse, FetchFormSpecsParams } from '../types';
2
- export declare const fetchFormSpecs: ({ hostUrl, headers, team, processId, processVersion, locale, }: FetchFormSpecsParams) => Promise<any>;
2
+ export declare const fetchFormSpecs: ({ hostUrl, headers, team, processId, processVersion, locale, cache, }: FetchFormSpecsParams) => Promise<any>;
3
3
  export declare const submitForm: ({ hostUrl, headers, team, processId, processVersion, async, locale, formData, }: SubmitFormParams) => Promise<SubmitFormResponse>;
package/dist/styles.css CHANGED
@@ -1025,6 +1025,38 @@ input[type='number'] {
1025
1025
  border-radius: 0.2rem;
1026
1026
  }
1027
1027
 
1028
+ /* oauth connect control */
1029
+
1030
+ .fcode-form .fcode-oauth {
1031
+ display: flex;
1032
+ flex-wrap: wrap;
1033
+ align-items: center;
1034
+ gap: 0.75rem;
1035
+ }
1036
+
1037
+ .fcode-form .fcode-oauth-button {
1038
+ gap: 0.375rem;
1039
+ }
1040
+
1041
+ .fcode-form .fcode-oauth-button.is-pending {
1042
+ cursor: progress;
1043
+ }
1044
+
1045
+ .fcode-form .fcode-oauth-button.is-connected {
1046
+ color: var(--ycf-base-text-color);
1047
+ border-color: var(--ycf-base-border-color);
1048
+ }
1049
+
1050
+ .fcode-form .fcode-oauth-error {
1051
+ flex-basis: 100%;
1052
+ margin: 0;
1053
+ font-size: 0.875rem;
1054
+ }
1055
+
1056
+ .fcode-form .fcode-oauth-field .fcode-oauth {
1057
+ margin-top: 0.5rem;
1058
+ }
1059
+
1028
1060
  /* form control */
1029
1061
 
1030
1062
  .fcode-form .form-control {
package/dist/types.d.ts CHANGED
@@ -86,6 +86,11 @@ export interface FetchFormSpecsParams {
86
86
  processId: string;
87
87
  processVersion?: string;
88
88
  locale?: string;
89
+ /**
90
+ * Fetch cache mode. Defaults to `force-cache`; `reload` when the form asks
91
+ * to be re-rendered after an OAuth flow, so the `preRenderProcess` runs again.
92
+ */
93
+ cache?: RequestCache;
89
94
  }
90
95
  export interface SubmitFormParams {
91
96
  hostUrl: string;
@@ -1,3 +1,4 @@
1
1
  export { buildProcessUrl } from './build-process-url';
2
2
  export { buildId } from './build-id';
3
3
  export { isValidURL } from './is-valid-url';
4
+ export { isHttpUrl } from './is-http-url';
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Whether a value is an absolute `http:`/`https:` URL. Unlike `isValidURL`'s
3
+ * regex, this accepts everything the URL standard does — `:` in a `scope`,
4
+ * percent-encoded `redirect_uri`s — while still refusing `javascript:`,
5
+ * `data:` and relative paths.
6
+ */
7
+ export declare const isHttpUrl: (value: unknown) => value is string;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,80 @@
1
+ import { OauthCompletionMessage, OauthOutcome, OauthResult } from '../components/json-schema-form/oauth/types';
2
+ export interface OpenOauthPopupOptions {
3
+ url: string;
4
+ /** The window name; re-opening with the same name reuses the popup. */
5
+ name: string;
6
+ width: number;
7
+ height: number;
8
+ /** Milliseconds between the completion message and closing the popup. */
9
+ closeDelay: number;
10
+ /** How often to check whether the user closed the popup. */
11
+ pollInterval?: number;
12
+ onResult: (result: OauthResult) => void;
13
+ }
14
+ export interface OauthPopupHandle {
15
+ focus: () => void;
16
+ /** Stops listening without closing the popup (component unmount). */
17
+ dispose: () => void;
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;
60
+ /** Whether `data` is the payload `oauth-callback.html` posts. */
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;
64
+ /**
65
+ * Opens the authorization URL in a popup and reports how it ended, once:
66
+ * `success`/`error` when the callback page delivers its completion message,
67
+ * `cancelled` when the popup closes without one, `blocked` when the browser
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.
77
+ *
78
+ * Must be called synchronously from a user gesture, or popup blockers step in.
79
+ */
80
+ export declare const openOauthPopup: ({ url, name, width, height, closeDelay, pollInterval, onResult, }: OpenOauthPopupOptions) => OauthPopupHandle | null;
@@ -0,0 +1 @@
1
+ export {};
@@ -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.3.0",
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/",