@crowdin/app-project-module 0.28.0-2 → 0.28.0-3

package/README.md

@@ -978,7 +978,15 @@ configuration.projectMenu = {
         "title": "Last name"
       },
     }
-  }
+  },
+  formUiSchema: {
+    "ui:submitButtonOptions": {
+      "submitText": "Confirm Details",
+    },
+    "lastName": {
+      "ui:help": "Hint: Choose cool lastname!"
+    }
+  },
 };
 ```
 By default, form data will be stored in app metadata. To retrieve data you can use this code:
@@ -986,7 +994,19 @@ By default, form data will be stored in app metadata. To retrieve data you can u
 crowdinApp.getMetadata(`${organizationId}-${projectId}`);
 ```
 To customize this behavior you can provide `formDataUrl` property that will contain URL to custom action in your app. This action should support both GET request for fetching data and POST request to save new data.
-
+Response structure for GET request example:
+```js
+res.status(200).send({
+    formData: {
+        firstName: 'Norris',
+    },
+}).end();
+```
+Also, you can provide next properties:
+- formScheme - new schema to replace active schema;
+- formUiScheme - new uiSchema to replace current;
+- message - custom message that will be displayed in toasts;
+- redirect - url for redirect (useful for files download).
 ## Contributing
 
 If you want to contribute please read the [Contributing](/CONTRIBUTING.md) guidelines.

package/out/handlers/form-data-display.js

@@ -35,7 +35,7 @@ function handle() {
         const id = req.query.id;
         const data = (yield storage.getStorage().getMetadata(id)) || {};
         return res.send({
-            data,
+            formData: data,
         });
     }));
 }

package/out/middlewares/render-ui-module.js

@@ -20,6 +20,7 @@ function handle(config, moduleConfig) {
             return res.render('form', {
                 formDataUrl: moduleConfig.formDataUrl ? moduleConfig.formDataUrl : '/api/form-data',
                 formSchema: JSON.stringify(moduleConfig.formSchema),
+                formUiSchema: moduleConfig.formUiSchema ? JSON.stringify(moduleConfig.formUiSchema) : '{}',
             });
         }
         if (moduleConfig.uiPath) {

package/out/models/index.d.ts

@@ -606,6 +606,10 @@ export interface UiModule {
      * Endpoint should accept both POST requests for data saving and GET requests for data retrieving.
      */
     formDataUrl?: string;
+    /**
+     * Additional attributes for react-jsonschema-doc
+     */
+    formUiSchema?: object;
     /**
      * path to ui folder (e.g. {@example join(__dirname, 'public')})
      */