@jsonforms/core 2.5.2 → 3.0.0-alpha.3

package/src/util/runtime.ts

@@ -22,6 +22,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import has from 'lodash/has';
 import {
   AndCondition,
@@ -32,10 +33,13 @@ import {
   SchemaBasedCondition,
   Scopable,
   UISchemaElement
-} from '../models/uischema';
+} from '../models';
 import { resolveData } from './resolvers';
 import { composeWithUi } from './path';
-import { Ajv } from 'ajv';
+import Ajv from 'ajv';
+import { getAjv } from '../reducers';
+import { JsonFormsState } from '../store';
+import { JsonSchema } from '../models/jsonSchema';
 
 const isOrCondition = (condition: Condition): condition is OrCondition =>
   condition.type === 'OR';
@@ -177,3 +181,43 @@ export const isEnabled = (
 
   return true;
 };
+
+/**
+ * Indicates whether the given `uischema` element shall be enabled or disabled.
+ * Checks the global readonly flag, uischema rule, uischema options (including the config),
+ * the schema and the enablement indicator of the parent.
+ */
+export const isInherentlyEnabled = (
+  state: JsonFormsState,
+  ownProps: any,
+  uischema: UISchemaElement,
+  schema: JsonSchema & { readOnly?: boolean } | undefined,
+  rootData: any,
+  config: any
+) => {
+  if (state?.jsonforms?.readonly) {
+    return false;
+  }
+  if (uischema && hasEnableRule(uischema)) {
+    return isEnabled(uischema, rootData, ownProps?.path, getAjv(state));
+  }
+  if (typeof uischema?.options?.readonly === 'boolean') {
+    return !uischema.options.readonly;
+  }
+  if (typeof uischema?.options?.readOnly === 'boolean') {
+    return !uischema.options.readOnly;
+  }
+  if (typeof config?.readonly === 'boolean') {
+    return !config.readonly;
+  }
+  if (typeof config?.readOnly === 'boolean') {
+    return !config.readOnly;
+  }
+  if (schema?.readOnly === true) {
+    return false;
+  }
+  if (typeof ownProps?.enabled === 'boolean') {
+    return ownProps.enabled;
+  }
+  return true;
+};

package/src/util/schema.ts

