@tsed/schema-formio 7.0.0-alpha.2 → 7.0.0-beta.11

package/lib/types/decorators/conditional.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Adds a conditional display rule on the input form.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ * @param conditional
+ */
+export declare function Conditional(conditional: {
+    show: boolean;
+    when: string;
+    eq: any;
+}): PropertyDecorator;
+/**
+ * Adds a conditional display rule on the input form.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ * @param property
+ * @param eq
+ */
+export declare function ShowWhen(property: string, eq: any): PropertyDecorator;
+/**
+ * Adds a conditional display rule on the input form.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ * @param property
+ * @param eq
+ */
+export declare function HideWhen(property: string, eq: any): PropertyDecorator;

package/lib/types/decorators/customClass.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Add a custom css class.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ */
+export declare function CustomClass(customClass: string): PropertyDecorator;

package/lib/types/decorators/customConditional.d.ts

@@ -0,0 +1,59 @@
+import { FormioComponent, FormioForm, FormioSubmission } from "@tsed/formio-types";
+import type { Moment } from "moment";
+import type { LoDashStatic } from "lodash";
+import type { Utils } from "formiojs";
+export interface CustomConditionalCtx<Value = any, Data = any, Row = any> {
+    /**
+     * The complete submission object.
+     */
+    form: FormioForm;
+    /**
+     * The complete submission object.
+     */
+    submission: FormioSubmission<Data>;
+    /**
+     * The complete submission data object.
+     */
+    data: Data;
+    /**
+     * Contextual "row" data, used within DataGrid, EditGrid, and Container components
+     */
+    row: Row;
+    /**
+     * The current component JSON
+     */
+    component: FormioComponent;
+    /**
+     * The current component instance.
+     */
+    instance: any;
+    /**
+     * The current value of the component.
+     */
+    value: Value;
+    /**
+     * The moment.js library for date manipulation.
+     */
+    moment: Moment;
+    /**
+     * An instance of Lodash.
+     */
+    _: LoDashStatic;
+    /**
+     * An instance of the FormioUtils object.
+     */
+    utils: typeof Utils;
+    /**
+     * An alias for "utils".
+     */
+    util: typeof Utils;
+}
+/**
+ * Adds custom conditional rule to display or not the input form.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ * @param customConditional
+ */
+export declare function CustomConditional(customConditional: string | ((ctx: CustomConditionalCtx) => any)): PropertyDecorator;

package/lib/types/decorators/dataSourceJson.d.ts

@@ -0,0 +1,8 @@
+import { FormioDataResolver } from "../domain/FormioDataResolver";
+/**
+ * Set custom json data source
+ * @param data
+ * @param props
+ * @constructor
+ */
+export declare function DataSourceJson(data: any | FormioDataResolver, props?: Record<string, any>): PropertyDecorator;

package/lib/types/decorators/dataSourceUrl.d.ts

@@ -0,0 +1,8 @@
+import { FormioDataResolver } from "../domain/FormioDataResolver";
+/**
+ * Set URL data on the current component.
+ * @param url
+ * @param props
+ * @constructor
+ */
+export declare function DataSourceUrl(url: string | FormioDataResolver, props?: Record<string, any>): PropertyDecorator;

package/lib/types/decorators/errorLabel.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Set the error label when an error occur.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ */
+export declare function ErrorLabel(message: string): PropertyDecorator;

package/lib/types/decorators/errorMessage.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Add error message when an error occur.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ * @param message
+ */
+export declare function ErrorMessage(message: string): PropertyDecorator;

package/lib/types/decorators/form.d.ts

@@ -0,0 +1,6 @@
+import { FormioForm } from "@tsed/formio-types";
+/**
+ * Expose the model as Formio Form.
+ * @param form
+ */
+export declare function Form(form?: Partial<Omit<FormioForm, "components" | "_id">>): ClassDecorator;

package/lib/{decorators → types/decorators}/hidden.d.ts

@@ -1,5 +1,8 @@
 /**
  * Set hidden field.
+ *
+ * A hidden field is still a part of the form, but is hidden from view.
+ *
  * @param bool
  * @decorator
  * @formio

package/lib/types/decorators/label.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Change the label field
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ * @param label
+ */
+export declare function Label(label: string): PropertyDecorator;

package/lib/types/decorators/mask.d.ts

