@tsed/schema-formio 6.88.0 → 6.91.0

package/lib/index.js

@@ -1,1070 +0,0 @@
-var core = require('@tsed/core');
-var changeCase = require('change-case');
-var schema = require('@tsed/schema');
-
-const FormioMappersContainer = new Map();
-function registerFormioMapper(type, mapper) {
-  return FormioMappersContainer.set(type, mapper);
-}
-function getFormioMapper(type) {
-  // istanbul ignore next
-  if (!FormioMappersContainer.has(type)) {
-    throw new Error(`Formio ${type} mapper doesn't exists`);
-  }
-
-  return FormioMappersContainer.get(type);
-}
-function execMapper(type, schema, options) {
-  return getFormioMapper(type)(schema, options);
-}
-
-function getRef(schema, options) {
-  if (schema.$ref) {
-    return core.getValue(options, schema.$ref.replace("#/", "").replace(/\//g, "."));
-  }
-
-  return schema;
-}
-
-function anyToComponent(schema, options) {
-  schema = getRef(schema, options);
-
-  switch (schema.type) {
-    case "object":
-      if (!schema.properties && !schema.$ref) {
-        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);
-
-function _extends() {
-  _extends = Object.assign || function (target) {
-    for (var i = 1; i < arguments.length; i++) {
-      var source = arguments[i];
-
-      for (var key in source) {
-        if (Object.prototype.hasOwnProperty.call(source, key)) {
-          target[key] = source[key];
-        }
-      }
-    }
-
-    return target;
-  };
-
-  return _extends.apply(this, arguments);
-}
-
-function arrayToComponent(schema, options) {
-  const itemSchema = schema.items.$ref ? getRef(schema.items, options) : schema.items;
-  const {
-    type
-  } = itemSchema;
-
-  switch (type) {
-    case "object":
-      // editgrid
-      return _extends({}, execMapper("default", schema, options), execMapper("editgrid", itemSchema, options));
-
-    case "string":
-      // tag or enum?
-      if (itemSchema.enum) {
-        const component = execMapper("enum", itemSchema, options);
-        return _extends({}, component, {
-          inline: false,
-          type: "selectboxes"
-        });
-      }
-
-      const component = execMapper(type, itemSchema, options);
-      return core.cleanObject(_extends({}, component, {
-        multiple: component.type === "tags" ? undefined : true
-      }));
-
-    default:
-    case "number":
-      return _extends({}, execMapper(type, itemSchema, options), {
-        multiple: true
-      });
-  }
-}
-registerFormioMapper("array", arrayToComponent);
-
-function booleanToComponent(schema, options) {
-  const component = execMapper("default", schema, options);
-  return core.cleanObject(_extends({}, component, {
-    input: true,
-    type: component.type || "checkbox"
-  }));
-}
-
-registerFormioMapper("boolean", booleanToComponent);
-
-function dateToComponent(schema, options) {
-  const component = execMapper("default", schema, options);
-
-  const base = _extends({}, 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 _extends({}, base, {
-      format: "yyyy-MM-dd",
-      enableTime: false,
-      widget: _extends({}, base.widget, {
-        enableTime: false,
-        format: "yyyy-MM-dd"
-      })
-    });
-  }
-
-  return _extends({}, base, {
-    timePicker: {
-      showMeridian: false
-    },
-    widget: {
-      enableTime: true,
-      time_24hr: true
-    }
-  });
-}
-
-registerFormioMapper("date", dateToComponent);
-
-function getFormioProps(schema) {
-  const formioProps = Object.entries(schema).reduce((props, [key, value]) => {
-    if (key.startsWith("x-formio-")) {
-      return _extends({}, props, {
-        [key.replace("x-formio-", "")]: value
-      });
-    }
-
-    return props;
-  }, {});
-  return formioProps;
-}
-
-function defaultToComponent(schema, options) {
-  const formioProps = getFormioProps(schema);
-  return core.cleanObject(_extends({}, formioProps, {
-    disabled: !!schema.readOnly,
-    description: schema.description,
-    defaultValue: schema.default
-  }));
-}
-registerFormioMapper("default", defaultToComponent);
-
-function enumToComponent(schema, options) {
-  const component = execMapper("default", schema, options);
-  const values = schema.enum.map(value => {
-    return {
-      label: changeCase.sentenceCase(value),
-      value
-    };
-  });
-
-  if (component.type === "select") {
-    return core.cleanObject(_extends({}, component, {
-      data: {
-        json: JSON.stringify(values)
-      },
-      dataSrc: "json",
-      idPath: "value",
-      valueProperty: "value",
-      template: "<span>{{ item.label }}</span>"
-    }));
-  }
-
-  return core.cleanObject(_extends({}, component, {
-    values: schema["x-values"] || values.map(value => _extends({}, value, {
-      shortcut: ""
-    }))
-  }));
-}
-registerFormioMapper("enum", enumToComponent);
-
-function mapToComponent(schema, options) {
-  return _extends({}, execMapper("default", schema, options), {
-    type: "datamap",
-    tableView: false,
-    input: true,
-    valueComponent: _extends({}, schema.additionalProperties ? execMapper("any", schema.additionalProperties, options) : {}, {
-      hideLabel: true,
-      tableView: true
-    })
-  });
-}
-registerFormioMapper("map", mapToComponent);
-
-function nestedToComponent(schema, options) {
-  return _extends({}, execMapper("default", schema, options), {
-    label: false,
-    tableView: false,
-    type: "form",
-    display: "form",
-    input: true,
-    components: [_extends({
-      key: "panel",
-      label: options.parentKey && changeCase.sentenceCase(options.parentKey)
-    }, execMapper("panel", schema, options))]
-  });
-}
-registerFormioMapper("nested", nestedToComponent);
-
-function numberToComponent(schema, options) {
-  const component = execMapper("default", schema, options);
-  return core.cleanObject(_extends({}, component, {
-    input: true,
-    delimiter: core.getValue(component, "delimiter", false),
-    inputFormat: core.getValue(component, "inputFormat", "plain"),
-    mask: core.getValue(component, "mask", false),
-    requireDecimal: false,
-    type: "number"
-  }));
-}
-registerFormioMapper("number", numberToComponent);
-registerFormioMapper("integer", numberToComponent);
-
-function objectToEditGrid(schema, options) {
-  return _extends({}, execMapper("default", schema, options), {
-    rowDrafts: false,
-    type: "editgrid",
-    input: true,
-    components: execMapper("properties", schema, options)
-  });
-}
-registerFormioMapper("editgrid", objectToEditGrid);
-
-function panelToComponent(schema, options) {
-  return _extends({}, execMapper("default", schema, options), {
-    collapsible: false,
-    input: false,
-    tableView: false,
-    components: execMapper("properties", schema, options)
-  });
-}
-registerFormioMapper("panel", panelToComponent);
-
-function bindResolvers(component, options) {
-  if (component.data) {
-    const data = component.data;
-    Object.entries(data).forEach(([key, resolver]) => {
-      if (core.isFunction(resolver)) {
-        options.resolvers.push(async form => {
-          data[key] = await resolver(_extends({}, options, {
-            component,
-            form
-          }));
-        });
-      }
-    });
-  }
-}
-
-function mapValidation(key, base, schema, propSchema) {
-  const required = (schema.required || []).includes(key);
-
-  const validate = _extends({}, base.validate || {}, {
-    required,
-    pattern: propSchema.pattern,
-    minLength: !required || required && propSchema.minLength > 1 ? propSchema.minLength : undefined,
-    maxLength: propSchema.maxLength,
-    min: propSchema.minimum,
-    max: propSchema.maximum
-  });
-
-  switch (propSchema.type) {
-    case "string":
-      if (propSchema.minLength === 0 && validate.required) {
-        validate.minLength = undefined;
-        validate.required = false;
-      }
-
-      break;
-
-    case "boolean":
-      validate.required = false;
-      break;
-  }
-
-  return core.cleanObject(validate);
-}
-
-function propertiesToComponents(schema, options) {
-  const tabs = {
-    label: "Tabs",
-    key: "tabs",
-    type: "tabs",
-    input: false,
-    tableView: false,
-    components: new Map(),
-    pushed: false
-  };
-  const components = [];
-  Object.entries(schema.properties).forEach(([key, propSchema]) => {
-    const tabsOptions = propSchema["x-formiotabs"];
-    const base = execMapper("any", propSchema, _extends({
-      parentKey: key
-    }, options));
-    const component = core.cleanObject(_extends({
-      key
-    }, base, {
-      label: base.label == false ? undefined : base.label || propSchema.title || changeCase.sentenceCase(key),
-      validate: mapValidation(key, base, schema, propSchema)
-    }));
-    bindResolvers(component, options);
-
-    if (tabsOptions) {
-      if (!tabs.pushed) {
-        components.push(tabs);
-        tabs.pushed = true;
-      }
-
-      if (!tabs.components.has(tabsOptions.key)) {
-        tabs.components.set(tabsOptions.key, _extends({}, tabsOptions, {
-          components: []
-        }));
-      }
-
-      tabs.components.get(tabsOptions.key).components.push(component);
-    } else {
-      components.push(component);
-    }
-  });
-
-  if (tabs.components.size) {
-    tabs.components = [...tabs.components.values()];
-  }
-
-  return components;
-}
-registerFormioMapper("properties", propertiesToComponents);
-
-function stringToComponent(schema, options) {
-  if (schema.format) {
-    const component = execMapper("default", schema, options);
-
-    switch (schema.format) {
-      case "date":
-      case "date-time":
-        return execMapper("date", schema, options);
-
-      case "uri":
-        return core.cleanObject(_extends({
-          input: true
-        }, component, {
-          type: component.type || "url"
-        }));
-
-      default:
-        return core.cleanObject(_extends({
-          input: true
-        }, component, {
-          type: component.type || schema.format
-        }));
-    }
-  }
-
-  if (schema.enum) {
-    const component = execMapper("enum", schema, options);
-    return _extends({}, component, {
-      type: component.type || "radio"
-    });
-  }
-
-  const component = execMapper("default", schema, options);
-  return core.cleanObject(_extends({
-    input: true,
-    type: component.type || "textfield"
-  }, component));
-}
-registerFormioMapper("string", stringToComponent);
-
-/**
- * Declare a formio Component schema on the decorated propertyKey.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function Component(component) {
-  component = Object.entries(component).reduce((component, [key, value]) => {
-    if (key === "validate") {
-      component["x-formio-validate"] = _extends({}, component["x-formio-validate"] || {}, value);
-    }
-
-    return _extends({}, component, {
-      [`x-formio-${key}`]: value
-    });
-  }, {});
-  return schema.JsonEntityFn(store => {
-    Object.entries(component).forEach(([key, value]) => {
-      store.itemSchema.customKey(key, value);
-
-      if (store.isCollection) {
-        store.schema.customKey(key, value);
-      }
-    });
-  });
-}
-
-/**
- * Configure the property as Currency component.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function Currency(props = {}) {
-  return Component(_extends({
-    currency: "USD",
-    inputFormat: "plain",
-    mask: false,
-    spellcheck: true,
-    delimiter: true
-  }, props, {
-    type: "currency"
-  }));
-}
-
-const wrap = resolver => async opts => {
-  const result = await resolver(opts);
-  return JSON.stringify(result);
-};
-/**
- * Set custom json data source
- * @param data
- * @param props
- * @constructor
- */
-
-
-function DataSourceJson(data, props = {}) {
-  return Component(_extends({}, props, {
-    dataSrc: "json",
-    data: _extends({}, props.data, {
-      json: core.isFunction(data) ? wrap(data) : JSON.stringify(data)
-    })
-  }));
-}
-
-/**
- * Set URL data on the current component.
- * @param url
- * @param props
- * @constructor
- */
-
-function DataSourceUrl(url, props = {}) {
-  return Component(_extends({}, props, {
-    dataSrc: "url",
-    data: _extends({}, props.data, {
-      url
-    })
-  }));
-}
-
-/**
- * Set hidden field.
- *
- * A hidden field is still a part of the form, but is hidden from view.
- *
- * @param bool
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function Hidden(bool = true) {
-  return Component({
-    hidden: bool
-  });
-}
-
-/**
- * Configure the property as Tags component.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function InputTags(props = {}) {
-  return core.useDecorators(schema.CollectionOf(String), Component(_extends({}, props, {
-    tableView: false,
-    storeas: "array",
-    type: "tags"
-  })));
-}
-
-/**
- * Change the multiple value on the decorated property.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function Multiple(multiple = false) {
-  return Component({
-    multiple
-  });
-}
-
-/**
- * Configure the property as Password component.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function Password(props = {}) {
-  return Component(_extends({}, props, {
-    type: "password",
-    protected: true
-  }));
-}
-
-/**
- * Configure the property as Select component.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function Select(props = {}) {
-  return Component(_extends({
-    selectThreshold: 0.3,
-    input: true,
-    widget: "choicesjs"
-  }, props, {
-    type: "select"
-  }));
-}
-
-/**
- * Change the visibility of the current property on a table.
- * @param bool
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function TableView(bool) {
-  return Component({
-    tableView: bool
-  });
-}
-
-/**
- * Configure the property as Textarea component.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function Textarea(props = {}) {
-  return Component(_extends({
-    autoExpand: false
-  }, props, {
-    type: "textarea"
-  }));
-}
-
-/**
- * Add validation rules.
- * @decorator
- * @formio
- * @property
- * @schema
- * @param key
- * @param value
- */
-
-function Validate(key, value) {
-  return Component({
-    validate: {
-      [key]: value
-    }
-  });
-}
-
-/**
- * Add error message when an error occur.
- * @decorator
- * @formio
- * @property
- * @schema
- * @param message
- */
-
-function ErrorMessage(message) {
-  return Validate("customMessage", message);
-}
-
-/**
- * Set the error label when an error occur.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function ErrorLabel(message) {
-  return Component({
-    errorLabel: message
-  });
-}
-
-/**
- * Add the maximum amount of words that can be added to this field.
- * @decorator
- * @formio
- * @property
- * @schema
- * @param value
- */
-
-function MinWords(value) {
-  return Validate("minWords", value);
-}
-
-/**
- * Add the minimum amount of words that can be added to this field.
- * @decorator
- * @formio
- * @property
- * @schema
- * @param value
- */
-
-function MaxWords(value) {
-  return Validate("maxWords", value);
-}
-
-// tslint:disable-next-line:variable-name
-const FormsContainer = new Map();
-
-/**
- * Expose the model as Formio Form.
- * @param form
- */
-
-function Form(form = {}) {
-  return core.useDecorators(target => {
-    const name = form.name || core.nameOf(target);
-    const machineName = changeCase.paramCase(name);
-    FormsContainer.set(name, target);
-    FormsContainer.set(machineName, target);
-  }, form.name && schema.Name(form.name), form && core.StoreSet("formio:form", form));
-}
-
-/**
- * Group the current property in tabs components.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function Tabs(label) {
-  return schema.JsonEntityFn(store => {
-    store.schema.customKey("x-formiotabs", {
-      key: changeCase.camelCase(label),
-      label
-    });
-  });
-}
-
-/**
- * The placeholder text that will appear when this field is empty.
- * @decorator
- * @formio
- * @property
- * @schema
- * @param placeholder
- */
-
-function Placeholder(placeholder) {
-  return Component({
-    placeholder
-  });
-}
-
-/**
- * Adds a tooltip to the side of this field.
- * @decorator
- * @formio
- * @property
- * @schema
- * @param tooltip
- */
-
-function Tooltip(tooltip) {
-  return Component({
-    tooltip
-  });
-}
-
-/**
- * Change the label field
- * @decorator
- * @formio
- * @property
- * @schema
- * @param label
- */
-
-function Label(label) {
-  return Component({
-    label
-  });
-}
-
-/**
- * Add a custom css class.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function CustomClass(customClass) {
-  return Component({
-    customClass
-  });
-}
-
-/**
- * Opens up a modal to edit the value of this component.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function ModalEdit(modalEdit = true) {
-  return Component({
-    modalEdit
-  });
-}
-
-/**
- * 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
- */
-
-function Mask(inputMask, inputMaskPlaceholderChar = "") {
-  return Component({
-    inputMask,
-    inputMaskPlaceholderChar
-  });
-}
-/**
- * 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
- */
-
-function Masks(...inputMasks) {
-  return Component({
-    inputMasks
-  });
-}
-
-/**
- * Add prefix word on the decorated field.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function Prefix(prefix) {
-  return Component({
-    prefix
-  });
-}
-
-/**
- * Add suffix word on the decorated field.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function Suffix(suffix) {
-  return Component({
-    suffix
-  });
-}
-
-/**
- * Force the output of this field to be sanitized in a specific format.
- * @decorator
- * @formio
- * @property
- * @schema
- * @param textCase
- */
-
-function TextCase(textCase) {
-  return Component({
-    case: textCase
-  });
-}
-
-/**
- * Adds a conditional display rule on the input form.
- * @decorator
- * @formio
- * @property
- * @schema
- * @param conditional
- */
-
-function Conditional(conditional) {
-  return Component({
-    conditional
-  });
-}
-/**
- * Adds a conditional display rule on the input form.
- * @decorator
- * @formio
- * @property
- * @schema
- * @param property
- * @param eq
- */
-
-function ShowWhen(property, eq) {
-  return Conditional({
-    show: true,
-    when: property,
-    eq
-  });
-}
-/**
- * Adds a conditional display rule on the input form.
- * @decorator
- * @formio
- * @property
- * @schema
- * @param property
- * @param eq
- */
-
-function HideWhen(property, eq) {
-  return Conditional({
-    show: false,
-    when: property,
-    eq
-  });
-}
-
-function sanitize(customConditional) {
-  const str = customConditional.toString();
-  const [signature, ...fn] = str.split("=>");
-  let content = fn.join("=>");
-
-  if (!signature.includes("{")) {
-    const reg = `${signature.trim()}\.`;
-    content = content.replace(new RegExp(reg, "gi"), "");
-  }
-
-  return `show = ${content.trim()}`;
-}
-/**
- * Adds custom conditional rule to display or not the input form.
- * @decorator
- * @formio
- * @property
- * @schema
- * @param customConditional
- */
-
-
-function CustomConditional(customConditional) {
-  if (core.isArrowFn(customConditional)) {
-    customConditional = sanitize(customConditional);
-  }
-
-  return Component({
-    customConditional
-  });
-}
-
-/**
- * Open automatically the editgrid when the list is empty.
- * @decorator
- * @formio
- * @property
- * @schema
- */
-
-function OpenWhenEmpty(openWhenEmpty = true) {
-  return Component({
-    openWhenEmpty
-  });
-}
-
-async function getFormioSchema(model, options = {}) {
-  if (!model) {
-    return undefined;
-  }
-
-  if (core.isString(model)) {
-    return getFormioSchema(FormsContainer.get(model), options);
-  }
-
-  const entity = schema.JsonEntityStore.from(model);
-  const schema$1 = schema.getJsonSchema(entity, _extends({}, options, {
-    customKeys: true
-  }));
-  const name = entity.schema.getName();
-  const machineName = changeCase.paramCase(name);
-  const resolvers = [];
-  const components = execMapper("properties", schema$1, _extends({}, options, {
-    definitions: schema$1.definitions,
-    resolvers
-  }));
-
-  const form = _extends({
-    title: name,
-    type: "form",
-    display: "form",
-    tags: [],
-    access: [],
-    submissionAccess: []
-  }, entity.store.get("formio:form", {}), {
-    name: machineName,
-    machineName,
-    components
-  });
-
-  await Promise.all(resolvers.map(resolver => resolver(form, options)));
-  return form;
-}
-
-exports.Component = Component;
-exports.Conditional = Conditional;
-exports.Currency = Currency;
-exports.CustomClass = CustomClass;
-exports.CustomConditional = CustomConditional;
-exports.DataSourceJson = DataSourceJson;
-exports.DataSourceUrl = DataSourceUrl;
-exports.ErrorLabel = ErrorLabel;
-exports.ErrorMessage = ErrorMessage;
-exports.Form = Form;
-exports.Hidden = Hidden;
-exports.HideWhen = HideWhen;
-exports.InputTags = InputTags;
-exports.Label = Label;
-exports.Mask = Mask;
-exports.Masks = Masks;
-exports.MaxWords = MaxWords;
-exports.MinWords = MinWords;
-exports.ModalEdit = ModalEdit;
-exports.Multiple = Multiple;
-exports.OpenWhenEmpty = OpenWhenEmpty;
-exports.Password = Password;
-exports.Placeholder = Placeholder;
-exports.Prefix = Prefix;
-exports.Select = Select;
-exports.ShowWhen = ShowWhen;
-exports.Suffix = Suffix;
-exports.TableView = TableView;
-exports.Tabs = Tabs;
-exports.TextCase = TextCase;
-exports.Textarea = Textarea;
-exports.Tooltip = Tooltip;
-exports.Validate = Validate;
-exports.anyToComponent = anyToComponent;
-exports.arrayToComponent = arrayToComponent;
-exports.defaultToComponent = defaultToComponent;
-exports.enumToComponent = enumToComponent;
-exports.execMapper = execMapper;
-exports.getFormioMapper = getFormioMapper;
-exports.getFormioSchema = getFormioSchema;
-exports.mapToComponent = mapToComponent;
-exports.nestedToComponent = nestedToComponent;
-exports.numberToComponent = numberToComponent;
-exports.objectToEditGrid = objectToEditGrid;
-exports.panelToComponent = panelToComponent;
-exports.propertiesToComponents = propertiesToComponents;
-exports.registerFormioMapper = registerFormioMapper;
-exports.stringToComponent = stringToComponent;
-//# sourceMappingURL=index.js.map