@factorialco/fcode-react-forms 2.0.0 → 2.0.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.
@@ -1,3 +1,3 @@
1
- import { SubmitFormParams, SubmitFormResults, FetchFormSpecsParams } from '../types';
1
+ import { SubmitFormParams, SubmitFormResponse, FetchFormSpecsParams } from '../types';
2
2
  export declare const fetchFormSpecs: ({ hostUrl, headers, team, processId, processVersion, locale, }: FetchFormSpecsParams) => Promise<any>;
3
- export declare const submitForm: ({ hostUrl, headers, team, processId, processVersion, async, locale, formData, }: SubmitFormParams) => Promise<SubmitFormResults>;
3
+ export declare const submitForm: ({ hostUrl, headers, team, processId, processVersion, async, locale, formData, }: SubmitFormParams) => Promise<SubmitFormResponse>;
package/dist/types.d.ts CHANGED
@@ -67,6 +67,18 @@ export interface RedirectConfig {
67
67
  timeout?: number;
68
68
  }
69
69
  export type SubmitFormResults = GenericObjectType;
70
+ export interface SubmitFormResponse {
71
+ /** The process execution result, i.e. the response body. */
72
+ results: SubmitFormResults;
73
+ /**
74
+ * The file fields the platform stored during this submit, as
75
+ * `fcode.storage://` paths keyed by field name (from the
76
+ * `Fcode-Resolved-Files` response header). Multi-step forms keep these in
77
+ * the step data instead of the submitted `data:` URL, so later steps carry
78
+ * the path the step's process saw rather than re-sending the file's base64.
79
+ */
80
+ resolvedFiles?: Record<string, string>;
81
+ }
70
82
  export interface FetchFormSpecsParams {
71
83
  hostUrl: string;
72
84
  headers?: GenericObjectType;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@factorialco/fcode-react-forms",
3
- "version": "2.0.0",
3
+ "version": "2.0.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/",