@@ -0,0 +1,37 @@
+/**
+ * An input mask helps the user with input by ensuring a predefined format.
+ *
+ * - 9: numeric
+ * - a: alphabetical
+ * - *: alphanumeric
+ *
+ * Example telephone mask: (999) 999-9999
+ *
+ * See the [jquery.inputmask](https://github.com/RobinHerbots/Inputmask) documentation for more information.
+ *
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ */
+export declare function Mask(inputMask: string, inputMaskPlaceholderChar?: string): PropertyDecorator;
+/**
+ * An input mask helps the user with input by ensuring a predefined format.
+ *
+ * - 9: numeric
+ * - a: alphabetical
+ * - *: alphanumeric
+ *
+ * Example telephone mask: (999) 999-9999
+ *
+ * See the [jquery.inputmask](https://github.com/RobinHerbots/Inputmask) documentation for more information.
+ *
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ */
+export declare function Masks(...inputMasks: {
+    label: string;
+    mask: string;
+}[]): PropertyDecorator;

package/lib/types/decorators/maxWords.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Add the minimum amount of words that can be added to this field.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ * @param value
+ */
+export declare function MaxWords(value: number): PropertyDecorator;

package/lib/types/decorators/minWords.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Add the maximum amount of words that can be added to this field.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ * @param value
+ */
+export declare function MinWords(value: number): PropertyDecorator;

package/lib/types/decorators/modalEdit.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Opens up a modal to edit the value of this component.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ */
+export declare function ModalEdit(modalEdit?: boolean): PropertyDecorator;

package/lib/types/decorators/openWhenEmpty.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Open automatically the editgrid when the list is empty.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ */
+export declare function OpenWhenEmpty(openWhenEmpty?: boolean): PropertyDecorator;

package/lib/types/decorators/password.d.ts

@@ -0,0 +1,12 @@
+export interface PasswordOpts extends Record<string, any> {
+    showCharCount?: boolean;
+    showWordCount?: boolean;
+}
+/**
+ * Configure the property as Password component.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ */
+export declare function Password(props?: PasswordOpts): PropertyDecorator;

package/lib/types/decorators/placeholder.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The placeholder text that will appear when this field is empty.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ * @param placeholder
+ */
+export declare function Placeholder(placeholder: string): PropertyDecorator;

package/lib/types/decorators/prefix.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Add prefix word on the decorated field.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ */
+export declare function Prefix(prefix: string): PropertyDecorator;

package/lib/types/decorators/select.d.ts

@@ -0,0 +1,14 @@
+export interface SelectOpts extends Record<string, any> {
+    idPath?: string;
+    valueProperty?: string;
+    template?: string;
+    multiple?: boolean;
+}
+/**
+ * Configure the property as Select component.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ */
+export declare function Select(props?: SelectOpts): PropertyDecorator;

package/lib/types/decorators/suffix.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Add suffix word on the decorated field.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ */
+export declare function Suffix(suffix: string): PropertyDecorator;

package/lib/types/decorators/textCase.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Force the output of this field to be sanitized in a specific format.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ * @param textCase
+ */
+export declare function TextCase(textCase: "uppercase" | "lowercase"): PropertyDecorator;

package/lib/types/decorators/textarea.d.ts

@@ -0,0 +1,12 @@
+export interface TextareaOpts extends Record<string, any> {
+    showCharCount?: boolean;
+    showWordCount?: boolean;
+}
+/**
+ * Configure the property as Textarea component.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ */
+export declare function Textarea(props?: TextareaOpts): PropertyDecorator;

package/lib/types/decorators/tooltip.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Adds a tooltip to the side of this field.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ * @param tooltip
+ */
+export declare function Tooltip(tooltip: string): PropertyDecorator;

package/lib/types/decorators/validate.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Add validation rules.
+ * @decorator
+ * @formio
+ * @property
+ * @schema
+ * @param key
+ * @param value
+ */
+export declare function Validate(key: string, value: any): PropertyDecorator;

package/lib/types/domain/FormioDataResolver.d.ts

@@ -0,0 +1,7 @@
+import { FormioComponent, FormioForm } from "@tsed/formio-types";
+import { JsonSchemaOptions } from "@tsed/schema";
+export declare type FormioDataResolverCtx = {
+    component: FormioComponent;
+    form: FormioForm;
+} & JsonSchemaOptions;
+export declare type FormioDataResolver = (ctx: FormioDataResolverCtx) => Promise<any> | any;