@@ -1,4 +1,29 @@
-import find from "lodash/find";
+/*
+  The MIT License
+
+  Copyright (c) 2017-2019 EclipseSource Munich
+  https://github.com/eclipsesource/jsonforms
+
+  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.
+*/
+
+import find from 'lodash/find';
 
 export const getFirstPrimitiveProp = (schema: any) => {
   if (schema.properties) {

package/src/util/uischema.ts

@@ -22,8 +22,9 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import isEmpty from 'lodash/isEmpty';
-import { isLayout, UISchemaElement } from '../models/uischema';
+import { isLayout, UISchemaElement } from '../models';
 
 export type IterateCallback = (uischema: UISchemaElement) => void;
 

package/src/util/util.ts

@@ -0,0 +1,127 @@
+/*
+  The MIT License
+  
+  Copyright (c) 2017-2019 EclipseSource Munich
+  https://github.com/eclipsesource/jsonforms
+  
+  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.
+*/
+
+import isEmpty from 'lodash/isEmpty';
+import isArray from 'lodash/isArray';
+import includes from 'lodash/includes';
+import find from 'lodash/find';
+import { JsonSchema, Scopable, UISchemaElement } from '..';
+import { resolveData, resolveSchema } from './resolvers';
+import { composePaths, toDataPathSegments } from './path';
+import { isEnabled, isVisible } from './runtime';
+import Ajv from 'ajv';
+
+/**
+ * Escape the given string such that it can be used as a class name,
+ * i.e. hashes and slashes will be replaced.
+ *
+ * @param {string} s the string that should be converted to a valid class name
+ * @returns {string} the escaped string
+ */
+export const convertToValidClassName = (s: string): string =>
+s.replace('#', 'root').replace(new RegExp('/', 'g'), '_');
+
+export const formatErrorMessage = (errors: string[]) => {
+ if (errors === undefined || errors === null) {
+   return '';
+ }
+
+ return errors.join('\n');
+};
+
+export const hasType = (jsonSchema: JsonSchema, expected: string): boolean => {
+ return includes(deriveTypes(jsonSchema), expected);
+};
+
+/**
+* Derives the type of the jsonSchema element
+*/
+export const deriveTypes = (jsonSchema: JsonSchema): string[] => {
+ if (isEmpty(jsonSchema)) {
+   return [];
+ }
+ if (!isEmpty(jsonSchema.type) && typeof jsonSchema.type === 'string') {
+   return [jsonSchema.type];
+ }
+ if (isArray(jsonSchema.type)) {
+   return jsonSchema.type;
+ }
+ if (
+   !isEmpty(jsonSchema.properties) ||
+   !isEmpty(jsonSchema.additionalProperties)
+ ) {
+   return ['object'];
+ }
+ if (!isEmpty(jsonSchema.items)) {
+   return ['array'];
+ }
+
+ if (!isEmpty(jsonSchema.allOf)) {
+   const allOfType = find(
+     jsonSchema.allOf,
+     (schema: JsonSchema) => deriveTypes(schema).length !== 0
+   );
+
+   if (allOfType) {
+     return deriveTypes(allOfType);
+   }
+ }
+ // ignore all remaining cases
+ return [];
+};
+
+/**
+* Convenience wrapper around resolveData and resolveSchema.
+*/
+export const Resolve: {
+ schema(
+   schema: JsonSchema,
+   schemaPath: string,
+   rootSchema?: JsonSchema
+ ): JsonSchema;
+ data(data: any, path: string): any;
+} = {
+ schema: resolveSchema,
+ data: resolveData
+};
+
+// Paths --
+const fromScopable = (scopable: Scopable) =>
+ toDataPathSegments(scopable.scope).join('.');
+
+export const Paths = {
+ compose: composePaths,
+ fromScopable
+};
+
+// Runtime --
+export const Runtime = {
+ isEnabled(uischema: UISchemaElement, data: any, ajv: Ajv): boolean {
+   return isEnabled(uischema, data,undefined, ajv);
+ },
+ isVisible(uischema: UISchemaElement, data: any, ajv: Ajv): boolean {
+   return isVisible(uischema, data, undefined, ajv);
+ }
+};

package/src/util/validator.ts

@@ -22,20 +22,17 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
-import AJV from 'ajv';
+import Ajv from 'ajv';
+import addFormats from 'ajv-formats';
 import { Options } from 'ajv';
-import { Draft4 } from '../models/draft4';
 
 export const createAjv = (options?: Options) => {
-  const ajv = new AJV({
-    schemaId: 'auto',
+  const ajv = new Ajv({
     allErrors: true,
-    jsonPointers: true,
-    errorDataPath: 'property',
     verbose: true,
+    strict: false,
     ...options
   });
-  ajv.addFormat('time', '^([0-1][0-9]|2[0-3]):[0-5][0-9]$');
-  ajv.addMetaSchema(Draft4);
+  addFormats(ajv);
   return ajv;
 };

package/test/i18n/i18nUtil.test.ts

@@ -0,0 +1,48 @@
+/*
+  The MIT License
+  
+  Copyright (c) 2017-2021 EclipseSource Munich
+  https://github.com/eclipsesource/jsonforms
+  
+  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.
+*/
+import test from 'ava';
+
+import { transformPathToI18nPrefix } from '../../src';
+
+test('transformPathToI18nPrefix returns root when empty', t => {
+  t.is(transformPathToI18nPrefix(''), 'root');
+});
+
+test('transformPathToI18nPrefix does not modify non-array paths', t => {
+  t.is(transformPathToI18nPrefix('foo'), 'foo');
+  t.is(transformPathToI18nPrefix('foo.bar'), 'foo.bar');
+  t.is(transformPathToI18nPrefix('bar3.foo2'), 'bar3.foo2');
+});
+
+test('transformPathToI18nPrefix removes array indices', t => {
+  t.is(transformPathToI18nPrefix('foo.2.bar'), 'foo.bar');
+  t.is(transformPathToI18nPrefix('foo.234324234.bar'), 'foo.bar');
+  t.is(transformPathToI18nPrefix('foo.0.bar'), 'foo.bar');
+  t.is(transformPathToI18nPrefix('foo.0.bar.1.foobar'), 'foo.bar.foobar');
+  t.is(transformPathToI18nPrefix('3.foobar'), 'foobar');
+  t.is(transformPathToI18nPrefix('foobar.3'), 'foobar');
+  t.is(transformPathToI18nPrefix('foo1.23.b2ar3.1.5.foo'), 'foo1.b2ar3.foo');
+  t.is(transformPathToI18nPrefix('3'), 'root');
+});