feat(schema-formio): Add new package @tsed/formio-schema to convert T…

…s.ED schema to a Formio schema
tsedio · Jul 26, 2021 · 3b23d8c · 3b23d8c
1 parent 6ed6fda
commit 3b23d8c
Show file tree

Hide file tree

Showing 58 changed files with 2,816 additions and 4 deletions.
diff --git a/packages/schema-formio/.npmignore b/packages/schema-formio/.npmignore
@@ -0,0 +1,4 @@
+src
+test
+tsconfig.compile.json
+tsconfig.json
diff --git a/packages/schema-formio/package.json b/packages/schema-formio/package.json
@@ -0,0 +1,42 @@
+{
+  "name": "@tsed/schema-formio",
+  "version": "6.60.2",
+  "description": "Transform Ts.ED Schema & JsonSchema to a valid Formio schema",
+  "private": false,
+  "source": "./src/index.ts",
+  "main": "./lib/index.js",
+  "typings": "./lib/index.d.ts",
+  "exports": {
+    "require": "./lib/index.js",
+    "default": "./lib/index.modern.js"
+  },
+  "keywords": [
+    "TypeScript",
+    "decorators",
+    "models",
+    "json",
+    "schema",
+    "JsonSchema",
+    "formio",
+    "class",
+    "classes",
+    "tsed"
+  ],
+  "scripts": {
+    "build": "microbundle --target node --no-compress --format modern,cjs --tsconfig ./tsconfig.compile.json"
+  },
+  "dependencies": {
+    "change-case": "4.1.2",
+    "tslib": "2.2.0"
+  },
+  "devDependencies": {
+    "@tsed/core": "6.60.2",
+    "@tsed/openspec": "6.60.2",
+    "@tsed/schema": "6.60.2"
+  },
+  "peerDependencies": {
+    "@tsed/core": "^6.60.2",
+    "@tsed/openspec": "^6.60.2",
+    "@tsed/schema": "^6.60.2"
+  }
+}
diff --git a/packages/schema-formio/readme.md b/packages/schema-formio/readme.md
@@ -0,0 +1,190 @@
+<p style="text-align: center" align="center">
+ <a href="https://tsed.io" target="_blank"><img src="https://tsed.io/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
+</p>
+
+<div align="center">
+   <h1>@tsed/schema-formio</h1>
+
+[![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed/actions?query=workflow%3A%22Build+%26+Release%22)
+[![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed/blob/master/CONTRIBUTING.md)
+[![Coverage Status](https://coveralls.io/repos/github/tsedio/tsed/badge.svg?branch=production)](https://coveralls.io/github/tsedio/tsed?branch=production)
+[![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fcommon)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![backers](https://opencollective.com/tsed/tiers/badge.svg)](https://opencollective.com/tsed)
+
+</div>
+
+<div align="center">
+  <a href="https://tsed.io/">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://tsed.io/getting-started.html">Getting started</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://api.tsed.io/rest/slack/tsedio/tsed">Slack</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://twitter.com/TsED_io">Twitter</a>
+</div>
+
+<hr />
+
+A package of Ts.ED framework. See website: https://tsed.io/
+
+Package to transform a Schema declared with `@tsed/schema` to a valid Formio schema.
+
+## Documentation
+
+Documentation is available on [https://tsed.io](https://tsed.io/docs/model.html)
+
+## Installation
+
+You can get the latest release and the type definitions using npm:
+
+```bash
+npm install --save @tsed/schema-formio
+```
+
+## Basic example
+
+Given the following model
+
+```typescript
+import {getFormioSchema} from "@tsed/schema-formio";
+
+export class Model {
+  @Property()
+  id: string;
+}
+
+console.log(getFormioSchema(Model))
+```
+
+Generates the following formio schema:
+
+```json
+{
+  "components": [
+    {
+      "disabled": false,
+      "input": true,
+      "key": "test",
+      "label": "Test",
+      "type": "textfield",
+      "validate": {
+        "required": false
+      }
+    }
+  ],
+  "display": "form",
+  "machineName": "model",
+  "name": "model",
+  "title": "Model",
+  "type": "form"
+}
+```
+
+## Decorators
+
+This package support a large part of the JsonSchema decorators provided by `@tsed/schema`.
+So you can use `Property`, `Required`, `CollectionOf`, etc... decorator to generate a valid Formio 
+schema.
+
+Some extra decorators have been added to customize the component generated for a class property.
+Here the list:
+
+- Component: Create a custom component,
+- Currency: Change the property to a Currency component,
+- DataSourceJson: Add custom data source for a Select component,
+- DataSourceUrl: Fetch data source from an endpoint,
+- Hidden: Change the property to a Hidden component,
+- InputTags: Change the property to an InputTags component,
+- Multiple: Set the multiple flag on a property,
+- Password: Change the property to an input Password component,
+- Select: Change the property to a Select component,
+- TableView: Display or not the property in a Table,
+- Tabs: Group property using the Formio tab component,
+- Textarea: Change a component to a Textarea component.
+
+### Component
+
+Component decorator let you to define any extra formio metadata on a decorated property:
+
+```typescript
+import {getFormioSchema} from "@tsed/schema-formio";
+
+export class Model {
+  @Component({
+    tooltip: "MyTooltip"
+  })
+  tags: string;
+}
+```
+So with this decorator, you can define any metadata and define your own decorator to 
+wrap a complete component schema.
+
+### InputTags
+
+```typescript
+import {getFormioSchema} from "@tsed/schema-formio";
+
+export class Model {
+  @InputTags()
+  @Title("Tags for my model")
+  @CollectionOf(String)
+  tags: string[];
+}
+
+console.log(getFormioSchema(Model))
+```
+
+Generates the following formio schema:
+
+```json
+{
+  "components": [
+    {
+      "key": "test",
+      "type": "tags",
+      "input": true,
+      "label": "Test",
+      "storeas": "array",
+      "tableView": false,
+      "disabled": false,
+      "validate": {
+        "required": false
+      }
+    }
+  ],
+  "display": "form",
+  "machineName": "model",
+  "name": "model",
+  "title": "Model",
+  "type": "form"
+}
+```
+
+## Contributors
+Please read [contributing guidelines here](https://tsed.io/CONTRIBUTING.html)
+
+<a href="https://github.com/tsedio/ts-express-decorators/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
+
+<a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/tiers/backer.svg?width=890"></a>
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 - 2018 Romain Lenzotti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/packages/schema-formio/src/components/anyToComponent.ts b/packages/schema-formio/src/components/anyToComponent.ts
@@ -0,0 +1,28 @@
+import {execMapper, registerFormioMapper} from "../registries/FormioMappersContainer";
+import {getRef} from "../utils/getRef";
+
+export function anyToComponent(schema: any, options: any) {
+  schema = getRef(schema, options);
+
+  switch (schema.type) {
+    case "object":
+      if (schema.additionalProperties) {
+        return execMapper("map", schema, options);
+      }
+
+      return execMapper("nested", schema, options);
+    case "array":
+      return execMapper("array", schema, options);
+    case "string":
+      return execMapper("string", schema, options);
+    case "boolean":
+      return execMapper("boolean", schema, options);
+    case "integer":
+    case "number":
+      return execMapper("number", schema, options);
+    // default:
+    //   return execMapper("default", schema, options);
+  }
+}
+
+registerFormioMapper("any", anyToComponent);
diff --git a/packages/schema-formio/src/components/arrayToComponent.ts b/packages/schema-formio/src/components/arrayToComponent.ts
@@ -0,0 +1,39 @@
+import {cleanObject} from "@tsed/core";
+import {execMapper, registerFormioMapper} from "../registries/FormioMappersContainer";
+import {getRef} from "../utils/getRef";
+
+export function arrayToComponent(schema: any, options: any) {
+  schema = schema.items.$ref ? getRef(schema.items, options) : schema.items;
+
+  const {type} = schema;
+
+  switch (type) {
+    case "object": // editgrid
+      return execMapper("editgrid", schema, options);
+    case "string": // tag or enum?
+      if (schema.enum) {
+        const component = execMapper("enum", schema, options);
+
+        return {
+          ...component,
+          inline: false,
+          type: "selectboxes"
+        };
+      }
+
+      const component = execMapper(type, schema, options);
+
+      return cleanObject({
+        ...component,
+        multiple: component.type === "tags" ? undefined : true
+      });
+    default:
+    case "number":
+      return {
+        ...execMapper(type, schema, options),
+        multiple: true
+      };
+  }
+}
+
+registerFormioMapper("array", arrayToComponent);
diff --git a/packages/schema-formio/src/components/booleanToComponent.ts b/packages/schema-formio/src/components/booleanToComponent.ts
@@ -0,0 +1,14 @@
+import {cleanObject} from "@tsed/core";
+import {execMapper, registerFormioMapper} from "../registries/FormioMappersContainer";
+
+function booleanToComponent(schema: any, options: any) {
+  const component = execMapper("default", schema, options);
+
+  return cleanObject({
+    ...component,
+    input: true,
+    type: component.type || "checkbox"
+  });
+}
+
+registerFormioMapper("boolean", booleanToComponent);
diff --git a/packages/schema-formio/src/components/dateToComponent.ts b/packages/schema-formio/src/components/dateToComponent.ts
@@ -0,0 +1,59 @@
+import {execMapper, registerFormioMapper} from "../registries/FormioMappersContainer";
+
+function dateToComponent(schema: any, options: any) {
+  const component = execMapper("default", schema, options);
+
+  const base = {
+    ...component,
+    enableMinDateInput: false,
+    datePicker: {
+      disableWeekends: false,
+      disableWeekdays: false
+    },
+    enableMaxDateInput: false,
+    enableTime: false,
+    type: "datetime",
+    input: true,
+    widget: {
+      type: "calendar",
+      displayInTimezone: "viewer",
+      locale: "en",
+      useLocaleSettings: false,
+      allowInput: true,
+      mode: "single",
+      noCalendar: false,
+      hourIncrement: 1,
+      minuteIncrement: 1,
+      minDate: null,
+      disableWeekends: false,
+      disableWeekdays: false,
+      maxDate: null
+    }
+  };
+
+  if (schema.format === "date") {
+    return {
+      ...base,
+      format: "yyyy-MM-dd",
+      enableTime: false,
+      widget: {
+        ...base.widget,
+        enableTime: false,
+        format: "yyyy-MM-dd"
+      }
+    };
+  }
+
+  return {
+    ...base,
+    timePicker: {
+      showMeridian: false
+    },
+    widget: {
+      enableTime: true,
+      time_24hr: true
+    }
+  };
+}
+
+registerFormioMapper("date", dateToComponent);