package/lib/types/index.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+export * from "./components/anyToComponent";
+export * from "./components/arrayToComponent";
+export * from "./components/booleanToComponent";
+export * from "./components/dateToComponent";
+export * from "./components/defaultToComponent";
+export * from "./components/enumToComponent";
+export * from "./components/mapToComponent";
+export * from "./components/nestedToComponent";
+export * from "./components/numberToComponent";
+export * from "./components/objectToEditGrid";
+export * from "./components/panelToComponent";
+export * from "./components/propertiesToComponents";
+export * from "./components/stringToComponent";
+export * from "./decorators/component";
+export * from "./decorators/conditional";
+export * from "./decorators/currency";
+export * from "./decorators/customClass";
+export * from "./decorators/customConditional";
+export * from "./decorators/dataSourceJson";
+export * from "./decorators/dataSourceUrl";
+export * from "./decorators/errorLabel";
+export * from "./decorators/errorMessage";
+export * from "./decorators/form";
+export * from "./decorators/hidden";
+export * from "./decorators/inputTags";
+export * from "./decorators/label";
+export * from "./decorators/mask";
+export * from "./decorators/maxWords";
+export * from "./decorators/minWords";
+export * from "./decorators/modalEdit";
+export * from "./decorators/multiple";
+export * from "./decorators/openWhenEmpty";
+export * from "./decorators/password";
+export * from "./decorators/placeholder";
+export * from "./decorators/prefix";
+export * from "./decorators/select";
+export * from "./decorators/suffix";
+export * from "./decorators/tableView";
+export * from "./decorators/tabs";
+export * from "./decorators/textCase";
+export * from "./decorators/textarea";
+export * from "./decorators/tooltip";
+export * from "./decorators/validate";
+export * from "./domain/FormioDataResolver";
+export * from "./registries/FormioMappersContainer";
+export * from "./registries/FormsContainer";
+export * from "./utils/getFormioProps";
+export * from "./utils/getFormioSchema";
+export * from "./utils/getRef";

package/lib/types/registries/FormsContainer.d.ts

@@ -0,0 +1,2 @@
+import { Type } from "@tsed/core";
+export declare const FormsContainer: Map<string, Type>;

package/lib/types/utils/getFormioSchema.d.ts

@@ -0,0 +1,16 @@
+import { JsonSchemaOptions } from "@tsed/schema";
+import { FormioForm } from "@tsed/formio-types";
+import "../components/anyToComponent";
+import "../components/arrayToComponent";
+import "../components/booleanToComponent";
+import "../components/dateToComponent";
+import "../components/defaultToComponent";
+import "../components/enumToComponent";
+import "../components/mapToComponent";
+import "../components/nestedToComponent";
+import "../components/numberToComponent";
+import "../components/objectToEditGrid";
+import "../components/panelToComponent";
+import "../components/propertiesToComponents";
+import "../components/stringToComponent";
+export declare function getFormioSchema(model: string | any | undefined, options?: JsonSchemaOptions): Promise<Omit<FormioForm, "components" | "_id" | "deleted" | "owner"> | undefined>;

package/package.json

@@ -1,14 +1,24 @@
 {
   "name": "@tsed/schema-formio",
-  "version": "7.0.0-alpha.2",
+  "version": "7.0.0-beta.11",
   "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",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "typings": "./lib/types/index.d.ts",
   "exports": {
-    "require": "./lib/index.js",
-    "default": "./lib/index.modern.js"
+    "types": "./lib/types/index.d.ts",
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/esm/index.js"
+  },
+  "scripts": {
+    "build": "yarn barrels && yarn run build:esm && yarn run build:cjs",
+    "build:cjs": "tsc --build tsconfig.compile.json",
+    "build:esm": "tsc --build tsconfig.compile.esm.json",
+    "barrels": "yarn barrelsby --delete -d ./src -e \"\\.spec\\.ts\" -e \"__mock__\" -e \".benchmark.ts\"",
+    "test": "cross-env NODE_ENV=test jest"
   },
   "keywords": [
     "TypeScript",
@@ -22,32 +32,49 @@
     "classes",
     "tsed"
   ],
-  "scripts": {
-    "build": "microbundle --target node --no-compress --format modern,cjs --tsconfig ./tsconfig.compile.json",
-    "test": "cross-env NODE_ENV=test nyc mocha"
-  },
   "dependencies": {
+    "@tsed/formio-types": "7.0.0-beta.11",
     "change-case": "4.1.2",
-    "tslib": "2.2.0"
+    "tslib": "2.3.1"
   },
   "devDependencies": {
-    "@tsed/core": "7.0.0-alpha.2",
-    "@tsed/openspec": "7.0.0-alpha.2",
-    "@tsed/schema": "7.0.0-alpha.2"
+    "@tsed/core": "7.0.0-beta.11",
+    "@tsed/openspec": "7.0.0-beta.11",
+    "@tsed/schema": "7.0.0-beta.11"
   },
   "peerDependencies": {
-    "@tsed/core": "^7.0.0-alpha.2",
-    "@tsed/openspec": "^7.0.0-alpha.2",
-    "@tsed/schema": "^7.0.0-alpha.2"
+    "@tsed/core": "^7.0.0-beta.11",
+    "@tsed/openspec": "^7.0.0-beta.11",
+    "@tsed/schema": "^7.0.0-beta.11",
+    "formiojs": ">=4.0.0",
+    "lodash": ">=4.0.0",
+    "moment": ">=2.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@tsed/core": {
+      "optional": false
+    },
+    "@tsed/openspec": {
+      "optional": false
+    },
+    "@tsed/schema": {
+      "optional": false
+    },
+    "formiojs": {
+      "optional": false
+    },
+    "lodash": {
+      "optional": false
+    },
+    "moment": {
+      "optional": false
+    }
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {
     "url": "https://github.com/tsedio/tsed/issues"
   },
-  "homepage": "https://github.com/tsedio/tsed/tree/alpha/packages/third-parties/schema-formio",
+  "homepage": "https://github.com/tsedio/tsed/tree/beta/packages/third-parties/schema-formio",
   "author": "Romain Lenzotti",
-  "license": "MIT",
-  "publishConfig": {
-    "tag": "alpha"
-  }
+  "license": "MIT"
 }

package/readme.md

@@ -48,14 +48,15 @@ npm install --save @tsed/schema-formio
 Given the following model
 
 ```typescript
-import {getFormioSchema} from "@tsed/schema-formio";
+import {getFormioSchema, Form} from "@tsed/schema-formio";
 
+@Form()
 export class Model {
   @Property()
   id: string;
 }
 
-console.log(getFormioSchema(Model))
+console.log(await getFormioSchema(Model));
 ```
 
 Generates the following formio schema:
@@ -85,7 +86,7 @@ Generates the following formio schema:
 ## 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 
+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.
@@ -109,8 +110,9 @@ Here the list:
 Component decorator let you to define any extra formio metadata on a decorated property:
 
 ```typescript
-import {getFormioSchema} from "@tsed/schema-formio";
+import {Form, Component} from "@tsed/schema-formio";
 
+@Form()
 export class Model {
   @Component({
     tooltip: "MyTooltip"
@@ -118,7 +120,8 @@ export class Model {
   tags: string;
 }
 ```
-So with this decorator, you can define any metadata and define your own decorator to 
+
+So with this decorator, you can define any metadata and define your own decorator to
 wrap a complete component schema.
 
 ### InputTags
@@ -133,7 +136,7 @@ export class Model {
   tags: string[];
 }
 
-console.log(getFormioSchema(Model))
+console.log(await getFormioSchema(Model));
 ```
 
 Generates the following formio schema:
@@ -163,6 +166,7 @@ Generates the following formio schema:
 ```
 
 ## 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>

package/tsconfig.compile.esm.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.compile.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "ES2020",
+    "rootDir": "src",
+    "outDir": "./lib/esm",
+    "declaration": true,
+    "declarationDir": "./lib/types"
+  },
+  "exclude": ["node_modules", "test", "lib", "benchmark", "coverage", "spec", "**/*.benchmark.ts", "**/*.spec.ts", "keys", "jest.config.js"]
+}

package/.mocharc.js

@@ -1,5 +0,0 @@
-module.exports = {
-  ...require('@tsed/mocha-config')(),
-  spec: ["{src,test}/**/*.spec.ts"],
-  exclude: [],
-};